UTGame.GFxUDKFrontEnd

Extends

GFxMoviePlayer

Modifiers

config ( UI )

Filename : GFxUDKFrontEnd.uc Content : GFx-UDK Front End Implementaiton Copyright : (c) 2010 Scaleform Corp. All Rights Reserved. Notes : A manager for the UDK's front end menu. This class loads all of the menu views as MovieClips into itself using attachMovie() and loadMovie(). The data for the views defined in DefaultUI.ini. All loaded views contain a reference to this class for general menu functionality including pushing/popping views, spawning dialogs, setting focus, and setting Escape/Back key press events. There is an ActionScript class associated with this manager: MenuManager.as. That class contains logic for animating views and utilizing necessary GFx AS extensions (eg. Selection["modalClip"]). Associated Flash content: udk_manager.fla Licensees may use this file in accordance with the valid Scaleform Commercial License Agreement provided with the software. This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR ANY PURPOSE.

Core.Object
|   
+-- GFxUI.GFxMoviePlayer
   |   
   +-- UTGame.GFxUDKFrontEnd

Delegates Summary
		EscapeDelegate ()

Functions Summary
		ASSetSelectionFocus (GFxObject MovieClip))
		ASShowCursor (bool bShowCursor))
	bool	CheckLinkConnectionAndError (optional string AlternateTitle, optional string AlternateMessage ))
		ConfigFrontEnd ()))
		ConfigureTargetDialog (coerce GFxUDKFrontEnd_View TargetDialog))
		ConfigureTargetView (GFxUDKFrontEnd_View TargetView))
		ConfigureView (GFxUDKFrontEnd_View InView, name WidgetName, name WidgetPath))
		DestroyDependantViews (name InViewName ))
	bool	IsViewAllowed (GFxUDKFrontEnd_View TargetView))
	bool	IsViewLoaded (name InViewName ))
		LoadDependantViews (name InViewName ))
		LoadView (ViewInfo InViewInfo))
		LoadViewByName (name InViewName ))
		LoadViews ()))
	GFxObject	PopView ()))
	GFxObject	PopViewStub ()))
		PostWidgetInit ()))
		PushDialogView (coerce GFxUDKFrontEnd_View dialogView))
		PushView (coerce GFxUDKFrontEnd_View targetView))
		PushViewByName (name TargetViewName, optional GFxUDKFrontEnd_Screen ParentView))
		SetEscapeDelegate (delegate InDelegate ))
		SetSelectionFocus (coerce GFxObject MovieClip))
	GFxUDKFrontEnd_Dialog	SpawnDialog (name TargetDialogName, optional GFxUDKFrontEnd_Screen ParentView))
	bool	Start (optional bool StartPaused = false))
		UpdateViewLayout ()))
	bool	WidgetInitialized (name WidgetName, name WidgetPath, GFxObject Widget))

bInitialized Source code

ErrorDialog Source code

FilterDialog Source code

GameModeView Source code

HostGameView Source code

InfoDialog Source code

InstantActionView Source code

JoinDialog Source code

JoinGameView Source code

LoadedViews Source code

An array of names of views which have been attachMovie()'d and loadMovie()'d. Views are loaded based on their DependantViews array, defined in Default.ini.

MainMenuView Source code

View declarations.

ManagerMC Source code

Reference to the manager MovieClip (_root.manager) where views will be attached.

MapSelectView Source code

MultiplayerView Source code

MutatorsView Source code

PasswordDialog Source code

RootMC Source code

Reference to _root of the movie's (udk_manager.swf) stage.

ServerSettingsView Source code

SettingsView Source code

ViewData Source code

Array of all menu views to be loaded, defined in DefaultUI.ini.

ViewStack Source code

Shadow of the AS view stack. Necessary to update ( View.OnTopMostView(false) ) views that alreday exist on the stack.

ViewInfo Source code

Structure which defines a unique menu view to be loaded.
DependantViews:

Dependant views that should be loaded if this view is displayed.

SWFName:

SWF content to be loaded.

ViewName:

Unique string.

EscapeDelegate Source code

A delegate for Escape/Back key press which will generally move the user backward through the menu or select "Cancel".

ASSetSelectionFocus Source code

AS stub for access to Selection.setFocus() via SetSelectionFocus().

ASShowCursor Source code

CheckLinkConnectionAndError Source code

@return Checks to see if the platform is currently connected to a network.

ConfigFrontEnd Source code

Configuration method which stores references to _root and _root.manager for use in attaching views.

ConfigureTargetDialog Source code

Activates, updates, and pushes a dialog on the stack. This method is called when a dialog is created by name using SpawnDialog().

ConfigureTargetView Source code

Activates, updates, and pushes a view on the stack if it is allowed. This method is called when a view is created by name using PushViewByName().

