UE3:UTUIFrontEnd (UT3)

Object >> UIRoot >> UIScreenObject >> UIScene >> UTUIScene >> UTUIFrontEnd

Package: 

UTGame

Direct subclasses:

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

This class in other games:

UDK

Copyright 1998-2008 Epic Games, Inc. All Rights Reserved.

Base class for frontend scenes, looks for buttonbar and tab control references.

Properties

Property group 'UTUIFrontEnd'

TitleMarkupString

Type: string

Markup for the title for this scene.

Internal variables

bCancellingInstallPS3

Type: bool

Modifiers: transient

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

bInstallingPS3

Type: bool

Modifiers: transient

Whether or not we are currently installing on the PS3.

ButtonBar

Type: UTUIButtonBar

Modifiers: transient

Pointer to the button bar for this scene.

CurrentPageIndex

Type: int

Modifiers: transient

ImportingMessageBoxReference

Type: UTUIScene_MessageBox

Modifiers: transient

ImportState

Type: EModImport

Modifiers: transient

LastURL

Type: string

Modifiers: transient

PreviousPageIndex

Type: int

Modifiers: transient

TabControl

Type: UTUITabControl

Modifiers: transient

Pointer to the tab control for this scene.

VersionFont

Type: Font

VersionPos

Type: Object.Vector2D

Default value:

Member	Value
X	0.0090
Y	0.057

VersionText

Type: string

Modifiers: localized

Default value: "Version 2.1"

Default values

Property	Value
OnRawInputKey	HandleInputKey
OnTopSceneChanged	ChildSceneOpened
bPauseGameWhileActive	False
DefaultContextMenuClass	Class'Engine.UIContextMenu'
SceneRenderMode	SPLITRENDER_Fullscreen

Subobjects

SceneEventComponent

Class: Engine.UIComp_Event

Inherits from: UTUIScene.SceneEventComponent

No new values.

Enums

EModImport

Current mod import state.

MODIMPORT_Inactive 

MODIMPORT_Started 

MODIMPORT_Unpacking 

MODIMPORT_Finished 

Functions

Native functions

BeginImportMod

native function BeginImportMod ()

Starts the mod importing process.

BeginInstallPS3

native function BeginInstallPS3 ()

Starts the PS3 install process.

CancelInstallPS3

native function CancelInstallPS3 ()

Cancels the PS3 install.

SavePassword

native function SavePassword (string Password)

Encrypts the password and saves the data

Events

PostInitialize

event PostInitialize ()

Overrides: UIScreenObject.PostInitialize

Post initialize callback.

SceneActivated

event SceneActivated (bool bInitialActivation)

Overrides: UIScene.SceneActivated

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

UpdateModState

event UpdateModState (EModImport NewState)

Updates the current state of the mod import.

Parameters:

• NewState - New import state

UpdatePS3InstallState

event UpdatePS3InstallState (int CurrentFileNum, int TotalFileNum, bool bFinishedCancelling)

Updates the current install state for the PS3 Install.

Parameters:

• CurrentFileNum - Current file number installing.
• TotalFileNum - Total number of files to install.

Other instance functions

BeginHideAnimation

function bool BeginHideAnimation (bool bClosingScene)

Overrides: UTUIScene.BeginHideAnimation

Starts the exit animation for the scene.

Returns:

TRUE if there's animation for this scene, FALSE otherwise.

BeginShowAnimation

function bool BeginShowAnimation (bool bInitialActivation, bool bBypassAnimation)

Overrides: UTUIScene.BeginShowAnimation

Starts the show animation for the scene.

Parameters:

• bInitialActivation - TRUE if the scene is being opened; FALSE if the another scene was closed causing this one to become the topmost scene.
• 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.

Returns:

TRUE if there's animation for this scene, FALSE otherwise.

CheckForFrontEndError

function CheckForFrontEndError ()

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

function ChildSceneOpened (UIScene NewTopScene)

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

GetTitleLabel

function UILabel GetTitleLabel ()

Returns:

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

HandleInputKey

function bool HandleInputKey (const out UIRoot.InputEventParameters EventParms)

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.

Parameters:

• EventParms - information about the input event.

Returns:

TRUE to indicate that this input key was processed; no further processing will occur on this input key event.

ImportMod

function ImportMod ()

Function to start importing a mod.

InstallPS3

function InstallPS3 ()

Installs the game on PS3.

OnCancelInstallPS3

function OnCancelInstallPS3 (UTUIScene_MessageBox MessageBox, int SelectedItem, int PlayerIndex)

Confirmation for the cancel dialog.

OnCancelMessageClosed

function OnCancelMessageClosed ()

Callback for the install PS3 messagebox has closed.

OnImportModFinished

function OnImportModFinished ()

Callback for when the import has finished for a mod.

OnInstallMessageClosed

function OnInstallMessageClosed ()

Callback for the install PS3 messagebox has closed.

OnLoginError_Confirm

function OnLoginError_Confirm (UTUIScene_MessageBox MessageBox, int SelectedItem, int PlayerIndex)

Overrides: UTUIScene.OnLoginError_Confirm

Callback for when the login required box has finished displaying.

OnMainRegion_Show_UIAnimEnd

function OnMainRegion_Show_UIAnimEnd (UIObject AnimTarget, int AnimIndex, UIAnimationSeq AnimSeq)

Called when a tab page has finished showing.

OnPageActivated

function OnPageActivated (UITabControl Sender, UITabPage NewlyActivePage, int PlayerIndex)

Called when a new page is activated.

Parameters:

• Sender - the tab control that activated the page
• NewlyActivePage - the page that was just activated
• PlayerIndex - the index [into the Engine.GamePlayers array] for the player that generated this event.

OnRetryPasswordDialog_Closed

final function OnRetryPasswordDialog_Closed (UTUIScene_MessageBox MessageBox, int SelectedOption, int PlayerIndex)

OnTabPage_Hide_UIAnimEnd

function OnTabPage_Hide_UIAnimEnd (UIObject AnimTarget, int AnimIndex, UIAnimationSeq AnimSeq)

Called when a tab page has finished hiding.

OnTabPage_Show_UIAnimEnd

function OnTabPage_Show_UIAnimEnd (UIObject AnimTarget, int AnimIndex, UIAnimationSeq AnimSeq)

Called when a tab page has finished showing.

PromptForPassword

final function PromptForPassword ()

SetTitle

function SetTitle ()

Sets the title for this scene.

SetupButtonBar

function SetupButtonBar ()

Overrides: UTUIScene.SetupButtonBar

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