UTGame.UTUIFrontEnd

Extends

UTUIScene

Modifiers

config ( Game ) native ( UIFrontEnd ) dependson ( UTUIScene_MessageBox )

Copyright 1998-2008 Epic Games, Inc. All Rights Reserved. Base class for frontend scenes, looks for buttonbar and tab control references.

Core.Object
|   
+-- Engine.UIRoot
   |   
   +-- Engine.UIScreenObject
      |   
      +-- Engine.UIScene
         |   
         +-- UTGame.UTUIScene
            |   
            +-- UTGame.UTUIFrontEnd

Direct Known Subclasses:

UTUIFrontEnd_Achievements, UTUIFrontEnd_ArenaConfigMenu, UTUIFrontEnd_BasicMenu, UTUIFrontEnd_BindKeys360, UTUIFrontEnd_BindKeysPC, UTUIFrontEnd_BindKeysPS3, UTUIFrontEnd_BotSelection, UTUIFrontEnd_BrowserMutatorFilters, UTUIFrontEnd_CharacterCustomization, UTUIFrontEnd_CharacterFaction, UTUIFrontEnd_CharacterSelection, UTUIFrontEnd_Credits, UTUIFrontEnd_CustomScreen, UTUIFrontEnd_DemoPlayback, UTUIFrontEnd_Friends, UTUIFrontEnd_JoinGame, UTUIFrontEnd_LaunchGame, UTUIFrontEnd_Leaderboards, UTUIFrontEnd_MapCycle, UTUIFrontEnd_ModSettings, UTUIFrontEnd_Mutators, UTUIFrontEnd_News, UTUIFrontEnd_PlayerStats, UTUIFrontEnd_QuickMatch, UTUIFrontEnd_SettingsPanels, UTUIFrontEnd_SettingsVideoAdvanced, UTUIFrontEnd_WeaponPreference, UTUIFrontEnd_WeaponReplacementMenu, UTUIScene_CNewOrContinue, UTUIScene_COptions

Functions Summary
	bool	BeginHideAnimation (bool bClosingScene=false))
		BeginImportMod ()
		BeginInstallPS3 ()
	bool	BeginShowAnimation (bool bInitialActivation=true, bool bBypassAnimation=false))
		CancelInstallPS3 ()
		CheckForFrontEndError ()))
		ChildSceneOpened (UIScene NewTopScene ))
	UILabel	GetTitleLabel ()))
	bool	HandleInputKey (const out InputEventParameters EventParms ))
		ImportMod ()))
		InstallPS3 ()))
		OnCancelInstallPS3 (UTUIScene_MessageBox MessageBox, int SelectedItem, int PlayerIndex))
		OnCancelMessageClosed ()))
		OnImportModFinished ()
		OnInstallMessageClosed ()))
		OnLoginError_Confirm (UTUIScene_MessageBox MessageBox, int SelectedItem, int PlayerIndex))
		OnMainRegion_Show_UIAnimEnd (UIObject AnimTarget, int AnimIndex, UIAnimationSeq AnimSeq))
		OnPageActivated (UITabControl Sender, UITabPage NewlyActivePage, int PlayerIndex ))
		OnRetryPasswordDialog_Closed (UTUIScene_MessageBox MessageBox, int SelectedOption, int PlayerIndex))
		OnTabPage_Hide_UIAnimEnd (UIObject AnimTarget, int AnimIndex, UIAnimationSeq AnimSeq))
		OnTabPage_Show_UIAnimEnd (UIObject AnimTarget, int AnimIndex, UIAnimationSeq AnimSeq))
		PostInitialize ()))
		PromptForPassword ()))
		SavePassword (string Password)
		SceneActivated (bool bInitialActivation))
		SetTitle ()))
		SetupButtonBar ()))
		UpdateModState (EModImport NewState))
		UpdatePS3InstallState (int CurrentFileNum, int TotalFileNum, bool bFinishedCancelling))

bCancellingInstallPS3 Source code

Whether or not we are currently cancelling the ps3 install on the PS3.

bInstallingPS3 Source code

Whether or not we are currently installing on the PS3.

ButtonBar Source code

Pointer to the button bar for this scene.

CurrentPageIndex Source code

ImportingMessageBoxReference Source code

ImportState Source code

LastURL Source code

PreviousPageIndex Source code

TabControl Source code

Pointer to the tab control for this scene.

VersionFont Source code

