Navigation
API > API/Runtime > API/Runtime/Engine
Stack of tags & events used to track context during graph execution.
| Name | FMessageStack |
| Type | struct |
| Header File | /Engine/Source/Runtime/Engine/Public/Animation/AnimNodeMessages.h |
| Include Path | #include "Animation/AnimNodeMessages.h" |
Syntax
struct FMessageStack
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FMessageStack
(
FMessageStack&& InMessageStack |
Animation/AnimNodeMessages.h | ||
| Non-copyable. | Animation/AnimNodeMessages.h | ||
| Animation/AnimNodeMessages.h |
Structs
| Name | Remarks |
|---|---|
| FMessageEntry | Holds a message that has been pushed onto the stack. |
| FNodeInfo | Info about a node. |
Enums
Public
| Name | Remarks |
|---|---|
| EEnumerate | Return value for the various ForEach* enumeration functions. |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FMessageMap | TMap< FName, FMessageStackEntry, TInlineSetAllocator< 8 > > | Animation/AnimNodeMessages.h | |
| FMessageStackEntry | TArray< FMessageEntry, TInlineAllocator< 8 > > | Animation/AnimNodeMessages.h | |
| FTagMap | TMap< FName, FTagStackEntry, TInlineSetAllocator< 4 > > | Animation/AnimNodeMessages.h | |
| FTagStackEntry | TArray< FNodeInfo, TInlineAllocator< 4 > > | Animation/AnimNodeMessages.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| MessageStacks | FMessageMap | Message stack. | Animation/AnimNodeMessages.h | |
| TagStacks | FTagMap | Tag stack. | Animation/AnimNodeMessages.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void CopyForCachedUpdate
(
const FMessageStack& InStack |
Copies the relevant parts of each stack only, ready for cached update. | Animation/AnimNodeMessages.h | |
void ForEachMessage
(
TFunctionRef< EEnumerate(TGraphMessageType&)> InFunction |
Call the supplied function with each node subscribed to the specified message in this stack | Animation/AnimNodeMessages.h | |
void ForEachTag
(
FName InTagId, |
Call the supplied function with each node tagged with the specified tag | Animation/AnimNodeMessages.h | |
bool HasMessage () |
Animation/AnimNodeMessages.h | ||
void MakeEventContextData
(
TArray< TUniquePtr< const IAnimNotifyEventContextDataInterface > >& ContextData |
Call MakeEventContextData for the top entry of each MessageType, returning interfaces for types that return event data | Animation/AnimNodeMessages.h | |
void TopMessage
(
TFunctionRef< void(TGraphMessageType&)> InFunction |
Call the supplied function on the top-most node subscribed to the specified message in this stack | Animation/AnimNodeMessages.h | |
void TopMessageWeakPtr
(
TFunctionRef< void(TWeakPtr< TGraphMessageType >&)> InFunction |
Call the supplied function on the top-most node subscribed to the specified message in this stack | Animation/AnimNodeMessages.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FMessageStack & operator=
(
const FMessageStack& |
Animation/AnimNodeMessages.h | ||
FMessageStack & operator=
(
FMessageStack&& |
Animation/AnimNodeMessages.h |