Always snap to grid

UE3:UTUIFrontEnd_BotSelection (UT3)

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

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

UI scene that allows the user to select which bots they want to play with.

Properties[edit]

AvailableList[edit]

Type: UIList

Modifiers: transient

List of available maps.

CharacterDataStore[edit]

Type: UTUIDataStore_CustomChar

Modifiers: transient

Reference to the customchar datastore

DescriptionLabel[edit]

Type: UILabel

Modifiers: transient

Label describing the currently selected mutator.

EnabledList[edit]

Type: UIList

Modifiers: transient

List of enabled maps.

LastFocused[edit]

Type: UIList

Modifiers: transient

The last focused UI List.

ListBackground_Available[edit]

Type: UIImage

Modifiers: transient


ListBackground_Enabled[edit]

Type: UIImage

Modifiers: transient


ShiftLeftImage[edit]

Type: UIImage

Modifiers: transient


ShiftRightImage[edit]

Type: UIImage

Modifiers: transient

Arrow images.

Subobjects[edit]

SceneEventComponent[edit]

Class: Engine.UIComp_Event

Inherits from: UTUIFrontEnd.SceneEventComponent

No new values.

Delegates[edit]

OnAcceptedBots[edit]

delegate OnAcceptedBots ()

Delegate or when the user accepts their current bot selection set.

Functions[edit]

Events[edit]

PostInitialize[edit]

event PostInitialize ()

Overrides: UTUIFrontEnd.PostInitialize

Post initialization event - Setup widget delegates.

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.

LoadBotList[edit]

function LoadBotList ()

Loads the bot list from UTGame.default

OnAccept[edit]

function OnAccept ()

The user has finished setting up their cycle and wants to save changes.

OnAvailableList_SubmitSelection[edit]

function OnAvailableList_SubmitSelection (UIList Sender, optional int PlayerIndex)

Callback for when the user submits the selection on the available list.

OnAvailableList_ValueChanged[edit]

function OnAvailableList_ValueChanged (UIObject Sender, int PlayerIndex)

Callback for when the user selects a new item in the available list.

OnBack[edit]

function OnBack ()

The user wants to back out of the map cycle scene.

OnBotList_RawInputKey[edit]

function bool OnBotList_RawInputKey (const out UIRoot.InputEventParameters EventParms)

Callback for the bot lists, captures the accept button before the list gets to it.

OnBotListChanged[edit]

function OnBotListChanged ()

Called whenever one of the bot lists changes.

OnButtonBar_Accept[edit]

function bool OnButtonBar_Accept (UIScreenObject InButton, int PlayerIndex)

Buttonbar Callbacks.

OnButtonBar_Back[edit]

function bool OnButtonBar_Back (UIScreenObject InButton, int PlayerIndex)


OnButtonBar_ClearBots[edit]

function bool OnButtonBar_ClearBots (UIScreenObject InButton, int PlayerIndex)


OnButtonBar_MoveBot[edit]

function bool OnButtonBar_MoveBot (UIScreenObject InButton, int PlayerIndex)


OnClearBots[edit]

function OnClearBots ()

Clears the enabled bot list.

OnEnabledList_SubmitSelection[edit]

function OnEnabledList_SubmitSelection (UIList Sender, optional int PlayerIndex)

Callback for when the user submits the selection on the enabled list.

OnEnabledList_ValueChanged[edit]

function OnEnabledList_ValueChanged (UIObject Sender, int PlayerIndex)

Callback for when the user selects a new item in the enabled list.

OnList_NotifyActiveStateChanged[edit]

function OnList_NotifyActiveStateChanged (UIScreenObject Sender, int PlayerIndex, UIState NewlyActiveState, optional UIState PreviouslyActiveState)

Callback for when the object's active state changes.

OnMoveBot[edit]

function OnMoveBot ()

Callback for when the user tries to move a bot from one list to another.

OnSelectedBotChanged[edit]

function OnSelectedBotChanged ()

Updates widgets when the currently selected bot changes.

SaveBotList[edit]

function SaveBotList ()

Saves out the current list bot bot names to use to UTGame.default

SetupButtonBar[edit]

function SetupButtonBar ()

Overrides: UTUIFrontEnd.SetupButtonBar

Sets up the button bar for the parent scene.

UpdateDescriptionLabel[edit]

function UpdateDescriptionLabel ()

Updates the description label.