VersionPos Source code

VersionText Source code

UTUIFrontEnd

TitleMarkupString Source code

Markup for the title for this scene.

EModImport Source code

Current mod import state.

BeginHideAnimation Source code

Starts the exit animation for the scene.
@return TRUE if there's animation for this scene, FALSE otherwise.

BeginImportMod Source code

Starts the mod importing process.

BeginInstallPS3 Source code

Starts the PS3 install process.

BeginShowAnimation Source code

Starts the show animation for the scene.
@param bInitialActivation TRUE if the scene is being opened; FALSE if the another scene was closed causing this one to become the topmost scene.
@param bBypassAnimation TRUE to force all animations to their last frame, effectively bypassing animations. This can be necessary for e.g. scenes which start out off-screen or something.
@return TRUE if there's animation for this scene, FALSE otherwise.

CancelInstallPS3 Source code

Cancels the PS3 install.

CheckForFrontEndError Source code

Checks to see if a frontend error message was set by the game before returning to the main menu, if so, we skip to the main menu and display the message.

ChildSceneOpened Source code

Called when a new scene is opened over this one. Propagates the values for bRequiresNetwork and bRequiresOnlineService to the new page.

GetTitleLabel Source code

@return Returns the title label that is located on the background scene.

HandleInputKey Source code

Provides a hook for unrealscript to respond to input using actual input key names (i.e. Left, Tab, etc.) Called when an input key event is received which this widget responds to and is in the correct state to process. The keys and states widgets receive input for is managed through the UI editor's key binding dialog (F8). This delegate is called BEFORE kismet is given a chance to process the input.
@param EventParms information about the input event.
@return TRUE to indicate that this input key was processed; no further processing will occur on this input key event.

ImportMod Source code

Function to start importing a mod.

InstallPS3 Source code

Installs the game on PS3.

OnCancelInstallPS3 Source code

Confirmation for the cancel dialog.

OnCancelMessageClosed Source code

Callback for the install PS3 messagebox has closed.

OnImportModFinished Source code

Callback for when the import has finished for a mod.

OnInstallMessageClosed Source code

Callback for the install PS3 messagebox has closed.

OnLoginError_Confirm Source code

Callback for when the login required box has finished displaying.

OnMainRegion_Show_UIAnimEnd Source code

Called when a tab page has finished showing.

OnPageActivated Source code

Called when a new page is activated.
@param Sender the tab control that activated the page
@param NewlyActivePage the page that was just activated
@param PlayerIndex the index [into the Engine.GamePlayers array] for the player that generated this event.

OnRetryPasswordDialog_Closed Source code

OnTabPage_Hide_UIAnimEnd Source code

Called when a tab page has finished hiding.

OnTabPage_Show_UIAnimEnd Source code

Called when a tab page has finished showing.

PostInitialize Source code

Post initialize callback.

PromptForPassword Source code

SavePassword Source code

Encrypts the password and saves the data

SceneActivated Source code

Scene activated event, sets up the title for the scene.

SetTitle Source code

Sets the title for this scene.

SetupButtonBar Source code

Function that sets up a buttonbar for this scene, automatically routes the call to the currently selected tab of the scene as well.

UpdateModState Source code

Updates the current state of the mod import.
@param NewState New import state

UpdatePS3InstallState Source code

Updates the current install state for the PS3 Install.
@param CurrentFileNum Current file number installing.
@param TotalFileNum Total number of files to install.

defaultproperties
{
   VersionText="Version 2.1"
   VersionPos=(X=0.009000,Y=0.057000)
   bPauseGameWhileActive=False
   DefaultContextMenuClass=Class'Engine.UIContextMenu'
   SceneRenderMode=SPLITRENDER_Fullscreen
   __OnTopSceneChanged__Delegate=Default__UTUIFrontEnd.ChildSceneOpened
   Begin Object Class=UIComp_Event Name=SceneEventComponent ObjName=SceneEventComponent Archetype=UIComp_Event'UTGame.Default__UTUIScene:SceneEventComponent'
      ObjectArchetype=UIComp_Event'UTGame.Default__UTUIScene:SceneEventComponent'
   End Object
   EventProvider=SceneEventComponent
   __OnRawInputKey__Delegate=Default__UTUIFrontEnd.HandleInputKey
   Name="Default__UTUIFrontEnd"
   ObjectArchetype=UTUIScene'UTGame.Default__UTUIScene'
}