FActionToken Class Reference

#include <TokenizedMessage.h>

Inheritance diagram for FActionToken:

Public Member Functions
void	ExecuteAction ()
const FText &	GetActionDescription ()
bool	CanExecuteAction () const
bool	IsValidAction () const
virtual EMessageToken::Type	GetType () const override
	FActionToken (FPrivateToken, const FText &InActionName, const FText &InActionDescription, const FOnActionTokenExecuted &InAction, bool bInSingleUse)
	FActionToken (FPrivateToken, const FText &InActionName, const FText &InActionDescription, const FOnActionTokenExecuted &InAction, const FCanExecuteActionToken &InCanExecuteAction, bool bInSingleUse)
Public Member Functions inherited from IMessageToken
virtual	~IMessageToken ()
virtual const FText &	ToText () const
virtual const FOnMessageTokenActivated &	GetOnMessageTokenActivated () const
virtual TSharedRef< IMessageToken >	OnMessageTokenActivated (FOnMessageTokenActivated InMessageTokenActivated)
Public Member Functions inherited from TSharedFromThis< IMessageToken >
TSharedRef< IMessageToken, Mode >	AsShared ()
TSharedRef< IMessageToken const, Mode >	AsShared () const
TSharedRef< SubobjectType, Mode >	AsSharedSubobject (SubobjectType *SubobjectPtr) const
TWeakPtr< IMessageToken, Mode >	AsWeak ()
TWeakPtr< IMessageToken const, Mode >	AsWeak () const
TWeakPtr< SubobjectType, Mode >	AsWeakSubobject (SubobjectType *SubobjectPtr) const
void	UpdateWeakReferenceInternal (TSharedPtr< SharedPtrType, SharedPtrMode > const *InSharedPtr, OtherType *InObject) const
void	UpdateWeakReferenceInternal (TSharedRef< SharedRefType, SharedPtrMode > const *InSharedRef, OtherType *InObject) const
UE_FORCEINLINE_HINT bool	DoesSharedInstanceExist () const

Static Public Member Functions
static CORE_API TSharedRef< FActionToken >	Create (const FText &InActionName, const FText &InActionDescription, const FOnActionTokenExecuted &InAction, bool bInSingleUse=false)
static CORE_API TSharedRef< FActionToken >	Create (const FText &InActionName, const FText &InActionDescription, const FOnActionTokenExecuted &InAction, const FCanExecuteActionToken &InCanExecuteAction, bool bInSingleUse=false)

Protected Member Functions
	FActionToken (const FText &InActionName, const FText &InActionDescription, const FOnActionTokenExecuted &InAction, bool bInSingleUse)
	FActionToken (const FText &InActionName, const FText &InActionDescription, const FOnActionTokenExecuted &InAction, const FCanExecuteActionToken &InCanExecuteAction, bool bInSingleUse)
Protected Member Functions inherited from TSharedFromThis< IMessageToken >
	TSharedFromThis ()
	TSharedFromThis (TSharedFromThis const &)
UE_FORCEINLINE_HINT TSharedFromThis &	operator= (TSharedFromThis const &)
	~TSharedFromThis ()

Additional Inherited Members
Static Protected Member Functions inherited from TSharedFromThis< IMessageToken >
static UE_FORCEINLINE_HINT TSharedRef< OtherType, Mode >	SharedThis (OtherType *ThisPtr)
static UE_FORCEINLINE_HINT TSharedRef< OtherType const, Mode >	SharedThis (const OtherType *ThisPtr)
Protected Attributes inherited from IMessageToken
FOnMessageTokenActivated	MessageTokenActivated
FText	CachedText

Detailed Description

Message token that performs an action when activated.

Constructor & Destructor Documentation

FActionToken() [1/4]

FActionToken::FActionToken ( FPrivateToken  , const FText &  InActionName, const FText &  InActionDescription, const FOnActionTokenExecuted &  InAction, bool  bInSingleUse  )

inline

FActionToken() [2/4]

FActionToken::FActionToken ( FPrivateToken  , const FText &  InActionName, const FText &  InActionDescription, const FOnActionTokenExecuted &  InAction, const FCanExecuteActionToken &  InCanExecuteAction, bool  bInSingleUse  )

inline

FActionToken() [3/4]

FActionToken::FActionToken ( const FText &  InActionName, const FText &  InActionDescription, const FOnActionTokenExecuted &  InAction, bool  bInSingleUse  )

inlineprotected

Hidden constructors.

FActionToken() [4/4]

FActionToken::FActionToken ( const FText &  InActionName, const FText &  InActionDescription, const FOnActionTokenExecuted &  InAction, const FCanExecuteActionToken &  InCanExecuteAction, bool  bInSingleUse  )

inlineprotected

Member Function Documentation

CanExecuteAction()

bool FActionToken::CanExecuteAction ( ) const

inline

Returns true if the action can be activated

Create() [1/2]

TSharedRef< FActionToken > FActionToken::Create ( const FText &  InActionName, const FText &  InActionDescription, const FOnActionTokenExecuted &  InAction, bool  bInSingleUse = false  )

static

Factory methods, tokens can only be constructed as shared refs

Create() [2/2]

TSharedRef< FActionToken > FActionToken::Create ( const FText &  InActionName, const FText &  InActionDescription, const FOnActionTokenExecuted &  InAction, const FCanExecuteActionToken &  InCanExecuteAction, bool  bInSingleUse = false  )

static

ExecuteAction()

void FActionToken::ExecuteAction ( )

inline

Executes the assigned action delegate.

GetActionDescription()

const FText & FActionToken::GetActionDescription ( )

inline

Gets the action's description text.

GetType()

virtual EMessageToken::Type FActionToken::GetType ( ) const

inlineoverridevirtual

Get the type of this message token

Returns

the type of the token

Implements IMessageToken.

IsValidAction()

bool FActionToken::IsValidAction ( ) const

inline

Returns true if the action is properly set

---

The documentation for this class was generated from the following files:

• Engine/Source/Runtime/Core/Public/Logging/TokenizedMessage.h
• Engine/Source/Runtime/Core/Private/Logging/TokenizedMessage.cpp