Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > MessagingCommon > FMessageEndpoint > FMessageEndpoint::ReceiveFromInbox

Light Theme

Dark Theme

FMessageEndpoint::ReceiveFromInbox

Receives a single message from the endpoint's inbox.

Windows

MacOS

Linux

References

Module	MessagingCommon
Header	/Engine/Source/Runtime/MessagingCommon/Public/MessageEndpoint.h
Include	#include "MessageEndpoint.h"

Syntax

bool ReceiveFromInbox
(
TSharedPtr< IMessageContext, ESPMode::ThreadSafe > & OutContext
)

Remarks

Receives a single message from the endpoint's inbox.

that an incoming message will only be queued up in the endpoint's inbox if the inbox has been enabled and no matching message handler handled it. The inbox is disabled by default and must be enabled using the EnableInbox() method.

Returns

true if a message was received, false if the inbox was empty.

Parameters

Parameter	Description
OutContext	Will hold the context of the received message.