The three virtues of a programmer: Laziness, Impatience, and Hubris. – Larry Wall

UE3:UTUIPressButton (UDK)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
UDK Object >> UIRoot >> UIScreenObject >> UIObject >> UIButton >> UTUIPressButton
Package: 
UTGame
This class in other games:
UT3

Modified version of button that fires events when the user begins and ends press, also doesn't accept focus on the console

Default values

Property Value
OnProcessInputKey ProcessInputKey

Subobjects

BackgroundImageTemplate

Class: Engine.UIComp_DrawImage

Inherits from: UIButton.BackgroundImageTemplate

No new values.

WidgetEventComponent

Class: Engine.UIComp_Event

Inherits from: UIButton.WidgetEventComponent

No new values.

Delegates

OnBeginPress

delegate OnBeginPress (UIScreenObject InObject, int InPlayerIndex)

Delegates for when the user starts and ends their press of the buttons.

OnEndPress

delegate OnEndPress (UIScreenObject InObject, int InPlayerIndex)


Instance functions

CanAcceptFocus

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

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.

ProcessInputKey

function bool ProcessInputKey (const out UIRoot.SubscribedInputEventParameters EventParms)

Input handling, fires press/released delegates.