Navigation
API > API/Runtime > API/Runtime/Core
Message token that performs an action when activated.
| Name | FActionToken |
| Type | class |
| Header File | /Engine/Source/Runtime/Core/Public/Logging/TokenizedMessage.h |
| Include Path | #include "Logging/TokenizedMessage.h" |
Syntax
class FActionToken : public IMessageToken
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FActionToken
(
const FText& InActionName, |
Hidden constructors. | Logging/TokenizedMessage.h | |
FActionToken
(
FPrivateToken, |
Logging/TokenizedMessage.h | ||
FActionToken
(
const FText& InActionName, |
Logging/TokenizedMessage.h | ||
FActionToken
(
FPrivateToken, |
Logging/TokenizedMessage.h |
Structs
| Name | Remarks |
|---|---|
| FPrivateToken | The private token allows only members or friends to call MakeShared. |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ActionDelegate | FOnActionTokenExecuted | Holds a delegate that is executed when this token is activated. | Logging/TokenizedMessage.h | |
| ActionDescription | const FText | The action's description text. | Logging/TokenizedMessage.h | |
| bActionExecuted | bool | If true, the action has been executed already. | Logging/TokenizedMessage.h | |
| bSingleUse | bool | If true, the action can only be performed once. | Logging/TokenizedMessage.h | |
| CanExecuteActionDelegate | FCanExecuteActionToken | Holds a delegate that is executed to know whether this token's action can actually execute. | Logging/TokenizedMessage.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool CanExecuteAction() |
Returns true if the action can be activated | Logging/TokenizedMessage.h | |
void ExecuteAction() |
Executes the assigned action delegate. | Logging/TokenizedMessage.h | |
const FText & GetActionDescription() |
Gets the action's description text. | Logging/TokenizedMessage.h | |
bool IsValidAction() |
Returns true if the action is properly set | Logging/TokenizedMessage.h |
Overridden from IMessageToken
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual EMessageToken::Type GetType() |
Get the type of this message token | Logging/TokenizedMessage.h |
Protected
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static TSharedRef< FActionToken > Create
(
const FText& InActionName, |
Factory methods, tokens can only be constructed as shared refs | Logging/TokenizedMessage.h | |
static TSharedRef< FActionToken > Create
(
const FText& InActionName, |
Logging/TokenizedMessage.h |