Mostly Harmless

UE3:UIState_Disabled (UT3)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
UT3 Object >> UIRoot >> UIState >> UIState_Disabled
Package: 
Engine
Implemented interfaces
UIEventContainer
This class in other games:
UDK

Represents the "disabled" widget state. Disabled widgets cannot respond to input or recieve focus.

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

Events

ActivateState

event bool ActivateState (UIScreenObject Target, int PlayerIndex)

Overrides: UIState.ActivateState

Activate this state for the specified target.

Parameters:

  • Target - the widget that is activating this state.
  • PlayerIndex - the index [into the Engine.GamePlayers array] for the player that generated this call

Returns:

TRUE to allow this state to be activated for the specified Target.

IsStateAllowed

event bool IsStateAllowed (UIScreenObject Target, UIState NewState, int PlayerIndex)

Overrides: UIState.IsStateAllowed

Allows states currently in a widget's StateStack to prevent the widget from entering a new state. This function is only called for states currently in the widget's StateStack.

Parameters:

  • Target - the widget that wants to enter the new state
  • NewState - the new state that widget wants to enter
  • PlayerIndex - the index [into the Engine.GamePlayers array] for the player that generated this call

Returns:

TRUE if the widget should be allowed to enter the state specified.