Navigation
API > API/Runtime > API/Runtime/MessagingCommon > API/Runtime/MessagingCommon/FMessageEndpoint
Overloads
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void Subscribe () |
Template method to subscribe the message endpoint to the specified type of messages with the default message scope. | MessageEndpoint.h | |
void Subscribe
(
const FMessageScopeRange& ScopeRange |
Template method to subscribe the message endpoint to the specified type and scope of messages. | MessageEndpoint.h | |
| Subscribes a message handler. | MessageEndpoint.h | ||
void Subscribe
(
const FTopLevelAssetPath& MessageType, |
Subscribes a message handler. | MessageEndpoint.h |
Subscribe()
Description
Template method to subscribe the message endpoint to the specified type of messages with the default message scope.
The default message scope is all messages excluding loopback messages.
| Name | Subscribe |
| Type | function |
| Header File | /Engine/Source/Runtime/MessagingCommon/Public/MessageEndpoint.h |
| Include Path | #include "MessageEndpoint.h" |
template<class MessageType>
void Subscribe()
Parameters
| Name | Remarks |
|---|---|
| HandlerType | The type of the class handling the message. |
| MessageType | The type of messages to subscribe to. |
| Handler | The class handling the messages. |
| HandlerFunc | The class function handling the messages. |
Subscribe(const FMessageScopeRange &)
Description
Template method to subscribe the message endpoint to the specified type and scope of messages.
| Name | Subscribe |
| Type | function |
| Header File | /Engine/Source/Runtime/MessagingCommon/Public/MessageEndpoint.h |
| Include Path | #include "MessageEndpoint.h" |
template<class MessageType>
void Subscribe
(
const FMessageScopeRange & ScopeRange
)
Parameters
| Name | Remarks |
|---|---|
| HandlerType | The type of the class handling the message. |
| MessageType | The type of messages to subscribe to. |
| Handler | The class handling the messages. |
| HandlerFunc | The class function handling the messages. |
| ScopeRange | The range of message scopes to include in the subscription. |
Subscribe(const FName &, const FMessageScopeRange &)
Description
Subscribes a message handler.
| Name | Subscribe |
| Type | function |
| Header File | /Engine/Source/Runtime/MessagingCommon/Public/MessageEndpoint.h |
| Include Path | #include "MessageEndpoint.h" |
void Subscribe
(
const FName & MessageType,
const FMessageScopeRange & ScopeRange
)
Parameters
| Name | Remarks |
|---|---|
| MessageType | The type name of the messages to subscribe to. |
| ScopeRange | The range of message scopes to include in the subscription. |
Subscribe(const FTopLevelAssetPath &, const FMessageScopeRange &)
Description
Subscribes a message handler.
| Name | Subscribe |
| Type | function |
| Header File | /Engine/Source/Runtime/MessagingCommon/Public/MessageEndpoint.h |
| Include Path | #include "MessageEndpoint.h" |
void Subscribe
(
const FTopLevelAssetPath & MessageType,
const FMessageScopeRange & ScopeRange
)
Parameters
| Name | Remarks |
|---|---|
| MessageType | The type name of the messages to subscribe to. |
| ScopeRange | The range of message scopes to include in the subscription. |