UE3:UTUIFrontEnd_CharacterFaction (UT3)

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

Package: 

UTGame

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

Character Faction selection screen for UT3

Properties

CharacterSelectionScene

Type: string

Character selection scene to display once the user chooses a faction.

Default value: "UI_Scenes_ChrisBLayout.Scenes.CharacterSelection"

DescriptionLabel

Type: UILabel

Modifiers: transient

Description label.

FactionList

Type: UTUIList

Modifiers: transient

List widget.

InputBoxReference

Type: UTUIScene_InputBox

Modifiers: transient

Reference to the input box used to unlock characters.

PreviewImage

Type: UIImage

Modifiers: transient

Preview image.

Subobjects

SceneEventComponent

Class: Engine.UIComp_Event

Inherits from: UTUIFrontEnd.SceneEventComponent

No new values.

Functions

Events

PostInitialize

event PostInitialize ()

Overrides: UTUIFrontEnd.PostInitialize

PostInitialize event - Sets delegates for the scene.

SceneActivated

event SceneActivated (bool bInitialActivation)

Overrides: UTUIFrontEnd.SceneActivated

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

Other instance functions

HandleInputKey

function bool HandleInputKey (const out UIRoot.InputEventParameters EventParms)

Overrides: UTUIFrontEnd.HandleInputKey

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.

OnBack

function OnBack ()

Called when the user wants to back out of the scene.

OnButtonBar_Back

function bool OnButtonBar_Back (UIScreenObject InButton, int InPlayerIndex)

Button bar callbacks - Back Button

OnButtonBar_EnterUnlockCode

function bool OnButtonBar_EnterUnlockCode (UIScreenObject InButton, int InPlayerIndex)

Button bar callbacks - Enter unlock code Button

OnButtonBar_Next

function bool OnButtonBar_Next (UIScreenObject InButton, int InPlayerIndex)

Button bar callbacks - Accept Button

OnEnterCodeResult

function OnEnterCodeResult (UTUIScene_MessageBox MessageBox, int SelectedOption, int PlayerIndex)

Called when the user has made a selection of the choices available to them.

OnEnterUnlockCode

function OnEnterUnlockCode ()

Called when the user wants to enter a character unlock code.

OnFactionList_SubmitSelection

function OnFactionList_SubmitSelection (UIList Sender, optional int PlayerIndex)

Called when the user changes the current list index.

Parameters:

• Sender - the list that is submitting the selection

OnFactionList_ValueChanged

function OnFactionList_ValueChanged (UIObject Sender, optional int PlayerIndex)

Called when the user presses Enter (or any other action bound to UIKey_SubmitListSelection) while this list has focus.

Parameters:

• Sender - the list that is submitting the selection

OnFactionSelected

function OnFactionSelected ()

Finds the faction that was selected and sets the datastore value for it.

SetupButtonBar

function SetupButtonBar ()

Overrides: UTUIFrontEnd.SetupButtonBar

Setup the scene's button bar.