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

Light Theme

Dark Theme

FMessageEndpointBuilder

Implements a message endpoint builder.

Windows

MacOS

Linux

References

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

Syntax

struct FMessageEndpointBuilder

Remarks

Implements a message endpoint builder.

Constructors

	Name	Description
	FMessageEndpointBuilder ( const FName& InName )	Creates and initializes a new builder using the default message bus.
	FMessageEndpointBuilder ( const FName& InName, const TSharedRef< IMessageBus, ESPM... )	Creates and initializes a new builder using the specified message bus.

Functions

	Name	Description
TSharedPtr< ...	Build()	Builds the message endpoint as configured.
FMessageEndp...	Handling ( typename TFunctionMessageHandler< M... )	Adds a message handler for the given type of messages (via TFunction object).
FMessageEndp...	Handling ( HandlerType* Handler, typename TRawMessageHandler< Messag... )	Adds a message handler for the given type of messages (via raw function pointers).
FMessageEndp...	NotificationHandling ( FOnBusNotification&& InHandler )
FMessageEndp...	ReceivingOnAnyThread()	Configures the endpoint to receive messages on any thread.
FMessageEndp...	ReceivingOnThread ( ENamedThreads::Type NamedThread )	Configured the endpoint to receive messages on a specific thread.
FMessageEndp...	ThatIsDisabled()	Disables the endpoint.
FMessageEndp...	WithCatchall ( FFunctionMessageCatchall::FuncType ... )	Adds a message handler for the given type of messages (via TFunction object).
FMessageEndp...	WithCatchall ( HandlerType* Handler, typename TRawMessageCatchall< Handl... )	Adds a message handler for the given type of messages (via raw function pointers).
FMessageEndp...	WithHandler ( const TSharedRef< IMessageHandler, ... )	Registers a message handler with the endpoint.
FMessageEndp...	WithInbox()	Enables the endpoint's message inbox. The inbox is disabled by default.

Operators

		Name	Description
		operator TSharedPtr< FMessageEndpoint, ESPMode::ThreadSafe >()	Implicit conversion operator to build the message endpoint as configured.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss