UE3:UTUIFrontEnd_Mutators (UT3)

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

Package: 

UTGame

This class in other games:

UDK

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

Scene to let user's select which mutators to use.

Properties

AvailableList

Type: UIList

Modifiers: transient

List of available mutators.

DescriptionLabel

Type: UILabel

Modifiers: transient

Label describing the currently selected mutator.

EnabledList

Type: UIList

Modifiers: transient

List of enabled mutators.

LastFocusedList

Type: UIList

Modifiers: transient

The last list that was focused.

MenuDataStore

Type: UTUIDataStore_MenuItems

Modifiers: transient

Reference to the menu datastore

OldEnabledMutators

Type: array<int>

Modifiers: transient

Mutators that were enabled when we entered the scene.

SettingsDataStore

Type: UIDataStore_OnlineGameSettings

Modifiers: transient

Reference to the settings datastore which will persistently store mutator settings

ShiftLeftImage

Type: UIImage

Modifiers: transient

ShiftRightImage

Type: UIImage

Modifiers: transient

Arrow images.

Subobjects

SceneEventComponent

Class: Engine.UIComp_Event

Inherits from: UTUIFrontEnd.SceneEventComponent

No new values.

Functions

Static functions

ApplyGameModeFilter

static function ApplyGameModeFilter ()

Applies the game mode filter to the enabled and available mutator lists.

GetClassNameFromIndex

static function name GetClassNameFromIndex (int MutatorIndex)

GetEnabledMutators

static function string GetEnabledMutators ()

Returns:

Returns the current list of enabled mutators, separated by commas.

Events

PostInitialize

event PostInitialize ()

Overrides: UTUIFrontEnd.PostInitialize

Post initialization event - Setup widget delegates.

Other instance functions

AddMutatorAndFilterList

function AddMutatorAndFilterList (int NewMutator)

Attempts to filter the mutator list to ensure that there are no duplicate groups or mutators enabled that can not be enabled.

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.

IsCurrentMutatorConfigurable

function bool IsCurrentMutatorConfigurable ()

Returns:

Returns whether or not the current mutator is configurable.

OnAvailableList_NotifyActiveStateChanged

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

Callback for when the object's active state changes.

OnAvailableList_SubmitSelection

function OnAvailableList_SubmitSelection (UIList Sender, optional int PlayerIndex)

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

OnAvailableList_ValueChanged

function OnAvailableList_ValueChanged (UIObject Sender, int PlayerIndex)

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

OnButtonBar_AddMutator

function bool OnButtonBar_AddMutator (UIScreenObject InButton, int PlayerIndex)

OnButtonBar_Cancel

function bool OnButtonBar_Cancel (UIScreenObject InButton, int PlayerIndex)

OnButtonBar_ClearMutators

function bool OnButtonBar_ClearMutators (UIScreenObject InButton, int PlayerIndex)

OnButtonBar_ConfigureMutator

function bool OnButtonBar_ConfigureMutator (UIScreenObject InButton, int PlayerIndex)

Buttonbar Callbacks.

OnButtonBar_Next

function bool OnButtonBar_Next (UIScreenObject InButton, int PlayerIndex)

OnButtonBar_RemoveMutator

function bool OnButtonBar_RemoveMutator (UIScreenObject InButton, int PlayerIndex)

OnCancel

function OnCancel ()

The user has finished setting up their mutators and wants to continue on.

OnClearMutators

function OnClearMutators ()

Clears the enabled mutator list.

OnConfigureMutator

function OnConfigureMutator ()

Loads the configuration scene for the currently selected mutator.

OnEnabledList_NotifyActiveStateChanged

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

Callback for when the object's active state changes.

OnEnabledList_SubmitSelection

function OnEnabledList_SubmitSelection (UIList Sender, optional int PlayerIndex)

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

OnEnabledList_ValueChanged

function OnEnabledList_ValueChanged (UIObject Sender, int PlayerIndex)

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

OnMoveMutator

function OnMoveMutator (bool bAddMutator)

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

OnMutatorList_RawInputKey

function bool OnMutatorList_RawInputKey (const out UIRoot.InputEventParameters EventParms)

Callback for the mutator lists, captures the accept button before the mutators get to it.

OnMutatorListChanged

function OnMutatorListChanged ()

Repopulate the lists; called whenever items are added or removed to one of the lists.

OnNext

function OnNext ()

The user has finished setting up their mutators and wants to continue on.

OnSelectedMutatorChanged

function OnSelectedMutatorChanged ()

Updates widgets when the currently selected mutator changes.

SetMutatorEnabled

function SetMutatorEnabled (int MutatorId, bool bEnabled)

Modifies the enabled mutator array to enable/disable a mutator.

SetupButtonBar

function SetupButtonBar ()

Overrides: UTUIFrontEnd.SetupButtonBar

Sets up the button bar for the parent scene.

UpdateDescriptionLabel

function UpdateDescriptionLabel ()

Updates the description label.