Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

Light Theme

Dark Theme

FUIAction

Implements an UI action.

Windows

MacOS

Linux

References

Module	Slate
Header	/Engine/Source/Runtime/Slate/Public/Framework/Commands/UIAction.h
Include	#include "Framework/Commands/UIAction.h"

Syntax

struct FUIAction

Remarks

Implements an UI action.

Variables

	Name	Description
FCanExecuteActi...	CanExecuteAction	Holds a delegate that is executed when determining whether this action can execute.
FExecuteAction	ExecuteAction	Holds a delegate that is executed when this action is activated.
FGetActionCheck...	GetActionCheckState	Holds a delegate that is executed when determining the check state of this action.
FIsActionButton...	IsActionVisibleDelegate	Holds a delegate that is executed when determining whether this action is visible.
EUIActionRepeat...	RepeatMode	Can this action can be repeated if the chord used to call it is held down?

Constructors

	Name	Description
	FUIAction()	Default constructor.
	FUIAction ( FExecuteAction InitExecuteAction, EUIActionRepeatMode InitRepeatMode )	Constructor that takes delegates to initialize the action with
	FUIAction ( FExecuteAction InitExecuteAction, FCanExecuteAction InitCanExecuteAct..., EUIActionRepeatMode InitRepeatMode )	Constructor that takes delegates to initialize the action with
	FUIAction ( FExecuteAction InitExecuteAction, FCanExecuteAction InitCanExecuteAct..., FIsActionChecked InitIsCheckedDeleg..., EUIActionRepeatMode InitRepeatMode )	Constructor that takes delegates to initialize the action with
	FUIAction ( FExecuteAction InitExecuteAction, FCanExecuteAction InitCanExecuteAct..., FGetActionCheckState InitGetActionC..., EUIActionRepeatMode InitRepeatMode )	Constructor that takes delegates to initialize the action with
	FUIAction ( FExecuteAction InitExecuteAction, FCanExecuteAction InitCanExecuteAct..., FIsActionChecked InitIsCheckedDeleg..., FIsActionButtonVisible InitIsAction..., EUIActionRepeatMode InitRepeatMode )	Constructor that takes delegates to initialize the action with
	FUIAction ( FExecuteAction InitExecuteAction, FCanExecuteAction InitCanExecuteAct..., FGetActionCheckState InitGetActionC..., FIsActionButtonVisible InitIsAction..., EUIActionRepeatMode InitRepeatMode )	Constructor that takes delegates to initialize the action with

Functions

	Name	Description
bool	CanExecute()	Checks to see if its currently safe to execute this action.
bool	CanRepeat()	Checks whether this action can be repeated if the chord used to call it is held down.
bool	Execute()	Executes this action
ECheckBoxSta...	GetCheckState()	Queries the checked state for this action. This is only valid for actions that are toggleable!
ECheckBoxSta...	IsActionCheckedPassthrough ( FIsActionChecked InDelegate )	Passthrough function to convert the result from an FIsActionChecked delegate into something that works with a FGetActionCheckState delegate
bool	IsBound()	Checks whether this action's execution delegate is bound.
EVisibility	IsVisible()	Queries the visibility for this action.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss