UTGame.UTUITabPage_Mutators

Extends

UTTabPage

Modifiers

placeable

Copyright 1998-2008 Epic Games, Inc. All Rights Reserved. Tab page to let user's select which mutators to use.

Core.Object
|   
+-- Engine.UIRoot
   |   
   +-- Engine.UIScreenObject
      |   
      +-- Engine.UIObject
         |   
         +-- Engine.UIContainer
            |   
            +-- Engine.UITabPage
               |   
               +-- UTGame.UTTabPage
                  |   
                  +-- UTGame.UTUITabPage_Mutators

Delegates Summary
		OnAcceptMutators (string InEnabledMutators)

Functions Summary
	bool	ActivatePage (int PlayerIndex, bool bActivate, optional bool bTakeFocus=true ))
		AddMutatorAndFilterList (int NewMutator))
		ApplyGameModeFilter ()))
	name	GetClassNameFromIndex (int MutatorIndex))
	string	GetEnabledMutators ()))
	bool	HandleInputKey (const out InputEventParameters EventParms ))
	bool	HandleRefreshSubscriberValue (UIObject Sender, int BindingIndex ))
	bool	IsCurrentMutatorConfigurable ()))
		OnAvailableList_SubmitSelection (UIList Sender, optional int PlayerIndex=GetBestPlayerIndex() ))
		OnAvailableList_ValueChanged (UIObject Sender, int PlayerIndex ))
	bool	OnButtonBar_AddMutator (UIScreenObject InButton, int PlayerIndex))
	bool	OnButtonBar_ClearMutators (UIScreenObject InButton, int PlayerIndex))
	bool	OnButtonBar_ConfigureMutator (UIScreenObject InButton, int PlayerIndex))
	bool	OnButtonBar_Next (UIScreenObject InButton, int PlayerIndex))
	bool	OnButtonBar_RemoveMutator (UIScreenObject InButton, int PlayerIndex))
		OnClearMutators ()))
		OnConfigureMutator ()))
		OnEnabledList_SubmitSelection (UIList Sender, optional int PlayerIndex=GetBestPlayerIndex() ))
		OnEnabledList_ValueChanged (UIObject Sender, int PlayerIndex ))
		OnList_NotifyActiveStateChanged (UIScreenObject Sender, int PlayerIndex, UIState NewlyActiveState, optional UIState PreviouslyActiveState ))
		OnMoveMutator (bool bAddMutator))
		OnMutatorListChanged ()))
	bool	OnMutatorList_RawInputKey (const out InputEventParameters EventParms ))
		OnNext ()))
		OnSelectedMutatorChanged ()))
		PostInitialize ()))
		SetMutatorEnabled (int MutatorId, bool bEnabled))
		SetupButtonBar (UTUIButtonBar ButtonBar))
		UpdateDescriptionLabel ()))

MANUAL_LIST_REFRESH_DATABINDING_INDEX Source code

AvailableList Source code

List of available mutators.

DescriptionLabel Source code

Label describing the currently selected mutator.

EnabledList Source code

List of enabled mutators.

LastFocusedList Source code

The last list that was focused.

ListBackground_Available Source code

ListBackground_Enabled Source code

MenuDataStore Source code

Reference to the menu datastore

ShiftLeftImage Source code

ShiftRightImage Source code

Arrow images.

OnAcceptMutators Source code

Callback for when the user decides to accept the current set of mutators.

ActivatePage Source code

Causes this page to become (or no longer be) the tab control's currently active page.
@param PlayerIndex the index [into the Engine.GamePlayers array] for the player that wishes to activate this page.
@param bActivate TRUE if this page should become the tab control's active page; FALSE if it is losing the active status.
@param bTakeFocus specify TRUE to give this panel focus once it's active (only relevant if bActivate = true)
@return TRUE if this page successfully changed its active state; FALSE otherwise.

AddMutatorAndFilterList Source code

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

ApplyGameModeFilter Source code

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

GetClassNameFromIndex Source code

GetEnabledMutators Source code

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

HandleInputKey Source code

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.
@param EventParms information about the input event.
@return TRUE to indicate that this input key was processed; no further processing will occur on this input key event.

HandleRefreshSubscriberValue Source code

Called when this widget receives a call to RefreshSubscriberValue.
@param BindingIndex optional parameter for indicating which data store binding is being refreshed, for those objects which have multiple data store bindings. How this parameter is used is up to the class which implements this interface, but typically the "primary" data store will be index 0, while values greater than FIRST_DEFAULT_DATABINDING_INDEX correspond to tooltips and context menus.
@return TRUE to indicate that this widget is going to refresh its value manually.

IsCurrentMutatorConfigurable Source code

@return Returns whether or not the current mutator is configurable.

OnAvailableList_SubmitSelection Source code

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

OnAvailableList_ValueChanged Source code

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

OnButtonBar_AddMutator Source code

OnButtonBar_ClearMutators Source code

OnButtonBar_ConfigureMutator Source code

Buttonbar Callbacks.

OnButtonBar_Next Source code

OnButtonBar_RemoveMutator Source code

OnClearMutators Source code

Clears the enabled mutator list.

OnConfigureMutator Source code

Loads the configuration scene for the currently selected mutator.

OnEnabledList_SubmitSelection Source code

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

OnEnabledList_ValueChanged Source code

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

OnList_NotifyActiveStateChanged Source code

Callback for when the object's active state changes.

OnMoveMutator Source code

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

OnMutatorListChanged Source code

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

OnMutatorList_RawInputKey Source code

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

OnNext Source code

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

OnSelectedMutatorChanged Source code

Updates widgets when the currently selected mutator changes.

PostInitialize Source code

Post initialization event - Setup widget delegates.

SetMutatorEnabled Source code

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

SetupButtonBar Source code

Sets up the button bar for the parent scene.

UpdateDescriptionLabel Source code

Updates the description label.

defaultproperties
{
   Begin Object Class=UIComp_Event Name=WidgetEventComponent ObjName=WidgetEventComponent Archetype=UIComp_Event'UTGame.Default__UTTabPage:WidgetEventComponent'
      ObjectArchetype=UIComp_Event'UTGame.Default__UTTabPage:WidgetEventComponent'
   End Object
   EventProvider=WidgetEventComponent
   Name="Default__UTUITabPage_Mutators"
   ObjectArchetype=UTTabPage'UTGame.Default__UTTabPage'
}