UE3:UTUIButtonBar (UDK)

Object >> UIRoot >> UIScreenObject >> UIObject >> UTUI_Widget >> UTUIButtonBar

Package: 

UTGame

This class in other games:

UT3

Container class that holds multiple UTUIButtonBarButton instances. This class autopositions itself and its buttons at the bottom of the screen.

Constants

UTUIBUTTONBAR_MAX_BUTTONS

Value: 6

UTUIBUTTONBAR_BUTTON_SPACING

Value: -20

Properties

Buttons

Type: UTUIButtonBarButton

Array size: 6 (UTUIBUTTONBAR_MAX_BUTTONS)

Modifiers: instanced

Array of actual label buttons for the button bar.

Default value, index 0: UTUIButtonBarButton'UTGame.Default__UTUIButtonBar:ButtonTemplate0'

Default value, index 1: UTUIButtonBarButton'UTGame.Default__UTUIButtonBar:ButtonTemplate1'

Default value, index 2: UTUIButtonBarButton'UTGame.Default__UTUIButtonBar:ButtonTemplate2'

Default value, index 3: UTUIButtonBarButton'UTGame.Default__UTUIButtonBar:ButtonTemplate3'

Default value, index 4: UTUIButtonBarButton'UTGame.Default__UTUIButtonBar:ButtonTemplate4'

Default value, index 5: UTUIButtonBarButton'UTGame.Default__UTUIButtonBar:ButtonTemplate5'

Default values

Property	Value
DefaultStates[2]	Class'Engine.UIState_Focused'
Position	Member Value Value[1] 0.95 Value[3] 0.05

Subobjects

ButtonTemplate0

Class: UTGame.UTUIButtonBarButton

Property	Value
CaptionDataSource	Member Value MarkupString "Button 0"
Position	Member Value Value[0] 0.9 Value[2] 0.1 Value[3] 0.7
TabIndex	0
WidgetTag	'butButtonBarButton0'

ButtonTemplate1

Class: UTGame.UTUIButtonBarButton

Property	Value
CaptionDataSource	Member Value MarkupString "Button 1"
Position	Member Value Value[0] 0.9 Value[2] 0.1 Value[3] 0.7
TabIndex	1
WidgetTag	'butButtonBarButton1'

ButtonTemplate2

Class: UTGame.UTUIButtonBarButton

Property	Value
CaptionDataSource	Member Value MarkupString "Button 2"
Position	Member Value Value[0] 0.9 Value[2] 0.1 Value[3] 0.7
TabIndex	2
WidgetTag	'butButtonBarButton2'

ButtonTemplate3

Class: UTGame.UTUIButtonBarButton

Property	Value
CaptionDataSource	Member Value MarkupString "Button 3"
Position	Member Value Value[0] 0.9 Value[2] 0.1 Value[3] 0.7
TabIndex	3
WidgetTag	'butButtonBarButton3'

ButtonTemplate4

Class: UTGame.UTUIButtonBarButton

Property	Value
CaptionDataSource	Member Value MarkupString "Button 4"
Position	Member Value Value[0] 0.9 Value[2] 0.1 Value[3] 0.7
TabIndex	4
WidgetTag	'butButtonBarButton4'

ButtonTemplate5

Class: UTGame.UTUIButtonBarButton

Property	Value
CaptionDataSource	Member Value MarkupString "Button 5"
Position	Member Value Value[0] 0.9 Value[2] 0.1 Value[3] 0.7
TabIndex	5
WidgetTag	'butButtonBarButton5'

WidgetEventComponent

Class: Engine.UIComp_Event

Inherits from: UTUI_Widget.WidgetEventComponent

No new values.

Functions

Native functions

CanAcceptFocus

native function bool CanAcceptFocus (optional int PlayerIndex, optional bool bIncludeParentVisibility) const

Overrides: UIObject.CanAcceptFocus

Determines whether this widget can become the focused control.

Parameters:

• PlayerIndex - the index [into the Engine.GamePlayers array] for the player to check focus availability
• bIncludeParentVisibility - indicates whether the widget should consider the visibility of its parent widgets when determining whether it is eligible to receive focus. Only needed when building navigation networks, where the widget might start out hidden (such as UITabPanel).

Returns:

TRUE if this widget (or any of its children) is capable of becoming the focused control.

Events

PlayUIAnimation

event PlayUIAnimation (name AnimName, optional UIAnimationSeq AnimSeqTemplate, optional UIAnimation.EUIAnimationLoopMode OverrideLoopMode, optional float PlaybackRate, optional float InitialPosition, optional bool bSetAnimatingFlag)

Overrides: UIScreenObject.PlayUIAnimation

Play an animation on this UIObject

Parameters:

• AnimName - The Name of the Animation to play
• AnimSeq - Optional, A Sequence Template. If that's set, we use it instead
• PlaybackRate - Optional, How fast to play back the sequence
• InitialPosition - Optional, Where in the sequence should we start

PostInitialize

event PostInitialize ()

Overrides: UIScreenObject.PostInitialize

Called after this screen object's children have been initialized. While the Initialized event is only called when a widget is initialized for the first time, PostInitialize() will be called every time this widget receives a call to Initialize(), even if the widget was already initialized. Examples would be reparenting a widget.

Other instance functions

AppendButton

function int AppendButton (string ButtonTextMarkup, delegate<UIObject.OnClicked> ButtonDelegate)

Appends a button to the button bar.

Parameters:

• ButtonTextMarkup - Markup for the button's caption
• ButtonDelegate - Delegate to call when the button is clicked on.

Clear

function Clear ()

Clears all set buttons.

ClearButton

function ClearButton (int ButtonIndex)

SetButton

function SetButton (int ButtonIndex, string ButtonTextMarkup, delegate<UIObject.OnClicked> ButtonDelegate)

Sets information for one of the button bar buttons.

ToggleButton

function ToggleButton (int ButtonIdx, bool bActive)

Used to toggle a button on/off