Mostly Harmless

UE3:UTUIFrontEnd_CharacterSelection (UT3)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
UT3 Object >> UIRoot >> UIScreenObject >> UIScene >> UTUIScene >> UTUIFrontEnd >> UTUIFrontEnd_CharacterSelection
Package: 
UTGame

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

Character selection screen for UT3.

Properties[edit]

CharacterCustomizationScene[edit]

Type: string

Character customization scene to display once the user chooses a character type.

Default value: "UI_Scenes_FrontEnd.Scenes.CharacterCustomization"

CharacterList[edit]

Type: UTUIList

Modifiers: transient

List widget.

DescriptionLabel[edit]

Type: UILabel

Modifiers: transient

Description label.

PreviewImage[edit]

Type: UIImage

Modifiers: transient

Preview image.

Subobjects[edit]

SceneEventComponent[edit]

Class: Engine.UIComp_Event

Inherits from: UTUIFrontEnd.SceneEventComponent

No new values.

Functions[edit]

Events[edit]

PostInitialize[edit]

event PostInitialize ()

Overrides: UTUIFrontEnd.PostInitialize

PostInitialize event - Sets delegates for the scene.

Other instance functions[edit]

HandleInputKey[edit]

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[edit]

function OnBack ()

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

OnButtonBar_Back[edit]

function bool OnButtonBar_Back (UIScreenObject InButton, int InPlayerIndex)

Button bar callbacks - Back Button

OnButtonBar_Next[edit]

function bool OnButtonBar_Next (UIScreenObject InButton, int InPlayerIndex)

Button bar callbacks - Accept Button

OnCharacterList_SubmitSelection[edit]

function OnCharacterList_SubmitSelection (UIList Sender, optional int PlayerIndex)

Called when the user submits the current list index.

Parameters:

  • Sender - the list that is submitting the selection

OnCharacterList_ValueChanged[edit]

function OnCharacterList_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

OnCharacterSelected[edit]

function OnCharacterSelected ()

Updates the datastore with the currently selected character's family ID and shows the part selection screen.

SetupButtonBar[edit]

function SetupButtonBar ()

Overrides: UTUIFrontEnd.SetupButtonBar

Setup the scene's button bar.