ConfigureView Source code

DestroyDependantViews Source code

A highly unstable method which unloads dependant views based on the name of the view that is being unloaded.

IsViewAllowed Source code

Check whether target view is appropriate to add to the view stack.

IsViewLoaded Source code

Checks whether a view has already been loaded using the view name.
@param InViewName The name of the view to check.

LoadDependantViews Source code

Loads all dependant views for a view using the view's name. Dependant views are defined in the INI file and stored in the ViewData array.

LoadView Source code

Create a view using existing ViewInfo.
@param InViewInfo, the data for the view which includes the SWFName and the name for the view.

LoadViewByName Source code

Loads a view using the view name. Used for loading views based on the current screen. Views that should be loaded for each screen are defined in DefaultUI.ini.
@param InViewName The name of the view to be loaded.

LoadViews Source code

Creates MovieClips in ManagerMC into which the views are loaded. These MovieClips are then stored in MenuViews for later manipulation.

PopView Source code

Pops a view from the view stack and handles update/close of existing views.

PopViewStub Source code

Pops a view from the MenuManager.as view stack.

PostWidgetInit Source code

Callback when at least one CLIK widget with enableInitCallback set to TRUE has been initialized in a frame

PushDialogView Source code

AS stub for pushing a view onto the stack.

PushView Source code

Pushes a view onto MenuManager.as view stack.

PushViewByName Source code

Pushes a view onto MenuManager.as's view stack by name. This is the primarily method by which views on the stack notify the GFxUDKFrontEnd that the state of the stack needs to be updated.

SetEscapeDelegate Source code

Used by views to set the function triggered by "escape" input.
@param InDelegate The EscapeDelegate that should be called on Escape/Cancel key press.

SetSelectionFocus Source code

Gives focus to a particular GFxObject.

SpawnDialog Source code

Configures a dialog and pushes it on to the view stack. Returns a reference to the dialog which can be manipulated to the view which spawned it.

Start Source code

UpdateViewLayout Source code

Updates the layout of all views in MenuManager.as view stack.

WidgetInitialized Source code

Callback when a CLIK widget with enableInitCallback set to TRUE is initialized. Returns TRUE if the widget was handled, FALSE if not.

defaultproperties
{    
    
    WidgetBindings.Add((WidgetName="MainMenu",WidgetClass=class'GFxUDKFrontEnd_MainMenu'))
    WidgetBindings.Add((WidgetName="InstantAction",WidgetClass=class'GFxUDKFrontEnd_InstantAction'))       
    WidgetBindings.Add((WidgetName="MapSelect",WidgetClass=class'GFxUDKFrontEnd_MapSelect'))
    WidgetBindings.Add((WidgetName="GameMode",WidgetClass=class'GFxUDKFrontEnd_GameMode'))
    WidgetBindings.Add((WidgetName="Settings",WidgetClass=class'GFxUDKFrontEnd_Settings'))
    WidgetBindings.Add((WidgetName="Mutators",WidgetClass=class'GFxUDKFrontEnd_Mutators'))
        
    WidgetBindings.Add((WidgetName="Multiplayer",WidgetClass=class'GFxUDKFrontEnd_Multiplayer'))
    WidgetBindings.Add((WidgetName="HostGame",WidgetClass=class'GFxUDKFrontEnd_HostGame'))
    WidgetBindings.Add((WidgetName="JoinGame",WidgetClass=class'GFxUDKFrontEnd_JoinGame'))
    WidgetBindings.Add((WidgetName="ServerSettings",WidgetClass=class'GFxUDKFrontEnd_ServerSettings'))
    
    WidgetBindings.Add((WidgetName="InfoDialog",WidgetClass=class'GFxUDKFrontEnd_InfoDialog'))
    WidgetBindings.Add((WidgetName="ErrorDialog",WidgetClass=class'GFxUDKFrontEnd_ErrorDialog'))
    WidgetBindings.Add((WidgetName="JoinDialog",WidgetClass=class'GFxUDKFrontEnd_JoinDialog'))
    WidgetBindings.Add((WidgetName="FilterDialog",WidgetClass=class'GFxUDKFrontEnd_FilterDialog'))
    WidgetBindings.Add((WidgetName="PasswordDialog",WidgetClass=class'GFxUDKFrontEnd_PasswordDialog'))

    
    SoundThemes(0)=(ThemeName=default,Theme=UISoundTheme'UDKFrontEnd.Sound.SoundTheme')

    bDisplayWithHudOff=TRUE    
    TimingMode=TM_Real
    bInitialized=FALSE
	MovieInfo=SwfMovie'UDKFrontEnd.udk_manager'
	bPauseGameWhileActive=TRUE
	bCaptureInput=true
}