I don't need to test my programs. I have an error-correcting modem.

UE3:UTUIButtonBar (UT3)

From Unreal Wiki, The Unreal Engine Documentation Site

Jump to: navigation, search
UT3 Object >> UIRoot >> UIScreenObject >> UIObject >> UTUI_Widget >> UTUIButtonBar

Contents
Package: 
UTGame
This class in other games:
UDK
This is an auto-generated page and may need human attention.
Please remove this tag if the page seems reasonably complete or replace it with the {{expand}} tag if the page is not yet complete.

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

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

[edit] Constants

[edit] UTUIBUTTONBAR_MAX_BUTTONS

Value: 6


[edit] UTUIBUTTONBAR_BUTTON_SPACING

Value: -20


[edit] Properties

[edit] bResetButtonScale

Type: bool

Flag indicating that the button scales require a reset

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

[edit] ButtonStringScale

Type: Object.Vector2D

Scaling factor to be applied to all buttons

Default value:

Member Value
X 1.0
Y 1.0

[edit] Default values

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

[edit] Subobjects

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

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

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

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

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

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

[edit] WidgetEventComponent

Class: Engine.UIComp_Event

Inherits from: UTUI_Widget.WidgetEventComponent

No new values.

[edit] Functions

[edit] Native functions

[edit] CanAcceptFocus

native function bool CanAcceptFocus (optional int PlayerIndex) 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

Returns:

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

[edit] Events

[edit] PlayUIAnimation

event PlayUIAnimation (name AnimName, optional UIAnimationSeq AnimSeqTemplate, optional float PlaybackRate, optional bool bLoop, optional float InitialPosition)

Overrides: UIObject.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

[edit] PostInitialize

event PostInitialize ()

Overrides: UIScreenObject.PostInitialize

Called after this screen object's children have been initialized

[edit] Other instance functions

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

[edit] Clear

function Clear ()

Clears all set buttons.

[edit] ClearButton

function ClearButton (int ButtonIndex)


[edit] SetButton

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

Sets information for one of the button bar buttons.

[edit] ToggleButton

function ToggleButton (int ButtonIdx, bool bActive)

Used to toggle a button on/off

Retrieved from "http://wiki.beyondunreal.com/UE3:UTUIButtonBar_(UT3)"
Personal tools