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 > Messaging > IMessageTracer

Light Theme

Dark Theme

IMessageTracer

Interface for message tracers.

Windows

MacOS

Linux

References

Module	Messaging
Header	/Engine/Source/Runtime/Messaging/Public/IMessageTracer.h
Include	#include "IMessageTracer.h"

Syntax

class IMessageTracer

Remarks

Interface for message tracers.

This interface provides access to the message tracer that is built into a message bus. Message tracers are able to monitor and record all activities on a message bus. This includes the sending and receiving of messages, the registering and unregistering of message endpoints and interceptors and adding and removal of subscriptions.

Destructors

	Name	Description
	~IMessageTracer()	Hidden destructor. The life time of a message tracer is managed by the message bus.

Functions

	Name	Description
void	Break()	Breaks message routing.
void	Continue()	Starts the tracer or continues message routing from the current breakpoint.
int32	GetEndpoints ( TArray< TSharedPtr< FMessageTracerE... )	Gets the list of known message endpoints.
int32	GetMessages ( TArray< TSharedPtr< FMessageTracerM... )	Gets the collection of known messages.
int32	GetMessageTypes ( TArray< TSharedPtr< FMessageTracerT... )	Gets the list of known message types filtered by name.
bool	HasMessages()	Checks whether there are any messages in the history.
bool	IsBreaking()	Checks whether the tracer is currently at a breakpoint.
bool	IsRunning()	Checks whether the tracer is currently running.
IMessageTrac...	OnMessageAdded()
IMessageTrac...	OnMessagesReset()
IMessageTrac...	OnTypeAdded()
void	Reset()	Resets the tracer.
void	Step()	Steps the tracer to the next message.
void	Stop()	Stops the tracer.
bool	Tick ( float DeltaTime )	Ticks the tracer.

Classes

	Name	Description
	FOnMessageAdded	A delegate that is executed when the collection of known messages has changed.
	FOnMessagesReset	A delegate that is executed when the message history has been reset.
	FOnTypeAdded	A delegate that is executed when the collection of known messages types has changed.

Typedefs

Name	Description
FMessageTracerMessageInfoRef
FMessageTracerTypeInfoRef

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

Take our survey

Dismiss