UE3:UTUIFrontEnd (UDK)

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

Package: 

UTGame

Direct subclasses:

UTUIFrontEnd_ArenaConfigMenu, UTUIFrontEnd_BasicMenu, UTUIFrontEnd_JoinGame, UTUIFrontEnd_LaunchGame, UTUIFrontEnd_Mutators, UTUIFrontEnd_WeaponReplacementMenu

This class in other games:

UT3

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

ButtonBar

Type: UTUIButtonBar

Modifiers: transient

Pointer to the button bar for this scene.

CurrentPageIndex

Type: int

Modifiers: transient

PreviousPageIndex

Type: int

Modifiers: transient

TabControl

Type: UTUITabControl

Modifiers: transient

Pointer to the tab control for this scene.

Default values

Property	Value
OnInterceptRawInputKey	HandleInputKey
OnTopSceneChanged	ChildSceneOpened
bPauseGameWhileActive	False
SceneRenderMode	SPLITRENDER_Fullscreen

Subobjects

SceneEventComponent

Class: Engine.UIComp_Event

Inherits from: UTUIScene.SceneEventComponent

No new values.

Functions

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.

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.

OnMainRegion_Show_UIAnimEnd

function OnMainRegion_Show_UIAnimEnd (UIScreenObject AnimTarget, name AnimName, int TrackTypeMask)

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.

OnTabPage_Hide_UIAnimEnd

function OnTabPage_Hide_UIAnimEnd (UIScreenObject AnimTarget, name AnimName, int TrackTypeMask)

Called when a tab page has finished hiding.

OnTabPage_Show_UIAnimEnd

function OnTabPage_Show_UIAnimEnd (UIScreenObject AnimTarget, name AnimName, int TrackTypeMask)

Called when a tab page has finished showing.

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.