Navigation
API > API/Plugins > API/Plugins/AsyncMessageSystem
Represents a single message which can be bound to and queued in the async message system.
This ID is what you use to bind to (listen for) messages which are being broadcast, as well as actually queue the message for broadcasting.
Internally this is simply a FGameplayTag, which is how this Message's parent hierarchy is determined.
| Name | FAsyncMessageId |
| Type | struct |
| Header File | /Engine/Plugins/Experimental/AsyncMessageSystem/Source/AsyncMessageSystem/Public/AsyncMessageId.h |
| Include Path | #include "AsyncMessageId.h" |
Syntax
USTRUCT (BlueprintType )
struct FAsyncMessageId
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| AsyncMessageId.h | |||
FAsyncMessageId
(
const FName MessageName |
Constructs a MessageId from the given FName. | AsyncMessageId.h | |
FAsyncMessageId
(
const FGameplayTag& MessageTag |
Constructs a FAsyncMessageId from the FName associated with the given Gameplay Tag. | AsyncMessageId.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~FAsyncMessageId() |
AsyncMessageId.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| Invalid | const FAsyncMessageId | Represents an invalid message ID which cannot be bound to. | AsyncMessageId.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FName GetMessageName() |
AsyncMessageId.h | ||
| Returns the parent of this async message. | AsyncMessageId.h | ||
bool IsValid() |
AsyncMessageId.h | ||
FString ToString() |
AsyncMessageId.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static void WalkMessageHierarchy
(
const FAsyncMessageId StartingMessage, |
Walks up the parent heirarchy of the given Startingmessage. | AsyncMessageId.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool operator!=
(
const FAsyncMessageId& Other |
AsyncMessageId.h | ||
bool operator==
(
const FAsyncMessageId& Other |
AsyncMessageId.h |