1. Epic GamesDeveloper
  3. FUIAction

FUIAction

Implements an UI action.

API > API/Runtime > API/Runtime/Slate

Implements an UI action.

   
Name FUIAction
Type struct
Header File /Engine/Source/Runtime/Slate/Public/Framework/Commands/UIAction.h
Include Path #include "Framework/Commands/UIAction.h"

Syntax

struct FUIAction

Constructors

Name Remarks Include Path Unreal Specifiers
Default constructor. Framework/Commands/UIAction.h  

FUIAction ( FExecuteAction InitExecuteAction,
EUIActionRepeatMode InitRepeatMode
)

 Constructor that takes delegates to initialize the action with Framework/Commands/UIAction.h  

FUIAction ( FExecuteAction InitExecuteAction,
FCanExecuteAction InitCanExecuteAction,
EUIActionRepeatMode InitRepeatMode
)

 Constructor that takes delegates to initialize the action with Framework/Commands/UIAction.h  

FUIAction ( FExecuteAction InitExecuteAction,
FCanExecuteAction InitCanExecuteAction,
FIsActionChecked InitIsCheckedDelegate,
EUIActionRepeatMode InitRepeatMode
)

 Constructor that takes delegates to initialize the action with Framework/Commands/UIAction.h  

FUIAction ( FExecuteAction InitExecuteAction,
FCanExecuteAction InitCanExecuteAction,
FGetActionCheckState InitGetActionCheckStateDelegate,
EUIActionRepeatMode InitRepeatMode
)

 Constructor that takes delegates to initialize the action with Framework/Commands/UIAction.h  

FUIAction ( FExecuteAction InitExecuteAction,
FCanExecuteAction InitCanExecuteAction,
FIsActionChecked InitIsCheckedDelegate,
FIsActionButtonVisible InitIsActionVisibleDelegate,
EUIActionRepeatMode InitRepeatMode
)

 Constructor that takes delegates to initialize the action with Framework/Commands/UIAction.h  

FUIAction ( FExecuteAction InitExecuteAction,
FCanExecuteAction InitCanExecuteAction,
FGetActionCheckState InitGetActionCheckStateDelegate,
FIsActionButtonVisible InitIsActionVisibleDelegate,
EUIActionRepeatMode InitRepeatMode
)

 Constructor that takes delegates to initialize the action with Framework/Commands/UIAction.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
CanExecuteAction FCanExecuteAction Holds a delegate that is executed when determining whether this action can execute. Framework/Commands/UIAction.h  
ExecuteAction FExecuteAction Holds a delegate that is executed when this action is activated. Framework/Commands/UIAction.h  
GetActionCheckState FGetActionCheckState Holds a delegate that is executed when determining the check state of this action. Framework/Commands/UIAction.h  
IsActionVisibleDelegate FIsActionButtonVisible Holds a delegate that is executed when determining whether this action is visible. Framework/Commands/UIAction.h  
RepeatMode EUIActionRepeatMode Can this action can be repeated if the chord used to call it is held down? Framework/Commands/UIAction.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool CanExecute()

 Checks to see if its currently safe to execute this action. Framework/Commands/UIAction.h  

bool CanRepeat()

 Checks whether this action can be repeated if the chord used to call it is held down. Framework/Commands/UIAction.h  

bool Execute()

 Executes this action Framework/Commands/UIAction.h  

ECheckBoxState GetCheckState()

 Queries the checked state for this action. This is only valid for actions that are toggleable! Framework/Commands/UIAction.h  

bool IsBound()

 Checks whether this action's execution delegate is bound. Framework/Commands/UIAction.h  

EVisibility IsVisible()

 Queries the visibility for this action. Framework/Commands/UIAction.h  

Static

Name Remarks Include Path Unreal Specifiers

static ECheckBoxState IsActionCheckedPassthrough ( FIsActionChecked InDelegate
)

 Passthrough function to convert the result from an FIsActionChecked delegate into something that works with a FGetActionCheckState delegate Framework/Commands/UIAction.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page