I'm a doctor, not a mechanic

Difference between revisions of "UE3:UTUIButtonBar (UT3)"

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
(Talk)
m (added missing members)
 
Line 8: Line 8:
 
}}
 
}}
 
{{autogenerated}}
 
{{autogenerated}}
−
Copyright 1998-2007 Epic Games, Inc. All Rights Reserved.
+
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.
 
Container class that holds multiple UTUIButtonBarButton instances.  This class autopositions itself and its buttons at the bottom of the screen.
Line 24: Line 24:
  
 
==Properties==
 
==Properties==
 +
====bResetButtonScale====
 +
'''Type:''' [[bool]]
 +
 +
Flag indicating that the button scales require a reset
 +
 
====Buttons====
 
====Buttons====
 
'''Type:''' {{cl|UTUIButtonBarButton}}
 
'''Type:''' {{cl|UTUIButtonBarButton}}
Line 44: Line 49:
  
 
'''Default value, index 5:''' {{cl|UTUIButtonBarButton}}'UTGame.Default__UTUIButtonBar:ButtonTemplate5'
 
'''Default value, index 5:''' {{cl|UTUIButtonBarButton}}'UTGame.Default__UTUIButtonBar:ButtonTemplate5'
 +
 +
====ButtonStringScale====
 +
'''Type:''' {{tl|Vector2D|Object|structs}}
 +
 +
Scaling factor to be applied to all buttons
 +
 +
'''Default value:'''
 +
{| class="list defaults"
 +
! {{tl|Vector2D||Object structs|Member}}
 +
! Value
 +
|-
 +
| X
 +
| 1.0
 +
|-
 +
| Y
 +
| 1.0
 +
|}
  
 
===Default values===
 
===Default values===
Line 49: Line 71:
 
! Property
 
! Property
 
! Value
 
! Value
 +
|-
 +
| {{tl|bRequiresTick||UTUI_Widget}}
 +
| True
 
|-
 
|-
 
| {{tl|DefaultStates||UIScreenObject}}[2]
 
| {{tl|DefaultStates||UIScreenObject}}[2]

Latest revision as of 05:59, 16 August 2009

UT3 Object >> UIRoot >> UIScreenObject >> UIObject >> UTUI_Widget >> UTUIButtonBar
Package: 
UTGame
This class in other games:
UDK
This is an auto-generated page and may need human attention.
Please remove the {{autogenerated}} 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.

Constants[edit]

UTUIBUTTONBAR_MAX_BUTTONS[edit]

Value: 6


UTUIBUTTONBAR_BUTTON_SPACING[edit]

Value: -20


Properties[edit]

bResetButtonScale[edit]

Type: bool

Flag indicating that the button scales require a reset

Buttons[edit]

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'

ButtonStringScale[edit]

Type: Object.Vector2D

Scaling factor to be applied to all buttons

Default value:

Member Value
X 1.0
Y 1.0

Default values[edit]

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

Subobjects[edit]

ButtonTemplate0[edit]

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

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

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

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

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

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

Class: Engine.UIComp_Event

Inherits from: UTUI_Widget.WidgetEventComponent

No new values.

Functions[edit]

Native functions[edit]

CanAcceptFocus[edit]

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.

Events[edit]

PlayUIAnimation[edit]

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

PostInitialize[edit]

event PostInitialize ()

Overrides: UIScreenObject.PostInitialize

Called after this screen object's children have been initialized

Other instance functions[edit]

AppendButton[edit]

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

function Clear ()

Clears all set buttons.

ClearButton[edit]

function ClearButton (int ButtonIndex)


SetButton[edit]

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

Sets information for one of the button bar buttons.

ToggleButton[edit]

function ToggleButton (int ButtonIdx, bool bActive)

Used to toggle a button on/off

Retrieved from "https://wiki.beyondunreal.com/UE3:UTUIButtonBar_(UT3)?oldid=35233"