description: Intercept

code: void Unintercept ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IMessageInterceptor](API\Runtime\Messaging\IMessageInterceptor), ESPMode::ThreadSafe > & Interceptor, const [FTopLevelAssetPath](API\Runtime\CoreUObject\UObject\FTopLevelAssetPath) & MessageType )


description: Register

module: Messaging

code: void Unregister ( const [FMessageAddress](API\Runtime\Messaging\FMessageAddress) & Address )


description: Subscribe

code: virtual void Unsubscribe ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IMessageReceiver](API\Runtime\Messaging\IMessageReceiver), ESPMode::ThreadSafe > & Subscriber, const [FName](API\Runtime\Core\UObject\FName) & MessageType )


description: Subscribe

code: void Unsubscribe ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IMessageReceiver](API\Runtime\Messaging\IMessageReceiver), ESPMode::ThreadSafe > & Subscriber, const [FTopLevelAssetPath](API\Runtime\CoreUObject\UObject\FTopLevelAssetPath) & MessageType )


description: Virtual destructor.

code: virtual ~IMessageBus()


className: IMessageBus

description: IMessageSender

code: class IMessageBus


description:
Gets the optional message annotations.
Message header collection.

code: const [TMap](API\Runtime\Core\Containers\TMap)< [FName](API\Runtime\Core\UObject\FName), [FString](API\Runtime\Core\Containers\FString) > & GetAnnotations() const


description:
Gets the message attachment, if present.
A pointer to the message attachment, or nullptr if no attachment is present.

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IMessageAttachment](API\Runtime\Messaging\IMessageAttachment), ESPMode::ThreadSafe > GetAttachment() const


description:
Gets the date and time at which the message expires.
Expiration time.

code: const [FDateTime](API\Runtime\Core\Misc\FDateTime) & GetExpiration() const


description:
Gets the scope to which the message was sent.
The message scope.

code: EMessageFlags GetFlags() const


description: GetSenderThread

code: const [FMessageAddress](API\Runtime\Messaging\FMessageAddress) & GetForwarder() const


description: GetMessageTypeInfo

code: const void * GetMessage() const


description: GetMessageTypeInfo


description: GetMessageType

code: const [TWeakObjectPtr](API\Runtime\Core\UObject\TWeakObjectPtr)< [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) > & GetMessageTypeInfo() const


description:
Returns the original message context in case the message was forwarded.
The original message context, or nullptr if the message wasn't forwarded.

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IMessageContext](API\Runtime\Messaging\IMessageContext), ESPMode::ThreadSafe > GetOriginalContext() const


description: GetSender

code: const [TArray](API\Runtime\Core\Containers\TArray)< [FMessageAddress](API\Runtime\Messaging\FMessageAddress) > & GetRecipients() const


code: EMessageScope GetScope() const


description: GetSenderThread

code: const [FMessageAddress](API\Runtime\Messaging\FMessageAddress) & GetSender() const


description: GetSender


description: IsForwarded

code: const [FDateTime](API\Runtime\Core\Misc\FDateTime) & GetTimeForwarded() const


description: GetTimeForwarded

code: const [FDateTime](API\Runtime\Core\Misc\FDateTime) & GetTimeSent() const


description: IsValid

code: bool IsForwarded() const


className: IMessageContext

description: IMessageAttachment

code: class IMessageContext


description: IsForwarded

code: bool IsValid() const


description: Virtual destructor.

code: virtual ~IMessageContext()


description: Virtual destructor.

code: virtual ~IMessageHandler()


description: Handles the specified message.

code: void HandleMessage ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IMessageContext](API\Runtime\Messaging\IMessageContext), ESPMode::ThreadSafe > & Context )


description: GetInterceptorId


className: IMessageHandler

description: Interface for message handlers.

code: class IMessageHandler


description: GetDebugName

code: const [FGuid](API\Runtime\Core\Misc\FGuid) & GetInterceptorId() const


description:
Intercepts a message before it is being passed to the message router.
true if the message was intercepted and should not be routed, false otherwise.

code: bool InterceptMessage ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IMessageContext](API\Runtime\Messaging\IMessageContext), ESPMode::ThreadSafe > & Context )


description: Virtual destructor.

code: virtual ~IMessageInterceptor()


className: IMessageInterceptor

description: Interface for message interceptors.

code: class IMessageInterceptor


description: GetRecipientThread


description: GetRecipientThread

code: const [FGuid](API\Runtime\Core\Misc\FGuid) & GetRecipientId() const


description: GetRecipientId


description: IsRemote

code: bool IsLocal() const


description: IsLocal

code: bool IsRemote() const


description: Handles the given message.

code: void ReceiveMessage ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IMessageContext](API\Runtime\Messaging\IMessageContext), ESPMode::ThreadSafe > & Context )


className: IMessageReceiver

description: IMessageSender

code: class IMessageReceiver


description: Notifies the sender of errors.

code: void NotifyMessageError ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IMessageContext](API\Runtime\Messaging\IMessageContext), ESPMode::ThreadSafe > & Context, const [FString](API\Runtime\Core\Containers\FString) & Error )


description: Virtual destructor.

code: virtual ~IMessageReceiver()


description:
Gets the sender's address.
The message address.


className: IMessageSender

description: IMessageReceiver

code: class IMessageSender


description: Virtual destructor.

code: virtual ~IMessageSender()


description: IsEnabled

code: void Enable()


description: IsEnabled

code: void Disable()


description: GetScopeRange

code: const [TWeakPtr](API\Runtime\Core\Templates\TWeakPtr)< [IMessageReceiver](API\Runtime\Messaging\IMessageReceiver), ESPMode::ThreadSafe > & GetSubscriber()


description: GetSubscriber


description: Disable

code: bool IsEnabled()


description: GetSubscriber

code: const [TRange](API\Runtime\Core\Math\TRange)< EMessageScope > & GetScopeRange()


description: Virtual destructor.

code: virtual ~IMessageSubscription()


description: Step

code: void Continue()


description: Step

code: void Break()


className: IMessageSubscription

description: A subscription that is disabled will cause a message endpoint to stop receiving messages for the subscribed message type. However, the subscription is merely disabled and not removed.

code: class IMessageSubscription


className: FMessageTracerTypeInfoRef

code: typedef [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FMessageTracerTypeInfo](API\Runtime\Messaging\FMessageTracerTypeInfo) > FMessageTracerTypeInfoRef


className: FOnMessageAdded

description: A delegate that is executed when the collection of known messages has changed.

code: class FOnMessageAdded : public TBaseMulticastDelegate_OneParam< void, FMessageTracerMessageInfoRef >


className: FOnMessagesReset

description: A delegate that is executed when the message history has been reset.

code: class FOnMessagesReset : public TBaseMulticastDelegate_NoParams< void >


className: FOnTypeAdded

description: A delegate that is executed when the collection of known messages types has changed.

code: class FOnTypeAdded : public TBaseMulticastDelegate_OneParam< void, FMessageTracerTypeInfoRef >


description:
Gets the collection of known messages.
The messages.

code: int32 GetMessages ( [TArray](API\Runtime\Core\Containers\TArray)< [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FMessageTracerMessageInfo](API\Runtime\Messaging\FMessageTracerMessageInfo) >> & OutMessages ) const


description:
Gets the list of known message endpoints.
The number of endpoints returned.

code: int32 GetEndpoints ( [TArray](API\Runtime\Core\Containers\TArray)< [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FMessageTracerEndpointInfo](API\Runtime\Messaging\FMessageTracerEndpointInfo) >> & OutEndpoints ) const


description:
Gets the list of known message types filtered by name.
The number of message types returned.

code: int32 GetMessageTypes ( [TArray](API\Runtime\Core\Containers\TArray)< [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FMessageTracerTypeInfo](API\Runtime\Messaging\FMessageTracerTypeInfo) >> & OutTypes ) const


description:
Checks whether there are any messages in the history.
true if there are messages, false otherwise.

code: bool HasMessages() const


description: IsRunning

code: bool IsBreaking() const


description: Stop

code: bool IsRunning() const


description: Resets the tracer.

code: void Reset()


description: Stop

code: void Step()


description: Step

code: void Stop()


description:
Ticks the tracer.
true if any events were processed.

code: bool Tick ( float DeltaTime )


description: Hidden destructor. The life time of a message tracer is managed by the message bus.

code: virtual ~IMessageTracer()


className: IMessageTracer

description: 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.

code: class IMessageTracer


description:
Checks whether this breakpoint is enabled.
true if the breakpoint is enabled, false otherwise.

code: bool IsEnabled() const


description:
Checks whether the tracer should break on the given message.
true if the tracer should break, false otherwise.

code: bool ShouldBreak ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IMessageContext](API\Runtime\Messaging\IMessageContext), ESPMode::ThreadSafe > & Context ) const


description: Hidden destructor.

code: virtual ~IMessageTracerBreakpoint()


className: IMessageTracerBreakpoint

description: IMessageTracer

code: class IMessageTracerBreakpoint


description:
Gets the name of this transport (for debugging purposes).
The debug name.


description: StopTransport

code: bool StartTransport ( [IMessageTransportHandler](API\Runtime\Messaging\IMessageTransportHandler) & Handler )


description: StartTransport

code: void StopTransport()


description:
Transports the given message data to the specified network nodes.
true if the message is being transported, false otherwise.

code: bool TransportMessage ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IMessageContext](API\Runtime\Messaging\IMessageContext), ESPMode::ThreadSafe > & Context, const [TArray](API\Runtime\Core\Containers\TArray)< [FGuid](API\Runtime\Core\Misc\FGuid) > & Recipients )


description: Virtual destructor.

code: virtual ~IMessageTransport()


className: IMessageTransport

description: Licensees can implement this interface to add support for custom message transport technologies that are not supported out of the box, i.e. custom network protocols or APIs.

code: class IMessageTransport


description: ForgetTransportNode

code: void DiscoverTransportNode ( const [FGuid](API\Runtime\Core\Misc\FGuid) & NodeId )


description: DiscoverTransportNode

code: void ForgetTransportNode ( const [FGuid](API\Runtime\Core\Misc\FGuid) & NodeId )


description: Called by message transports when a message was received.

code: void ReceiveTransportMessage ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IMessageContext](API\Runtime\Messaging\IMessageContext), ESPMode::ThreadSafe > & Context, const [FGuid](API\Runtime\Core\Misc\FGuid) & NodeId )


description: Virtual destructor.

code: virtual ~IMessageTransportHandler()


className: IMessageTransportHandler

description: IMessageTransport

code: class IMessageTransportHandler


description: CreateBus

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IMessageBridge](API\Runtime\Messaging\IMessageBridge), ESPMode::ThreadSafe > CreateBridge ( const [FMessageAddress](API\Runtime\Messaging\FMessageAddress) & Address, const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IMessageBus](API\Runtime\Messaging\IMessageBus), ESPMode::ThreadSafe > & Bus, const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IMessageTransport](API\Runtime\Messaging\IMessageTransport), ESPMode::ThreadSafe > & Transport )


description: CreateBridge

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IMessageBus](API\Runtime\Messaging\IMessageBus), ESPMode::ThreadSafe > CreateBus ( [FString](API\Runtime\Core\Containers\FString) InName, const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IAuthorizeMessageRecipients](API\Runtime\Messaging\IAuthorizeMessageRecipients) > & RecipientAuthorizer )


description: CreateBridge

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IMessageBus](API\Runtime\Messaging\IMessageBus), ESPMode::ThreadSafe > CreateBus ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IAuthorizeMessageRecipients](API\Runtime\Messaging\IAuthorizeMessageRecipients) > & RecipientAuthorizer )


className: FMessageBusWeakPtr

code: typedef [TWeakPtr](API\Runtime\Core\Templates\TWeakPtr)< [IMessageBus](API\Runtime\Messaging\IMessageBus), ESPMode::ThreadSafe > FMessageBusWeakPtr


className: FOnMessageBusStartupOrShutdown

code: typedef TMulticastDelegate_OneParam< void, [FMessageBusWeakPtr](API\Runtime\Core\Templates\TWeakPtr) > FOnMessageBusStartupOrShutdown


description:
Gets a reference to the messaging module instance.
A reference to the Messaging module.

code: static [IMessagingModule](API\Runtime\Messaging\IMessagingModule) & Get()


description:
Gets all message buses that were created by this module via theCreateBusmethod that are still valid.
All message buses.

code: [TArray](API\Runtime\Core\Containers\TArray)< [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IMessageBus](API\Runtime\Messaging\IMessageBus), ESPMode::ThreadSafe > > GetAllBuses() const


description:
Gets the default message bus if it has been initialized.
The default bus.

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IMessageBus](API\Runtime\Messaging\IMessageBus), ESPMode::ThreadSafe > GetDefaultBus() const


description: Event triggered when a message bus is shutdown.


description: Event triggered when a message bus is started.


description: Virtual destructor.

code: virtual ~IMessagingModule()


className: IMessagingModule

description: IMessageBus

code: class IMessagingModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface)


description: Sets the optional message attachment.

code: void SetAttachment ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IMessageAttachment](API\Runtime\Messaging\IMessageAttachment), ESPMode::ThreadSafe > & InAttachment )


description: Adds a message address to the recipient list.

code: void AddRecipient ( const [FMessageAddress](API\Runtime\Messaging\FMessageAddress) & Recipient )


description: Sets the date and time at which the message expires.

code: void SetExpiration ( const [FDateTime](API\Runtime\Core\Misc\FDateTime) & InExpiration )


description: Sets the value of the header with the specified key.

code: void SetHeader ( const [FName](API\Runtime\Core\UObject\FName) & Key, const [FString](API\Runtime\Core\Containers\FString) & Value )


description: Sets the message.

code: void SetMessage ( void * InMessage, [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * InTypeInfo )


description: Sets the message scope.

code: void SetScope ( EMessageScope InScope )


description: Sets the address of the message's sender.

code: void SetSender ( const [FMessageAddress](API\Runtime\Messaging\FMessageAddress) & InSender )


description: Sets the date and time at which the message was sent.

code: void SetTimeSent ( const [FDateTime](API\Runtime\Core\Misc\FDateTime) & InTimeSent )


description: Virtual destructor.

code: virtual ~IMutableMessageContext()


className: IMutableMessageContext

description: Interface for mutable message contexts.

code: class IMutableMessageContext : public [IMessageContext](API\Runtime\Messaging\IMessageContext)


description: Add an endpoint to the running configuration of this messaging service This change is transient and does not modified saved configuration.

code: void AddEndpoint ( const [FString](API\Runtime\Core\Containers\FString) & InEndpoint )


description: Indicates if this network messaging interface can return network statistics.


description: Returns the list of internet addresses known by the transport. The addresses are in the form of

code: [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > GetKnownEndpoints() const


description: Return the current network counters for the given Node endpoint

code: [FMessageTransportStatistics](API\Runtime\Messaging\FMessageTransportStatistics) GetLatestNetworkStatistics ( [FGuid](API\Runtime\Core\Misc\FGuid) NodeId ) const


description: The list of network addresses that we are currently listening on. The string must be in the form of

code: [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > GetListeningAddresses() const


description: Get the name of this messaging extension.


description: Return the node ID corresponding to MessageAddress

code: [FGuid](API\Runtime\Core\Misc\FGuid) GetNodeIdFromAddress ( const [FMessageAddress](API\Runtime\Messaging\FMessageAddress) & MessageAddress ) const


description:
Indicate if support is available for this extension
true if the service can be successfully started.

code: bool IsSupportEnabled() const


className: ModularFeatureName

description: The modular feature name to get the messaging extension.


description: Delegate invoked when any transmission statistics are update for inbound (received). This delegate may get called from another thread. Please consider thread safety when receiving this delegate.


description: Delegate invoked when any transmission statistics are updated for outbound nodes (sent). This delegate may get called from another thread. Please consider thread safety when receiving this delegate.


description: Remove a static endpoint from the running configuration of the UDP messaging service This change is transient and does not modified saved configuration.

code: void RemoveEndpoint ( const [FString](API\Runtime\Core\Containers\FString) & InEndpoint )


description: RemoveEndpoint

code: void RestartServices()


className: INetworkMessagingExtension

description: Interface for the messaging module network extension Plugins or modules implementing messaging transport for MessageBus can implement this modular feature to provide control on the service it provides.

code: class INetworkMessagingExtension : public [IModularFeature](API\Runtime\Core\Features\IModularFeature)


description: RestartServices

code: void ShutdownServices()


description:
The caller is responsible for deleting the returned object.
An archive reader.

module: MessagingCommon

code: virtual [FArchive](API\Runtime\Core\Serialization\FArchive) * CreateReader()


description: Creates and initializes a new instance.

code: FFileMessageAttachment ( const [FString](API\Runtime\Core\Containers\FString) & InFilename )


description: Creates and initializes a new instance.

code: FFileMessageAttachment ( const [FString](API\Runtime\Core\Containers\FString) & InFilename, bool InAutoDeleteFile )


description: Destructor.

code: ~FFileMessageAttachment()


className: FFileMessageAttachment

description: WARNING: Message attachments do not work yet for out of process messages.

code: class FFileMessageAttachment : public [IMessageAttachment](API\Runtime\Messaging\IMessageAttachment)


className: FuncType

description: Type definition for function objects that are compatible with thisTFunctionMessageHandler.

code: typedef [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void(const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IMessageContext](API\Runtime\Messaging\IMessageContext), ESPMode::ThreadSafe > &)> FuncType


description: Handles the specified message.

code: virtual void HandleMessage ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IMessageContext](API\Runtime\Messaging\IMessageContext), ESPMode::ThreadSafe > & Context )


description: Creates and initializes a new message handler.

code: FFunctionMessageCatchall ( [FuncType](API\Runtime\MessagingCommon\FFunctionMessageCatchall\FuncType) InFunc )


description: Virtual destructor.

code: ~FFunctionMessageCatchall()


className: FFunctionMessageCatchall

description: Implements a catch-all handlers (via function objects).

code: class FFunctionMessageCatchall : public [IMessageHandler](API\Runtime\Messaging\IMessageHandler)


description:
Builds the message bridge as configured.
A new message bridge, or nullptr if it couldn't be built.

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IMessageBridge](API\Runtime\Messaging\IMessageBridge), ESPMode::ThreadSafe > Build()


className: FMessageBridgeBuilder::operator TSharedPtr< IMessageBridge, ESPMode::ThreadSafe >

description:
Implicit conversion operator to build the message bridge as configured.
A new message bridge, or nullptr if it couldn't be built.

code: namespace operator TSharedPtr< IMessageBridge, ESPMode { operator TSharedPtr< IMessageBridge, ESPMode::ThreadSafe >() }


description:
Configures the bridge to use a specific message transport technology.
This instance (for method chaining).

code: [FMessageBridgeBuilder](API\Runtime\MessagingCommon\FMessageBridgeBuilder) & UsingTransport ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IMessageTransport](API\Runtime\Messaging\IMessageTransport), ESPMode::ThreadSafe > & InTransport )


description:
Disables the bridge.
This instance (for method chaining).


description:
If no address is specified, one will be generated automatically.
This instance (for method chaining).

code: [FMessageBridgeBuilder](API\Runtime\MessagingCommon\FMessageBridgeBuilder) & WithAddress ( const [FMessageAddress](API\Runtime\Messaging\FMessageAddress) & InAddress )


description: Default constructor.

code: FMessageBridgeBuilder()


className: FMessageBridgeBuilder

description: Implements a message bridge builder.

code: class FMessageBridgeBuilder


description: Creates and initializes a new instance.

code: FMessageBridgeBuilder ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IMessageBus](API\Runtime\Messaging\IMessageBus), ESPMode::ThreadSafe > & Bus )


className: FMessageBusNotification

description: Struct to propagate message bus notifications

code: struct FMessageBusNotification

NotificationType

type: EMessageBusNoti...

description: Notification type.

RegistrationAddress

type: FMessageAddress

description: Address of the un/registered.


className: Builder

description: When building message endpoints that receive messages on AnyThread, use the SafeRelease helper function to avoid race conditions when destroying the objects that own the endpoints.

code: typedef struct [FMessageEndpointBuilder](API\Runtime\MessagingCommon\FMessageEndpointBuilder) Builder


description: The message is effectively delivered again to this endpoint after the original sent time plus the time delay have elapsed.

code: void Defer ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IMessageContext](API\Runtime\Messaging\IMessageContext), ESPMode::ThreadSafe > & Context, const [FTimespan](API\Runtime\Core\Misc\FTimespan) & Delay )


description: Clears all handlers in a way that guarantees it won't overlap with message processing. This preserves internal integrity of the array and cases where our owner may be shutting down while receiving messages.

code: void ClearHandlers()


description: IsEnabled

code: void Disable()


description: ReceiveFromInbox

code: void DisableInbox()


description: IsEnabled

code: void Enable()


description: ReceiveFromInbox

code: void EnableInbox()


description: Messages can only be forwarded to endpoints within the same process.

code: void Forward ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IMessageContext](API\Runtime\Messaging\IMessageContext), ESPMode::ThreadSafe > & Context, const [FMessageAddress](API\Runtime\Messaging\FMessageAddress) & Recipient )


code: void Forward ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IMessageContext](API\Runtime\Messaging\IMessageContext), ESPMode::ThreadSafe > & Context, const [TArray](API\Runtime\Core\Containers\TArray)< [FMessageAddress](API\Runtime\Messaging\FMessageAddress) > & Recipients )


code: void Forward ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IMessageContext](API\Runtime\Messaging\IMessageContext), ESPMode::ThreadSafe > & Context, const [TArray](API\Runtime\Core\Containers\TArray)< [FMessageAddress](API\Runtime\Messaging\FMessageAddress) > & Recipients, const [FTimespan](API\Runtime\Core\Misc\FTimespan) & Delay )


code: void Forward ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IMessageContext](API\Runtime\Messaging\IMessageContext), ESPMode::ThreadSafe > & Context, const [FMessageAddress](API\Runtime\Messaging\FMessageAddress) & Recipient, const [FTimespan](API\Runtime\Core\Misc\FTimespan) & Delay )


description:
Gets the endpoint's message address.
Message address.

code: const [FMessageAddress](API\Runtime\Messaging\FMessageAddress) & GetAddress() const


description: GetRecipientThread

code: virtual [FName](API\Runtime\Core\UObject\FName) GetDebugName() const


description:
If the listener's Notify[*] methods are thread-safe, return ThreadAny for best performance.
Name of the listener thread.

code: virtual [ENamedThreads::Type](API\Runtime\Core\Async\ENamedThreads__Type) GetListenerThread() const


description: GetRecipientThread

code: virtual const [FGuid](API\Runtime\Core\Misc\FGuid) & GetRecipientId() const


description: GetRecipientId

code: virtual [ENamedThreads::Type](API\Runtime\Core\Async\ENamedThreads__Type) GetRecipientThread() const


description:
Gets the sender's address.
The message address.


description: IsEnabled

code: bool IsConnected() const


description: IsConnected

code: bool IsEnabled() const


description: ReceiveFromInbox

code: bool IsInboxEmpty() const


description: ReceiveFromInbox

code: bool IsInboxEnabled() const


description: IsRemote

code: virtual bool IsLocal() const


description: Prefer using this helper rather than explicit new. SeeFEngineServicePong.

code: template<typename T, typename... InArgTypes> static T * MakeMessage ( InArgTypes &&... Args )


description: Notifies the sender of errors.

code: virtual void NotifyMessageError ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IMessageContext](API\Runtime\Messaging\IMessageContext), ESPMode::ThreadSafe > & Context, const [FString](API\Runtime\Core\Containers\FString) & Error )


description: Notify a registration event from the bus This is called when a receiver is registered or unregistered from the bus.

code: virtual void NotifyRegistration ( const [FMessageAddress](API\Runtime\Messaging\FMessageAddress) & Address, EMessageBusNotification Notification )


description: ReceiveFromInbox

code: void ProcessInbox()


description: Forwards the given message context to matching message handlers.

code: void ProcessMessage ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IMessageContext](API\Runtime\Messaging\IMessageContext), ESPMode::ThreadSafe > & Context )


description:
Gets a shared pointer to the message bus if this endpoint is enabled.
The message bus.

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IMessageBus](API\Runtime\Messaging\IMessageBus), ESPMode::ThreadSafe > GetBusIfEnabled() const


description: Immediately publishes a message to all subscribed recipients.

code: template<typename MessageType> void Publish ( MessageType * Message )


description: Publishes a message to all subscribed recipients within the specified scope.

code: void Publish ( void * Message, [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * TypeInfo, EMessageScope Scope, const [TMap](API\Runtime\Core\Containers\TMap)< [FName](API\Runtime\Core\UObject\FName), [FString](API\Runtime\Core\Containers\FString) > Annotations, const [FTimespan](API\Runtime\Core\Misc\FTimespan) & Delay, const [FDateTime](API\Runtime\Core\Misc\FDateTime) & Expiration )


description: Immediately pa message to all subscribed recipients within the specified scope.

code: template<typename MessageType> void Publish ( MessageType * Message, EMessageScope Scope )


code: template<typename MessageType> void Publish ( MessageType * Message, const [TMap](API\Runtime\Core\Containers\TMap)< [FName](API\Runtime\Core\UObject\FName), [FString](API\Runtime\Core\Containers\FString) > Annotations )


description: Publishes a message to all subscribed recipients after a given delay.

code: template<typename MessageType> void Publish ( MessageType * Message, const [FTimespan](API\Runtime\Core\Misc\FTimespan) & Delay )


code: template<typename MessageType> void Publish ( MessageType * Message, const [TMap](API\Runtime\Core\Containers\TMap)< [FName](API\Runtime\Core\UObject\FName), [FString](API\Runtime\Core\Containers\FString) > Annotations, EMessageScope Scope )


description: Publishes a message to all subscribed recipients within the specified scope after a given delay.

code: template<typename MessageType> void Publish ( MessageType * Message, EMessageScope Scope, const [FTimespan](API\Runtime\Core\Misc\FTimespan) & Delay )


code: template<typename MessageType> void Publish ( MessageType * Message, EMessageScope Scope, const [FTimespan](API\Runtime\Core\Misc\FTimespan) & Delay, const [FDateTime](API\Runtime\Core\Misc\FDateTime) & Expiration )


code: void Publish ( void * Message, [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * TypeInfo, EMessageScope Scope, const [FTimespan](API\Runtime\Core\Misc\FTimespan) & Delay, const [FDateTime](API\Runtime\Core\Misc\FDateTime) & Expiration )


code: template<typename MessageType> void Publish ( MessageType * Message, const [TMap](API\Runtime\Core\Containers\TMap)< [FName](API\Runtime\Core\UObject\FName), [FString](API\Runtime\Core\Containers\FString) > Annotations, EMessageScope Scope, const [FTimespan](API\Runtime\Core\Misc\FTimespan) & Delay, const [FDateTime](API\Runtime\Core\Misc\FDateTime) & Expiration )


description: ProcessInbox

code: bool ReceiveFromInbox ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IMessageContext](API\Runtime\Messaging\IMessageContext), ESPMode::ThreadSafe > & OutContext )


description: Handles the given message.

code: virtual void ReceiveMessage ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IMessageContext](API\Runtime\Messaging\IMessageContext), ESPMode::ThreadSafe > & Context )


description: When an object that owns a message endpoint receiving on AnyThread is being destroyed, it is possible that the endpoint can outlive the object for a brief period of time if the Messaging system is dispatching messages to it. This helper function is to block the calling thread while any messages are being dispatched, so that the endpoint does not invoke any message handlers after the object has been destroyed.

code: static void SafeRelease ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FMessageEndpoint](API\Runtime\MessagingCommon\FMessageEndpoint), ESPMode::ThreadSafe > & Endpoint )


description: Immediately sends a message to the specified recipient.

code: template<typename MessageType> void Send ( MessageType * Message, const [FMessageAddress](API\Runtime\Messaging\FMessageAddress) & Recipient )


description: Sends a message to the specified list of recipients.

code: template<typename MessageType> void Send ( MessageType * Message, const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IMessageAttachment](API\Runtime\Messaging\IMessageAttachment), ESPMode::ThreadSafe > & Attachment, const [TArray](API\Runtime\Core\Containers\TArray)< [FMessageAddress](API\Runtime\Messaging\FMessageAddress) > & Recipients, const [FTimespan](API\Runtime\Core\Misc\FTimespan) & Delay, const [FDateTime](API\Runtime\Core\Misc\FDateTime) & Expiration )


code: void Send ( void * Message, [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * TypeInfo, const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IMessageAttachment](API\Runtime\Messaging\IMessageAttachment), ESPMode::ThreadSafe > & Attachment, const [TArray](API\Runtime\Core\Containers\TArray)< [FMessageAddress](API\Runtime\Messaging\FMessageAddress) > & Recipients, const [FTimespan](API\Runtime\Core\Misc\FTimespan) & Delay, const [FDateTime](API\Runtime\Core\Misc\FDateTime) & Expiration )


description: Sends a message with fields, attachment and expiration to the specified recipient after a given delay.

code: template<typename MessageType> void Send ( MessageType * Message, const [TMap](API\Runtime\Core\Containers\TMap)< [FName](API\Runtime\Core\UObject\FName), [FString](API\Runtime\Core\Containers\FString) > Annotations, const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IMessageAttachment](API\Runtime\Messaging\IMessageAttachment), ESPMode::ThreadSafe > & Attachment, const [FMessageAddress](API\Runtime\Messaging\FMessageAddress) & Recipient, const [FDateTime](API\Runtime\Core\Misc\FDateTime) & Expiration, const [FTimespan](API\Runtime\Core\Misc\FTimespan) & Delay )


description: Sends a message to the specified list of recipients. Allows to specify message flags

code: template<typename MessageType> void Send ( MessageType * Message, EMessageFlags Flags, const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IMessageAttachment](API\Runtime\Messaging\IMessageAttachment), ESPMode::ThreadSafe > & Attachment, const [TArray](API\Runtime\Core\Containers\TArray)< [FMessageAddress](API\Runtime\Messaging\FMessageAddress) > & Recipients, const [FTimespan](API\Runtime\Core\Misc\FTimespan) & Delay, const [FDateTime](API\Runtime\Core\Misc\FDateTime) & Expiration )


code: void Send ( void * Message, [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * TypeInfo, EMessageFlags Flags, const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IMessageAttachment](API\Runtime\Messaging\IMessageAttachment), ESPMode::ThreadSafe > & Attachment, const [TArray](API\Runtime\Core\Containers\TArray)< [FMessageAddress](API\Runtime\Messaging\FMessageAddress) > & Recipients, const [FTimespan](API\Runtime\Core\Misc\FTimespan) & Delay, const [FDateTime](API\Runtime\Core\Misc\FDateTime) & Expiration )


code: template<typename MessageType> void Send ( MessageType * Message, EMessageFlags Flags, const [TMap](API\Runtime\Core\Containers\TMap)< [FName](API\Runtime\Core\UObject\FName), [FString](API\Runtime\Core\Containers\FString) > Annotations, const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IMessageAttachment](API\Runtime\Messaging\IMessageAttachment), ESPMode::ThreadSafe > & Attachment, const [TArray](API\Runtime\Core\Containers\TArray)< [FMessageAddress](API\Runtime\Messaging\FMessageAddress) > & Recipients, const [FTimespan](API\Runtime\Core\Misc\FTimespan) & Delay, const [FDateTime](API\Runtime\Core\Misc\FDateTime) & Expiration )


code: void Send ( void * Message, [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * TypeInfo, EMessageFlags Flags, const [TMap](API\Runtime\Core\Containers\TMap)< [FName](API\Runtime\Core\UObject\FName), [FString](API\Runtime\Core\Containers\FString) > Annotations, const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IMessageAttachment](API\Runtime\Messaging\IMessageAttachment), ESPMode::ThreadSafe > & Attachment, const [TArray](API\Runtime\Core\Containers\TArray)< [FMessageAddress](API\Runtime\Messaging\FMessageAddress) > & Recipients, const [FTimespan](API\Runtime\Core\Misc\FTimespan) & Delay, const [FDateTime](API\Runtime\Core\Misc\FDateTime) & Expiration )


description: Immediately sends a message to the specified list of recipients.

code: template<typename MessageType> void Send ( MessageType * Message, const [TArray](API\Runtime\Core\Containers\TArray)< [FMessageAddress](API\Runtime\Messaging\FMessageAddress) > & Recipients )


code: template<typename MessageType> void Send ( MessageType * Message, const [TMap](API\Runtime\Core\Containers\TMap)< [FName](API\Runtime\Core\UObject\FName), [FString](API\Runtime\Core\Containers\FString) > Annotations, const [FMessageAddress](API\Runtime\Messaging\FMessageAddress) & Recipient )


description: Sends a message to the specified recipient after a given delay.

code: template<typename MessageType> void Send ( MessageType * Message, const [FMessageAddress](API\Runtime\Messaging\FMessageAddress) & Recipient, const [FTimespan](API\Runtime\Core\Misc\FTimespan) & Delay )


description: Sends a message with fields and attachment to the specified recipient.

code: template<typename MessageType> void Send ( MessageType * Message, const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IMessageAttachment](API\Runtime\Messaging\IMessageAttachment), ESPMode::ThreadSafe > & Attachment, const [FMessageAddress](API\Runtime\Messaging\FMessageAddress) & Recipient )


description: Sends a message to the specified list of recipients after a given delay after a given delay.

code: template<typename MessageType> void Send ( MessageType * Message, const [TArray](API\Runtime\Core\Containers\TArray)< [FMessageAddress](API\Runtime\Messaging\FMessageAddress) > & Recipients, const [FTimespan](API\Runtime\Core\Misc\FTimespan) & Delay )


description: Sends a message with fields and expiration to the specified recipient after a given delay.

code: template<typename MessageType> void Send ( MessageType * Message, const [FMessageAddress](API\Runtime\Messaging\FMessageAddress) & Recipient, const [FTimespan](API\Runtime\Core\Misc\FTimespan) & Delay, const [FDateTime](API\Runtime\Core\Misc\FDateTime) & Expiration )


description: Sends a message with fields and attachment to the specified list of recipients after a given delay.

code: template<typename MessageType> void Send ( MessageType * Message, const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IMessageAttachment](API\Runtime\Messaging\IMessageAttachment), ESPMode::ThreadSafe > & Attachment, const [TArray](API\Runtime\Core\Containers\TArray)< [FMessageAddress](API\Runtime\Messaging\FMessageAddress) > & Recipients, const [FTimespan](API\Runtime\Core\Misc\FTimespan) & Delay )


code: template<typename MessageType> void Send ( MessageType * Message, const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IMessageAttachment](API\Runtime\Messaging\IMessageAttachment), ESPMode::ThreadSafe > & Attachment, const [FMessageAddress](API\Runtime\Messaging\FMessageAddress) & Recipient, const [FDateTime](API\Runtime\Core\Misc\FDateTime) & Expiration, const [FTimespan](API\Runtime\Core\Misc\FTimespan) & Delay )


description: ThreadAny is the fastest way to receive messages. It should be used if the receiving code is completely thread-safe and if it is sufficiently fast. ThreadAny MUST NOT be used if the receiving code is not thread-safe. It also SHOULD NOT be used if the code includes time consuming operations, because it will block the message router, causing no other messages to be delivered in the meantime.

code: void SetRecipientThread ( const [ENamedThreads::Type](API\Runtime\Core\Async\ENamedThreads__Type) & NamedThread )


description: The default message scope is all messages excluding loopback messages.

code: template<class MessageType> void Subscribe()


description: Template method to subscribe the message endpoint to the specified type and scope of messages.

code: template<class MessageType> void Subscribe ( const FMessageScopeRange & ScopeRange )


description: Subscribes a message handler.

code: void Subscribe ( const [FName](API\Runtime\Core\UObject\FName) & MessageType, const FMessageScopeRange & ScopeRange )


description: Subscribes a message handler.

code: void Subscribe ( const [FTopLevelAssetPath](API\Runtime\CoreUObject\UObject\FTopLevelAssetPath) & MessageType, const FMessageScopeRange & ScopeRange )


description: Subscribe

code: void Unsubscribe()


description: Subscribe

code: template<class MessageType> void Unsubscribe()


description: Subscribe

code: void Unsubscribe ( const [FName](API\Runtime\Core\UObject\FName) & MessageType )


description: Subscribe

code: void Unsubscribe ( const [FTopLevelAssetPath](API\Runtime\CoreUObject\UObject\FTopLevelAssetPath) & MessageType )


description: Creates and initializes a new instance.

code: FMessageEndpoint ( const [FName](API\Runtime\Core\UObject\FName) & InName, const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IMessageBus](API\Runtime\Messaging\IMessageBus), ESPMode::ThreadSafe > & InBus, const [TArray](API\Runtime\Core\Containers\TArray)< [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IMessageHandler](API\Runtime\Messaging\IMessageHandler), ESPMode::ThreadSafe >> & InHandlers, const FOnBusNotification InNotificationDelegate )


description: Destructor.

code: ~FMessageEndpoint()


description:
Builds the message endpoint as configured.
A new message endpoint, or nullptr if it couldn't be built.

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FMessageEndpoint](API\Runtime\MessagingCommon\FMessageEndpoint), ESPMode::ThreadSafe > Build()


description: WithHandler

code: template<typename MessageType> [FMessageEndpointBuilder](API\Runtime\MessagingCommon\FMessageEndpointBuilder) & Handling ( typename [TFunctionMessageHandler](API\Runtime\MessagingCommon\TFunctionMessageHandler)< MessageType >::FuncType HandlerFunc )


description: WithHandler

code: template<typename MessageType, typename HandlerType> [FMessageEndpointBuilder](API\Runtime\MessagingCommon\FMessageEndpointBuilder) & Handling ( HandlerType * Handler, typename [TRawMessageHandler](API\Runtime\MessagingCommon\TRawMessageHandler)< MessageType, HandlerType >::FuncType HandlerFunc )


code: [FMessageEndpointBuilder](API\Runtime\MessagingCommon\FMessageEndpointBuilder) & NotificationHandling ( FOnBusNotification && InHandler )


className: FMessageEndpointBuilder::operator TSharedPtr< FMessageEndpoint, ESPMode::ThreadSafe >

description:
Implicit conversion operator to build the message endpoint as configured.
The message endpoint.

code: namespace operator TSharedPtr< FMessageEndpoint, ESPMode { operator TSharedPtr< FMessageEndpoint, ESPMode::ThreadSafe >() }


description: ReceivingOnThread


description: ReceivingOnAnyThread

code: [FMessageEndpointBuilder](API\Runtime\MessagingCommon\FMessageEndpointBuilder) & ReceivingOnThread ( [ENamedThreads::Type](API\Runtime\Core\Async\ENamedThreads__Type) NamedThread )


description:
Disables the endpoint.
This instance (for method chaining).


description: WithHandler

code: [FMessageEndpointBuilder](API\Runtime\MessagingCommon\FMessageEndpointBuilder) & WithCatchall ( [FFunctionMessageCatchall::FuncType](API\Runtime\MessagingCommon\FFunctionMessageCatchall\FuncType) HandlerFunc )


description: WithHandler

code: template<typename HandlerType> [FMessageEndpointBuilder](API\Runtime\MessagingCommon\FMessageEndpointBuilder) & WithCatchall ( HandlerType * Handler, typename [TRawMessageCatchall](API\Runtime\MessagingCommon\TRawMessageCatchall)< HandlerType >::FuncType HandlerFunc )


description: WithCatchall

code: [FMessageEndpointBuilder](API\Runtime\MessagingCommon\FMessageEndpointBuilder) & WithHandler ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IMessageHandler](API\Runtime\Messaging\IMessageHandler), ESPMode::ThreadSafe > & Handler )


className: FMessageEndpoint

description: The underlying message bus will take ownership of all sent and published message objects. The memory held by the messages must therefore NOT be freed by the caller.

code: class FMessageEndpoint : public [TSharedFromThis< FMessageEndpoint, ESPMode::ThreadSafe >](API\Runtime\Core\Templates\TSharedFromThis), public [IMessageReceiver](API\Runtime\Messaging\IMessageReceiver), public [IMessageSender](API\Runtime\Messaging\IMessageSender), public [IBusListener](API\Runtime\Messaging\IBusListener)


description:
The inbox is disabled by default.
This instance (for method chaining).


description: Creates and initializes a new builder using the specified message bus.

code: FMessageEndpointBuilder ( const [FName](API\Runtime\Core\UObject\FName) & InName, const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IMessageBus](API\Runtime\Messaging\IMessageBus), ESPMode::ThreadSafe > & InBus )


description: WARNING: This constructor must be called from the Game thread.

code: FMessageEndpointBuilder ( const [FName](API\Runtime\Core\UObject\FName) & InName )


className: FMessageEndpointBuilder

description: Implements a message endpoint builder.

code: struct FMessageEndpointBuilder


description: Type definition for function objects that are compatible with thisTFunctionMessageHandler.

code: typedef [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void(const MessageType &, const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IMessageContext](API\Runtime\Messaging\IMessageContext), ESPMode::ThreadSafe > &)> FuncType


description: Handles the specified message.

code: virtual void HandleMessage ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IMessageContext](API\Runtime\Messaging\IMessageContext), ESPMode::ThreadSafe > & Context )


description: Creates and initializes a new message handler.

code: TFunctionMessageHandler ( [FuncType](API\Runtime\MessagingCommon\TFunctionMessageHandler\FuncType) InFunc )


description: Type definition for function pointers that are compatible with thisTRawMessageCatchall.

code: typedef void(HandlerType::* FuncType


description: Virtual destructor.

code: ~TFunctionMessageHandler()


className: TFunctionMessageHandler

description: Template for handlers of one specific message type (via function objects).

code: template<typename MessageType> class TFunctionMessageHandler : public [IMessageHandler](API\Runtime\Messaging\IMessageHandler)


description: Virtual destructor.

code: ~TRawMessageCatchall()


code: TRawMessageCatchall ( HandlerType * InHandler, [FuncType](API\Runtime\MessagingCommon\TRawMessageCatchall\FuncType) InFunc )


className: TRawMessageCatchall

description: Template for catch-all handlers (via raw function pointers).

code: template<typename HandlerType> class TRawMessageCatchall : public [IMessageHandler](API\Runtime\Messaging\IMessageHandler)


description: Type definition for function pointers that are compatible with thisTRawMessageHandler.


code: TRawMessageHandler ( HandlerType * InHandler, [FuncType](API\Runtime\MessagingCommon\TRawMessageHandler\FuncType) InFunc )


description: Virtual destructor.

code: ~TRawMessageHandler()


className: TRawMessageHandler

description: Template for handlers of one specific message type (via raw function pointers).

code: template<typename MessageType, typename HandlerType> class TRawMessageHandler : public [IMessageHandler](API\Runtime\Messaging\IMessageHandler)


description: Default constructor.

module: MessagingRpc

code: FMessageRpcCancel()


description: Creates and initializes a new instance.

code: FMessageRpcCancel ( const [FGuid](API\Runtime\Core\Misc\FGuid) & InCallId )


className: FMessageRpcCancel

description: Message for canceling an RPC call.

code: struct FMessageRpcCancel

CallId

type: FGuid

description: Correlation identifier for the RPC call that this message refers to.


description: Default constructor.

code: FMessageRpcProgress()


description: Creates and initializes a new instance.

code: FMessageRpcProgress ( const [FGuid](API\Runtime\Core\Misc\FGuid) & InCallId, float InCompletion, const [FText](API\Runtime\Core\Internationalization\FText) & InStatusText )


description: Add an RPC request handler.

code: virtual void AddHandler ( const [FTopLevelAssetPath](API\Runtime\CoreUObject\UObject\FTopLevelAssetPath) & RequestMessageType, const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IMessageRpcHandler](API\Runtime\MessagingRpc\IMessageRpcHandler) > & Handler )


className: FMessageRpcProgress

description: Message for updating the progress of an RPC call.

code: struct FMessageRpcProgress

Completion

type: float

description: Completion percentage (0.0 to 1.0).

StatusText

type: FString

description: Status text.


className: FReturnInfo

code: struct FReturnInfo

LastProgressSent

type: FDateTime

Progress

type: TSharedPtr<IAs...

Return

type: TSharedPtr<IMe...


description:
Gets the server's message address.
Message address.

code: virtual const [FMessageAddress](API\Runtime\Messaging\FMessageAddress) & GetAddress() const


code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FMessageEndpoint](API\Runtime\MessagingCommon\FMessageEndpoint), ESPMode::ThreadSafe > GetEndpoint() const


description:
Get a delegate that is executed when a received RPC message has no registered handler.
The delegate.

code: virtual FOnMessagePathNameRpcNoHandler & OnNoHandlerWithPathName()


code: virtual PRAGMA_DISABLE_DEPRECATION_WARNINGSFOnMessageRpcNoHandler & OnNoHandler()


description: Processes anFMessageRpcCancelmessage.

code: void ProcessCancelation ( const [FMessageRpcCancel](API\Runtime\MessagingRpc\FMessageRpcCancel) & Message, const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IMessageContext](API\Runtime\Messaging\IMessageContext), ESPMode::ThreadSafe > & Context )


description: Processes an RPC request message.

code: void ProcessRequest ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IMessageContext](API\Runtime\Messaging\IMessageContext), ESPMode::ThreadSafe > & Context )


description: Send a progress message to the RPC client that made the RPC call.

code: void SendProgress ( const [FGuid](API\Runtime\Core\Misc\FGuid) & CallId, const [FReturnInfo](API\Runtime\MessagingRpc\FMessageRpcServer\FReturnInfo) & ReturnInfo )


description: Send a result message to the RPC client that made the RPC call.

code: void SendResult ( const [FGuid](API\Runtime\Core\Misc\FGuid) & CallId, const [FReturnInfo](API\Runtime\MessagingRpc\FMessageRpcServer\FReturnInfo) & ReturnInfo )


description: Set if the server sends progress updates

code: virtual void SetSendProgressUpdate ( bool InSendProgress )


description: Default constructor.

code: FMessageRpcServer()


code: FMessageRpcServer ( [FMessageEndpointBuilder](API\Runtime\MessagingCommon\FMessageEndpointBuilder) && InEndpointBuilder )


code: FMessageRpcServer ( const [FString](API\Runtime\Core\Containers\FString) & InDebugName, const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IMessageBus](API\Runtime\Messaging\IMessageBus), ESPMode::ThreadSafe > & InMessageBus )


description: Virtual destructor.

code: virtual ~FMessageRpcServer()


className: FMessageRpcServer

description: Implements an RPC server.

code: class FMessageRpcServer : public [IMessageRpcServer](API\Runtime\MessagingRpc\IMessageRpcServer)

MessageEndpoint

type: TSharedPtr<FMe...

description: Message endpoint.


description: Default constructor.

code: FMessageRpcUnhandled()


description: Creates and initializes a new instance.

code: FMessageRpcUnhandled ( const [FGuid](API\Runtime\Core\Misc\FGuid) & InCallId )


className: FMessageRpcUnhandled

description: Message for notifying RPC clients that a call was not handled by the server.

code: struct FMessageRpcUnhandled


description: Default constructor.

code: FRpcMessage()


className: FRpcMessage

description: Base type for RPC messages.

code: struct FRpcMessage


description: TimeOut

code: void Complete ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IMessageContext](API\Runtime\Messaging\IMessageContext), ESPMode::ThreadSafe > & ResponseContext )


description:
Constructs a new message based on the call message template. Ownership of the message belongs to the caller.
Pointer to the request message.

code: void * ConstructMessage() const


description:
Get the time at which the request was last updated by the server.
Update time.


description:
Get the call's unique identifier.
Call identifier.

code: const [FGuid](API\Runtime\Core\Misc\FGuid) & GetId() const


description:
Get the type of the request message.
Request message type.

code: [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * GetMessageType() const


description:
Get the request message template.
Pointer to the request message template.

code: void * GetMessageTemplate() const


description:
Gets the time at which the request was created.
Creation time.


description: Complete

code: void TimeOut()


description: Update the current progress.

code: void UpdateProgress ( float InCompletion, const [FText](API\Runtime\Core\Internationalization\FText) & InStatusText )


className: IMessageRpcCall

description: Every time an RPC call is made, a request message containing the call parameters is sent to the remote endpoint. While the remote endpoint is executing the call, it may send back progress updates in regular intervals. Once the call is complete, the remote endpoint sends a response message containing the result.

code: class IMessageRpcCall


description: Virtual destructor.

code: virtual ~IMessageRpcCall()


description: Add an RPC request.

code: void AddCall ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IMessageRpcCall](API\Runtime\MessagingRpc\IMessageRpcCall) > & Call )


description: Call a remote procedure.

code: template<typename RpcType, typename... P> [TAsyncResult](API\Runtime\Core\Async\TAsyncResult)< typename RpcType::FResult > Call ( P... Params )


description: Cancel the specified RPC call.

code: void CancelCall ( const [FGuid](API\Runtime\Core\Misc\FGuid) & CallId )


description: Disconnect

code: void Connect ( const [FMessageAddress](API\Runtime\Messaging\FMessageAddress) & InServerAddress )


description:
Whether the MessageRpcClient is currently connected to an RPC server.
true if the client is connected, false otherwise.

code: bool IsConnected() const


description: Virtual destructor.

code: virtual ~IMessageRpcClient()


className: IMessageRpcClient

description: Interface for RPC clients.

code: class IMessageRpcClient


description:
Handle an RPC request.
An object for the pending RPC return value.

code: [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IMessageRpcReturn](API\Runtime\MessagingRpc\IMessageRpcReturn) > HandleRequest ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IMessageContext](API\Runtime\Messaging\IMessageContext), ESPMode::ThreadSafe > & Context )


description: Virtual destructor.

code: virtual ~IMessageRpcHandler()


className: IMessageRpcHandler

description: Interface for RPC request handlers.

code: class IMessageRpcHandler


description: Cancel the computation of the return value.

code: void Cancel()


description: Connect

code: void Disconnect()


description:
Gets the type information for the corresponding RPC response message.
The message type information.

code: [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * GetResponseTypeInfo() const


description:
Check whether the return value is ready.
true if the return value is ready, false otherwise.

code: bool IsReady() const


code: [FRpcMessage](API\Runtime\MessagingRpc\FRpcMessage) * CreateResponseMessage() const


description: Virtual destructor.

code: virtual ~IMessageRpcReturn()


className: IMessageRpcReturn

description: Interface for RPC return values.

code: class IMessageRpcReturn


description: Add an RPC request handler.

code: void AddHandler ( const [FName](API\Runtime\Core\UObject\FName) & RequestMessageType, const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IMessageRpcHandler](API\Runtime\MessagingRpc\IMessageRpcHandler) > & Handler )


description: Add an RPC request handler.

code: void AddHandler ( const [FTopLevelAssetPath](API\Runtime\CoreUObject\UObject\FTopLevelAssetPath) & RequestMessageType, const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IMessageRpcHandler](API\Runtime\MessagingRpc\IMessageRpcHandler) > & Handler )


description:
Gets the server's message address.
Message address.

code: const [FMessageAddress](API\Runtime\Messaging\FMessageAddress) & GetAddress() const


description:
Get a delegate that is executed when a received RPC message has no registered handler.
The delegate.


description: Register an RPC request handler.

code: template<typename RpcType, typename HandlerType> void RegisterHandler ( HandlerType * Handler, typename THandler< RpcType, HandlerType >::FuncType Func )


code: void SetSendProgressUpdate ( bool InSendProgress )


description: Virtual destructor.

code: virtual ~IMessageRpcServer()


className: IMessageRpcServer

description: Interface for RPC servers.

code: class IMessageRpcServer


description:
Create a client for remote procedure calls.
The RPC client.


code: [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IMessageRpcClient](API\Runtime\MessagingRpc\IMessageRpcClient) > CreateRpcClient ( const [FString](API\Runtime\Core\Containers\FString) & DebugName, const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IMessageBus](API\Runtime\Messaging\IMessageBus), ESPMode::ThreadSafe > & MessageBus )


description:
Create a server for remote procedure calls.
The RPC server.


code: [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IMessageRpcServer](API\Runtime\MessagingRpc\IMessageRpcServer) > CreateRpcServer ( const [FString](API\Runtime\Core\Containers\FString) & DebugName, const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IMessageBus](API\Runtime\Messaging\IMessageBus), ESPMode::ThreadSafe > & MessageBus )


description: Virtual destructor.

code: virtual ~IMessagingRpcModule()


className: IMessagingRpcModule

description: Interface for the MessagingRpc module.

code: class IMessagingRpcModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface)


className: TNameOf< IMessageRpcClient >::GetName

code: static TCHAR const &42; GetName&40;&41;


className: TNameOf< IMessageRpcClient >

code: template<> struct TNameOf< IMessageRpcClient >


description: True if there is either a standalone widget or any movie paths or both.

module: MoviePlayer

code: bool IsValid() const


description: Creates a simple test loading screen widget.

code: static [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< class [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > NewTestLoadingScreenWidget()


className: FLoadingScreenAttributes

description: Struct of all the attributes a loading screen will have.

code: struct FLoadingScreenAttributes

bAllowEngineTick

type: bool

description: If true, this will call the engine tick while the game thread is stalled waiting for a loading movie to finish.

bAllowInEarlyStartup

description: If true loading screens here cannot have any uobjects of any kind or use any engine features at all.

bAutoCompleteWhenLoadingCompletes

description: If true, the loading screen will disappear as soon as all movies are played and loading is done.

bMoviesAreSkippable

description: If true, movies can be skipped by clicking the loading screen as long as loading is done.

bWaitForManualStop

description: If true, movie playback continues until Stop is called.

MinimumLoadingScreenDisplayTime

description: The minimum time that a loading screen should be opened for.

MoviePaths

type: TArray<FString...

description: The movie paths local to the game's Content/Movies/ directory we will play.

PlaybackType

type: TEnumAsByte< EM...

description: Should we just play back, loop, etc.

WidgetLoadingScreen

type: TSharedPtr< cla...

description: The widget to be displayed on top of the movie or simply standalone if there is no movie.


description: Returns a slate texture used to draw the rendered viewport in Slate.

code: virtual [FSlateShaderResource](API\Runtime\SlateCore\Textures\FSlateShaderResource) * GetViewportRenderTargetTexture() const


description: ISlateViewportinterface.

code: virtual FIntPoint GetSize() const


description: Sets the size to use when there is no texture.

code: void SetDefaultSize ( FIntPoint InSize )


description: Returns true if the viewport should be vsynced.

code: virtual bool RequiresVsync() const


code: void SetTexture ( [TWeakPtr](API\Runtime\Core\Templates\TWeakPtr)< [FSlateTexture2DRHIRef](API\Runtime\Engine\Slate\FSlateTexture2DRHIRef), ESPMode::ThreadSafe > InTexture )


code: void BroadcastMoviePlaybackFinished()


code: void BroadcastMovieClipFinished ( const [FString](API\Runtime\Core\Containers\FString) & MovieClipThatFinished )


className: FMovieViewport

description: This viewport is a simple interface for the loading to use to display the video textures.

code: class FMovieViewport : public [ISlateViewport](API\Runtime\SlateCore\Rendering\ISlateViewport), public [TSharedFromThis< FMovieViewport >](API\Runtime\Core\Templates\TSharedFromThis)


className: FOnMovieClipFinished

code: class FOnMovieClipFinished : public TBaseMulticastDelegate_OneParam< void, const FString & >


className: FOnMoviePlaybackFinished

code: class FOnMoviePlaybackFinished : public TBaseMulticastDelegate_NoParams< void >


className: FOnMoviePlaybackStarted

description: Callback for when the LoadingScreen setup above in WidgetLoadingScreen is displayed

code: class FOnMoviePlaybackStarted : public TBaseMulticastDelegate_NoParams< void >


className: FOnMoviePlaybackTick

description: Callback for when the game thread is blocked but you want to do some ticking.

code: class FOnMoviePlaybackTick : public TBaseMulticastDelegate_OneParam< void, float DeltaTime >


code: virtual void ForceCompletion()


className: FOnPrepareLoadingScreen

description: Called before playing a movie if the loading screen has not been prepared.

code: class FOnPrepareLoadingScreen : public TBaseMulticastDelegate_NoParams< void >


description: Returns the name of the movie currently being played


description: true if the movie player has been set up with an early startup movie

code: bool HasEarlyStartupMovie() const


description: Initializes this movie player, creating the startup window and hiding the splash screen. To be called in the launch engine loop.

code: void Initialize ( class [FSlateRenderer](API\Runtime\SlateCore\Rendering\FSlateRenderer) & InSlateRenderer, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [SWindow](API\Runtime\SlateCore\Widgets\SWindow) > RenderTarget )


description: true if Initialize was called

code: bool IsInitialized() const


description: Returns true if the movie being played in the last one in the play list

code: bool IsLastMovieInPlaylist()


description: Called from to check if the game thread is finished loading.

code: bool IsLoadingFinished() const


description: True if the loading screen is currently running (i.e. PlayMovie but no WaitForMovieToFinish has been called).

code: bool IsMovieCurrentlyPlaying() const


description: Check if the initial movie(s) is still playing

code: virtual bool IsStartupMoviePlaying() const


description: True if we have either slate widgets or a movie to show.

code: bool LoadingScreenIsPrepared() const


description: Passes the loading screen window back to the game to use. For use by the launch engine loop only.


description:
Play any early start up movies that have been set up
true if a movie started playing

code: bool PlayEarlyStartupMovies()


description:
Starts playing the movie given the lastFLoadingScreenAttributespassed in
true of a movie started playing.

code: bool PlayMovie()


description: Registers a movie streamer with the movie player. Set in the preloading screen stage.

code: void RegisterMovieStreamer ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IMovieStreamer](API\Runtime\MoviePlayer\IMovieStreamer), ESPMode::ThreadSafe > InMovieStreamer )


description: Call this to have the MoviePlayer play in blocking sections and not loadmap.

code: virtual void SetIsPlayOnBlockingEnabled ( bool bIsEnabled )


description: Allows for a slate overlay widget to be set after playback.

code: void SetSlateOverlayWidget ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > NewOverlayWidget )


description: Allows for a DPI scale to be set.

code: virtual void SetViewportDPIScale ( float InViewportDPIScale )


description: Passes in a slate loading screen UI, movie paths, and any additional data.

code: void SetupLoadingScreen ( const [FLoadingScreenAttributes](API\Runtime\MoviePlayer\FLoadingScreenAttributes) & InLoadingScreenAttributes )


description: Sets up anFLoadingScreenAttributesfrom the game's engine.ini, then calls the virtual SetupLoadingScreen.

code: void SetupLoadingScreenFromIni()


description: Shutsdown the movie player.

code: void Shutdown()


description: Stops the currently playing movie, if any.

code: void StopMovie()


description: Call only on the game thread. Spins this thread until the movie stops. If bAllowEngineTick is true, the engine tick may run inside here

code: void WaitForMovieToFinish ( bool bAllowEngineTick )


description: This function shouild return true if the movie will auto-complete the sequence when background loading has finished

code: bool WillAutoCompleteWhenLoadFinishes()


className: IGameMoviePlayer

description: An interface to the movie player we will use for loading screens and gameplay movies

code: class IGameMoviePlayer


code: void BroadcastCurrentMovieClipFinished ( const [FString](API\Runtime\Core\Containers\FString) & MovieClipThatFinished )


className: FOnCurrentMovieClipFinished

code: class FOnCurrentMovieClipFinished : public TBaseMulticastDelegate_OneParam< void, const FString & >


description: Called to allow the movie streamer to cleanup any resources once there are no movies left to play.

code: void Cleanup()


description: Forces the movie streamer to cancel what it's streaming and close.

code: void ForceCompletion()


description: Gets the aspect ratio of the movie frames being streamed.

code: float GetAspectRatio() const


description: Returns the name of the movie currently being played


code: virtual FTexture2DRHIRef GetTexture()


description: Gets a viewport interface which will be used to draw the movie.

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< class [ISlateViewport](API\Runtime\SlateCore\Rendering\ISlateViewport) > GetViewportInterface()


description: Initializes this movie streamer with all the movie paths (ordered) we want to play Movie paths are local to the current game's Content/Movies/ directory.

code: bool Init ( const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & MoviePaths, [TEnumAsByte](API\Runtime\Core\Containers\TEnumAsByte)< EMoviePlaybackType > inPlaybackType )


description: Returns true if the movie being played in the last one in the play list

code: bool IsLastMovieInPlaylist()


description: Tells the movie streamer about the viewport interface that was active before us.

code: virtual void PreviousViewportInterface ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [ISlateViewport](API\Runtime\SlateCore\Rendering\ISlateViewport) > & PreviousViewportInterface )


description: Called by the engine on suspend/resume

code: virtual void Suspend()


description: Code run every tick for any additional per tick handling of playing the movie. Returns true if done.

code: bool Tick ( float DeltaTime )


description: Called after the engine ticks.

code: virtual void TickPostEngine()


description: Called after rendering is finished.

code: virtual void TickPostRender()


description: Called before the engine tick.

code: virtual void TickPreEngine()


className: IMovieStreamer

description: Interface for creating a movie streaming player. Should be one instance per platform.

code: class IMovieStreamer


code: UMoviePlayerSettings ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


description: Call this once the blocking operation is done to shut down the movie player.

module: MoviePlayerProxy

code: static void BlockingFinished()


className: UMoviePlayerSettings

description: Implements the settings for the Windows target platform.

code: class UMoviePlayerSettings : public [UObject](API\Runtime\CoreUObject\UObject\UObject)

bMoviesAreSkippable

description: If enabled, Startup movies can be skipped by the user when a mouse button is pressed.

bWaitForMoviesToComplete

description: If enabled, The game waits for startup movies to complete even if loading has finished.

StartupMovies

description: Movies to play on startup. Note that these must be in your game's Game/Content/Movies directory.


description: Call this to make sure the movie player is no longer running.

code: static void BlockingForceFinished()


description: Call this before doing a blocking operation on the game thread so that the movie player can activate.

code: static void BlockingStarted()


description: Call this periodically during a blocking operation on the game thread.

code: static void BlockingTick()


description: Call this to hook up a server.

code: static void RegisterServer ( [IMoviePlayerProxyServer](API\Runtime\MoviePlayerProxy\IMoviePlayerProxyServer) * InServer )


className: Server

description: Our current worker that handles blocks.

code: static [IMoviePlayerProxyServer](API\Runtime\MoviePlayerProxy\IMoviePlayerProxyServer) * Server = nullptr;


description: Call this to unregister the current server.

code: static void UnregisterServer()


className: FMoviePlayerProxy

description: The movie player can call RegisterServer/UnregisterServer so it can receive the calls from the engine.

code: class FMoviePlayerProxy


description: Call this if you want to end the block before this object goes out of scope.

code: void Finish()


code: FMoviePlayerProxyBlock()


code: ~FMoviePlayerProxyBlock()


className: FMoviePlayerProxyBlock

description: You can also manually call Finish if you want to trigger this earlier.

code: class FMoviePlayerProxyBlock


description: Called once the blocking operation is done to shut down the movie player.

code: void BlockingFinished()


description: Call this to prevent the movie player from using the Slate thread.

code: static void SetIsSlateThreadAllowed ( bool bInIsSlateThreadAllowed )


description: Called before doing a blocking operation on the game thread occurs so that the movie player can activate.

code: void BlockingStarted()


description: Called periodically during a blocking operation on the game thread.

code: void BlockingTick()


code: void SetIsSlateThreadAllowed ( bool bInIsSlateThreadAllowed )


className: IMoviePlayerProxyServer

description: Implement this interface if you want to handle what happens when the engine interacts with the MoviePlayer, etc when the game thread is blocked.

code: class IMoviePlayerProxyServer


description:
Check whether this cache is still valid for the specified frame number.
true if this interpolation is relevant to the frame, or false if it should be re-generated

module: MovieScene

code: bool IsCacheValidForTime ( [FFrameNumber](API\Runtime\Core\Misc\FFrameNumber) FrameNumber ) const


description:
Evaluate this interpolation for the specified frame time
true if this interpolation evaluated successfully (and the result written to OutResult), false otherwise.

code: bool Evaluate ( [FFrameTime](API\Runtime\Core\Misc\FFrameTime) FrameTime, double & OutResult ) const


description: Default construction to an invalid state. Calling Evaluate will always return false

code: FCachedInterpolation()


description: Construction as a linear interpolation

code: FCachedInterpolation ( const [FCachedInterpolationRange](API\Runtime\MovieScene\Channels\FCachedInterpolationRange) & InRange, const [FLinearInterpolation](API\Runtime\MovieScene\Channels\FLinearInterpolation) & Linear )


description: Construction as a cubic interpolation

code: FCachedInterpolation ( const [FCachedInterpolationRange](API\Runtime\MovieScene\Channels\FCachedInterpolationRange) & InRange, const [FCubicInterpolation](API\Runtime\MovieScene\Channels\FCubicInterpolation) & Cubic )


description: Construction as a weighted cubic interpolation

code: FCachedInterpolation ( const [FCachedInterpolationRange](API\Runtime\MovieScene\Channels\FCachedInterpolationRange) & InRange, const [FWeightedCubicInterpolation](API\Runtime\MovieScene\Channels\FWeightedCubicInterpolation) & WeightedCubic )


className: FCachedInterpolation

description: Variant structure that wraps an interpolation and the range within which it is valid. ~96 bytes

code: struct FCachedInterpolation


description: Construction as a constant value

code: FCachedInterpolation ( const [FCachedInterpolationRange](API\Runtime\MovieScene\Channels\FCachedInterpolationRange) & InRange, const [FConstantValue](API\Runtime\MovieScene\Channels\FConstantValue) & Constant )


code: bool Contains ( [FFrameNumber](API\Runtime\Core\Misc\FFrameNumber) FrameNumber ) const


description: Make finite range from InStart to InEnd, not including the end frame

code: static [FCachedInterpolationRange](API\Runtime\MovieScene\Channels\FCachedInterpolationRange) Finite ( [FFrameNumber](API\Runtime\Core\Misc\FFrameNumber) InStart, [FFrameNumber](API\Runtime\Core\Misc\FFrameNumber) InEnd )


description: Make an infinite range


description: Make an empty range


description: Make a range that covers all times from (and including) the specified start

code: static [FCachedInterpolationRange](API\Runtime\MovieScene\Channels\FCachedInterpolationRange) From ( [FFrameNumber](API\Runtime\Core\Misc\FFrameNumber) InStart )


description: Make a range that only contains the specified time

code: static [FCachedInterpolationRange](API\Runtime\MovieScene\Channels\FCachedInterpolationRange) Only ( [FFrameNumber](API\Runtime\Core\Misc\FFrameNumber) InTime )


description: Make a range that covers all times up to (but not including) the specified end

code: static [FCachedInterpolationRange](API\Runtime\MovieScene\Channels\FCachedInterpolationRange) Until ( [FFrameNumber](API\Runtime\Core\Misc\FFrameNumber) InEnd )


className: FCachedInterpolationRange

description: Simple 1 dimensional range based off aFFrameNumberto define the range within which a cached interpolation is valid

code: struct FCachedInterpolationRange

End

type: FFrameNumber

description: Exclusive end frame (unless End ==Max())

Start

description: Inclusive start frame


className: FChannelOverrideEntityImportParams

description: Entity import parameters for a channel override.

ChannelName

type: FName


code: int32 GetIndex ( const [FName](API\Runtime\Core\UObject\FName) & InChannelName ) const


code: [FName](API\Runtime\Core\UObject\FName) GetChannelName ( int32 InIndex ) const


code: FChannelOverrideNames ( int32 InIndexOffset, std::initializer_list< [FName](API\Runtime\Core\UObject\FName) > InChannelNames )


className: FChannelOverrideNames

description: Utility class to convert channel names to indices

code: struct FChannelOverrideNames

ChannelNames

type: TArray<FName>


description: Convert a channel name to an override entity ID.

code: int32 GetChannelOverrideEntityID ( [FName](API\Runtime\Core\UObject\FName) ChannelName ) const


description: Convert an override entity ID to a channel name.

code: [FName](API\Runtime\Core\UObject\FName) GetChannelOverrideName ( int32 EntityID ) const


description: Gets the channel ID for a given channel.

code: [FName](API\Runtime\Core\UObject\FName) GetDefaultChannelTypeName ( [FName](API\Runtime\Core\UObject\FName) ChannelName ) const


className: FChannelOverrideProviderTraits

code: struct FChannelOverrideProviderTraits


className: BlueChannelColor

code: static const [FLinearColor](API\Runtime\Core\Math\FLinearColor) BlueChannelColor;


className: ChannelA

code: static const [FText](API\Runtime\Core\Internationalization\FText) ChannelA = FInternationalization::ForUseOnlyByLocMacroAndGraphNodeTextLiterals_CreateText(TEXT( "A" ), TEXT( "MovieSceneChannels" ), TEXT( "ChannelA" ));


className: ChannelB

code: static const [FText](API\Runtime\Core\Internationalization\FText) ChannelB = FInternationalization::ForUseOnlyByLocMacroAndGraphNodeTextLiterals_CreateText(TEXT( "B" ), TEXT( "MovieSceneChannels" ), TEXT( "ChannelB" ));


className: FChannelOverrideProviderTraitsHandle

code: typedef [TInlineValue](API\Runtime\Core\Misc\TInlineValue)< [FChannelOverrideProviderTraits](API\Runtime\MovieScene\Channels\FChannelOverrideProviderTraits), 64 > FChannelOverrideProviderTraitsHandle


className: ChannelG

code: static const [FText](API\Runtime\Core\Internationalization\FText) ChannelG = FInternationalization::ForUseOnlyByLocMacroAndGraphNodeTextLiterals_CreateText(TEXT( "G" ), TEXT( "MovieSceneChannels" ), TEXT( "ChannelG" ));


className: ChannelR

code: static const [FText](API\Runtime\Core\Internationalization\FText) ChannelR = FInternationalization::ForUseOnlyByLocMacroAndGraphNodeTextLiterals_CreateText(TEXT( "R" ), TEXT( "MovieSceneChannels" ), TEXT( "ChannelR" ));


className: ChannelW

code: static const [FText](API\Runtime\Core\Internationalization\FText) ChannelW = FInternationalization::ForUseOnlyByLocMacroAndGraphNodeTextLiterals_CreateText(TEXT( "W" ), TEXT( "MovieSceneChannels" ), TEXT( "ChannelW" ));


className: ChannelX

code: static const [FText](API\Runtime\Core\Internationalization\FText) ChannelX = FInternationalization::ForUseOnlyByLocMacroAndGraphNodeTextLiterals_CreateText(TEXT( "X" ), TEXT( "MovieSceneChannels" ), TEXT( "ChannelX" ));


className: ChannelZ

code: static const [FText](API\Runtime\Core\Internationalization\FText) ChannelZ = FInternationalization::ForUseOnlyByLocMacroAndGraphNodeTextLiterals_CreateText(TEXT( "Z" ), TEXT( "MovieSceneChannels" ), TEXT( "ChannelZ" ));


className: ChannelY

code: static const [FText](API\Runtime\Core\Internationalization\FText) ChannelY = FInternationalization::ForUseOnlyByLocMacroAndGraphNodeTextLiterals_CreateText(TEXT( "Y" ), TEXT( "MovieSceneChannels" ), TEXT( "ChannelY" ));


className: GreenChannelColor

code: static const [FLinearColor](API\Runtime\Core\Math\FLinearColor) GreenChannelColor;


className: RedChannelColor

code: static const [FLinearColor](API\Runtime\Core\Math\FLinearColor) RedChannelColor;


code: FConstantValue ( double InValue )


className: FConstantValue

description: Structure representing a constant value. Temporarily includes a flag to determine whether it needs to be re-evaluated for legacy fallback.

code: struct FConstantValue

Value

type: double

description: The constant value


className: FCommonChannelData

description: Commonly used channel display names and colors

code: struct FCommonChannelData


description: Evaluate the expression

code: double Evaluate ( [FFrameTime](API\Runtime\Core\Misc\FFrameTime) InTime ) const


code: FCubicInterpolation ( [FFrameNumber](API\Runtime\Core\Misc\FFrameNumber) InOrigin, double InDX, double InStartValue, double InEndValue, double InStartTangent, double InEndTangent )


className: FCubicInterpolation

description: A cubic bezier interpolation between 2 control points with tangents, represented as 4 control points on a Bezier curve

code: struct FCubicInterpolation

DX

description: The delta value between the two control points in the time-domain

Origin

description: The origin time of the first control point

description: The four control points that should be passed to BezierInterp


className: FInvalidValue

description: Sentinal type that represents an invalid interpolation value. Only used when a curve has no data whatsoever, and therefore cannot be evaluated

code: struct FInvalidValue


code: FKeyAddOrDeleteEventItem ( int32 InIndex, [FFrameNumber](API\Runtime\Core\Misc\FFrameNumber) InFrame )


className: FKeyAddOrDeleteEventItem

description: Events that are fired when adding, deleting or moving keys Item that's sent when an event is fired when we delete or add a key

code: struct FKeyAddOrDeleteEventItem


className: FKeyDataOptimizationParams

description: Parameter structure passed toUE::MovieScene::Optimizethat defines optimization parameters

code: struct FKeyDataOptimizationParams

bAutoSetInterpolation

description: Whether to automatically set interpolation tangents or not

DisplayRate

type: FFrameRate

description: The display rate to use for calculating tangents in non-normalized space

Range

type: TRange<FFrameN...

description: A range inside which to optimize keys

Tolerance

description: An arbitrary tolerance under which keys should be optimizied


code: FKeyMoveEventItem ( int32 InIndex, [FFrameNumber](API\Runtime\Core\Misc\FFrameNumber) InFrame, int32 InNewIndex, [FFrameNumber](API\Runtime\Core\Misc\FFrameNumber) InNewFrame )


className: FKeyMoveEventItem

description: Item that's sent when an event is fired when we move a key in time

code: struct FKeyMoveEventItem


code: FLinearInterpolation ( [FFrameNumber](API\Runtime\Core\Misc\FFrameNumber) InOrigin, double InCoefficient, double InConstant )


className: FLinearInterpolation

description: Structure representing a linear interpolation of the form f(t) = a(t-o) + b.

code: struct FLinearInterpolation

Coefficient

description: The coeffient 'a' in f(t) = a(t-o) + b

Constant

description: The constant 'c' in f(t) = a(t-o) + b

Origin

description: The origin 'o' in f(t) = a(t-o) + b


className: FMoveSceneAudioTriggerState

code: struct FMoveSceneAudioTriggerState

PreviousIndex

type: TOptional< int3...

PreviousUpdateTime

type: TOptional<FFra...


description: Called when the frame resolution of this channel is to be changed.

code: virtual void ChangeFrameResolution ( [FFrameRate](API\Runtime\Core\Misc\FFrameRate) SourceRate, [FFrameRate](API\Runtime\Core\Misc\FFrameRate) DestinationRate )


description:
Compute the effective range of this channel, for example, the extents of its key times
A range that represents the greatest range of times occupied by this channel, in the sequence's frame resolution

code: virtual [TRange](API\Runtime\Core\Math\TRange)< [FFrameNumber](API\Runtime\Core\Misc\FFrameNumber) > ComputeEffectiveRange() const


description: Delete the keys for the specified key handles

code: virtual void DeleteKeys ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< const [FKeyHandle](API\Runtime\Engine\Curves\FKeyHandle) > InHandles )


description: Delete keys before or after a specified time

code: virtual void DeleteKeysFrom ( [FFrameNumber](API\Runtime\Core\Misc\FFrameNumber) InTime, bool bDeleteKeysBefore )


description:
Evaluate this channel
true if the channel was evaluated successfully, false otherwise

code: bool EvaluatePossibleTriggers ( const [FMovieSceneContext](API\Runtime\MovieScene\Evaluation\FMovieSceneContext) & InContext, [FMoveSceneAudioTriggerState](API\Runtime\MovieScene\Channels\FMoveSceneAudioTriggerState) & InState, bool & OutTriggered ) const


description: Duplicate the keys for the specified key handles

code: virtual void DuplicateKeys ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< const [FKeyHandle](API\Runtime\Engine\Curves\FKeyHandle) > InHandles, [TArrayView](API\Runtime\Core\Containers\TArrayView)< [FKeyHandle](API\Runtime\Engine\Curves\FKeyHandle) > OutNewHandles )


description:
Access a mutable interface for this channel's data
An object that is able to manipulate this channel's data

code: [TMovieSceneChannelData](API\Runtime\MovieScene\Channels\TMovieSceneChannelData)< bool > GetData()


description:
Access a constant interface for this channel's data
An object that is able to interrogate this channel's data

code: [TMovieSceneChannelData](API\Runtime\MovieScene\Channels\TMovieSceneChannelData)< const bool > GetData() const


description: Get key information pertaining to all keys that exist within the specified range

code: virtual void GetKeys ( const [TRange](API\Runtime\Core\Math\TRange)< [FFrameNumber](API\Runtime\Core\Misc\FFrameNumber) > & WithinRange, [TArray](API\Runtime\Core\Containers\TArray)< [FFrameNumber](API\Runtime\Core\Misc\FFrameNumber) > * OutKeyTimes, [TArray](API\Runtime\Core\Containers\TArray)< [FKeyHandle](API\Runtime\Engine\Curves\FKeyHandle) > * OutKeyHandles )


description: Get all key times for the specified key handles

code: virtual void GetKeyTimes ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< const [FKeyHandle](API\Runtime\Engine\Curves\FKeyHandle) > InHandles, [TArrayView](API\Runtime\Core\Containers\TArrayView)< [FFrameNumber](API\Runtime\Core\Misc\FFrameNumber) > OutKeyTimes )


description:
Get the total number of keys on this channel
The number of keys on this channel

code: virtual int32 GetNumKeys() const


description: Const access to this channel's times

code: [TArrayView](API\Runtime\Core\Containers\TArrayView)< const [FFrameNumber](API\Runtime\Core\Misc\FFrameNumber) > GetTimes() const


description: Check whether this channel has any data

code: bool HasAnyData() const


description: Offset the keys within this channel by a given delta position

code: virtual void Offset ( [FFrameNumber](API\Runtime\Core\Misc\FFrameNumber) DeltaPosition )


description: Optimize this channel by removing any redundant data according to the specified parameters

code: virtual void Optimize ( const [FKeyDataOptimizationParams](API\Runtime\MovieScene\Channels\FKeyDataOptimizationParams) & InParameters )


description: Reset this channel back to its original state

code: virtual void Reset()


description: Set key times for the specified key handles

code: virtual void SetKeyTimes ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< const [FKeyHandle](API\Runtime\Engine\Curves\FKeyHandle) > InHandles, [TArrayView](API\Runtime\Core\Containers\TArrayView)< const [FFrameNumber](API\Runtime\Core\Misc\FFrameNumber) > InKeyTimes )


code: FMovieSceneAudioTriggerChannel()


className: FMovieSceneAudioTriggerChannel

code: struct FMovieSceneAudioTriggerChannel : public [FMovieSceneChannel](API\Runtime\MovieScene\Channels\FMovieSceneChannel)


description: Add keys with these times to channel. The number of elements in both arrays much match or nothing is added.

code: void AddKeys ( const [TArray](API\Runtime\Core\Containers\TArray)< [FFrameNumber](API\Runtime\Core\Misc\FFrameNumber) > & InTimes, const [TArray](API\Runtime\Core\Containers\TArray)< bool > & InValues )


description: Clear all the default value on this channel

code: virtual void ClearDefault()


description: Called when the frame resolution of this channel is to be changed.

code: virtual void ChangeFrameResolution ( [FFrameRate](API\Runtime\Core\Misc\FFrameRate) SourceRate, [FFrameRate](API\Runtime\Core\Misc\FFrameRate) DestinationRate )


description:
Compute the effective range of this channel, for example, the extents of its key times
A range that represents the greatest range of times occupied by this channel, in the sequence's frame resolution

code: virtual [TRange](API\Runtime\Core\Math\TRange)< [FFrameNumber](API\Runtime\Core\Misc\FFrameNumber) > ComputeEffectiveRange() const


description: Delete the keys for the specified key handles

code: virtual void DeleteKeys ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< const [FKeyHandle](API\Runtime\Engine\Curves\FKeyHandle) > InHandles )


description: Delete keys before or after a specified time

code: virtual void DeleteKeysFrom ( [FFrameNumber](API\Runtime\Core\Misc\FFrameNumber) InTime, bool bDeleteKeysBefore )


code: virtual void DuplicateKeys ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< const [FKeyHandle](API\Runtime\Engine\Curves\FKeyHandle) > InHandles, [TArrayView](API\Runtime\Core\Containers\TArrayView)< [FKeyHandle](API\Runtime\Engine\Curves\FKeyHandle) > OutNewHandles )


description:
Evaluate this channel
true if the channel was evaluated successfully, false otherwise

code: virtual bool Evaluate ( [FFrameTime](API\Runtime\Core\Misc\FFrameTime) InTime, bool & OutValue ) const


code: virtual [TMovieSceneChannelData](API\Runtime\MovieScene\Channels\TMovieSceneChannelData)< bool > GetData()


code: virtual [TMovieSceneChannelData](API\Runtime\MovieScene\Channels\TMovieSceneChannelData)< const bool > GetData() const


description:
Get this channel's default value that will be used when no keys are present
(Optional) The channel's default value

code: [TOptional](API\Runtime\Core\IO\TOptional)< bool > GetDefault() const


code: virtual void GetKeys ( const [TRange](API\Runtime\Core\Math\TRange)< [FFrameNumber](API\Runtime\Core\Misc\FFrameNumber) > & WithinRange, [TArray](API\Runtime\Core\Containers\TArray)< [FFrameNumber](API\Runtime\Core\Misc\FFrameNumber) > * OutKeyTimes, [TArray](API\Runtime\Core\Containers\TArray)< [FKeyHandle](API\Runtime\Engine\Curves\FKeyHandle) > * OutKeyHandles )


code: virtual void GetKeyTimes ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< const [FKeyHandle](API\Runtime\Engine\Curves\FKeyHandle) > InHandles, [TArrayView](API\Runtime\Core\Containers\TArrayView)< [FFrameNumber](API\Runtime\Core\Misc\FFrameNumber) > OutKeyTimes )


code: virtual int32 GetNumKeys() const


description: Const access to this channel's times

code: [TArrayView](API\Runtime\Core\Containers\TArrayView)< const [FFrameNumber](API\Runtime\Core\Misc\FFrameNumber) > GetTimes() const


description: Const access to this channel's values

code: [TArrayView](API\Runtime\Core\Containers\TArrayView)< const bool > GetValues() const


description: Check whether this channel has any data

code: bool HasAnyData() const


code: virtual void Offset ( [FFrameNumber](API\Runtime\Core\Misc\FFrameNumber) DeltaPosition )


code: virtual void Optimize ( const [FKeyDataOptimizationParams](API\Runtime\MovieScene\Channels\FKeyDataOptimizationParams) & InParameters )


description: Remove this channel's default value causing the channel to have no effect where no keys are present

code: void RemoveDefault()


code: virtual void Reset()


description: Serialize this type from another

code: bool SerializeFromMismatchedTag ( const [FPropertyTag](API\Runtime\CoreUObject\UObject\FPropertyTag) & Tag, [FStructuredArchive::FSlot](API\Runtime\Core\Serialization\FStructuredArchive\FSlot) Slot )


description: Set this channel's default value that should be used when no keys are present

code: void SetDefault ( bool InDefaultValue )


code: virtual void SetKeyTimes ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< const [FKeyHandle](API\Runtime\Engine\Curves\FKeyHandle) > InHandles, [TArrayView](API\Runtime\Core\Containers\TArrayView)< const [FFrameNumber](API\Runtime\Core\Misc\FFrameNumber) > InKeyTimes )


className: FMovieSceneBoolChannel

code: struct FMovieSceneBoolChannel : public [FMovieSceneChannel](API\Runtime\MovieScene\Channels\FMovieSceneChannel)

KeyHandles

type: FMovieSceneKeyH...

description: This needs to be a UPROPERTY so it gets saved into editor transactions but transient so it doesn't get saved into assets.

Times

type: TArray<FFrameN...

Values

type: TArray< bool >


code: void AddKeys ( const [TArray](API\Runtime\Core\Containers\TArray)< [FFrameNumber](API\Runtime\Core\Misc\FFrameNumber) > & InTimes, const [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & InValues )


code: virtual void ChangeFrameResolution ( [FFrameRate](API\Runtime\Core\Misc\FFrameRate) SourceRate, [FFrameRate](API\Runtime\Core\Misc\FFrameRate) DestinationRate )


code: virtual void ClearDefault()


code: virtual [TRange](API\Runtime\Core\Math\TRange)< [FFrameNumber](API\Runtime\Core\Misc\FFrameNumber) > ComputeEffectiveRange() const


code: virtual void DeleteKeys ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< const [FKeyHandle](API\Runtime\Engine\Curves\FKeyHandle) > InHandles )


description: Duplicate the keys for the specified key handles

code: virtual void DuplicateKeys ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< const [FKeyHandle](API\Runtime\Engine\Curves\FKeyHandle) > InHandles, [TArrayView](API\Runtime\Core\Containers\TArrayView)< [FKeyHandle](API\Runtime\Engine\Curves\FKeyHandle) > OutNewHandles )


code: virtual void DeleteKeysFrom ( [FFrameNumber](API\Runtime\Core\Misc\FFrameNumber) InTime, bool bDeleteKeysBefore )


code: bool Evaluate ( [FFrameTime](API\Runtime\Core\Misc\FFrameTime) InTime, uint8 & OutValue ) const


description:
Access a mutable interface for this channel's data
An object that is able to manipulate this channel's data

code: [TMovieSceneChannelData](API\Runtime\MovieScene\Channels\TMovieSceneChannelData)< uint8 > GetData()


description:
Access a constant interface for this channel's data
An object that is able to interrogate this channel's data

code: [TMovieSceneChannelData](API\Runtime\MovieScene\Channels\TMovieSceneChannelData)< const uint8 > GetData() const


code: [TOptional](API\Runtime\Core\IO\TOptional)< uint8 > GetDefault() const


code: [UEnum](API\Runtime\CoreUObject\UObject\UEnum) * GetEnum() const


description: Get key information pertaining to all keys that exist within the specified range

code: virtual void GetKeys ( const [TRange](API\Runtime\Core\Math\TRange)< [FFrameNumber](API\Runtime\Core\Misc\FFrameNumber) > & WithinRange, [TArray](API\Runtime\Core\Containers\TArray)< [FFrameNumber](API\Runtime\Core\Misc\FFrameNumber) > * OutKeyTimes, [TArray](API\Runtime\Core\Containers\TArray)< [FKeyHandle](API\Runtime\Engine\Curves\FKeyHandle) > * OutKeyHandles )


description: Get all key times for the specified key handles

code: virtual void GetKeyTimes ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< const [FKeyHandle](API\Runtime\Engine\Curves\FKeyHandle) > InHandles, [TArrayView](API\Runtime\Core\Containers\TArrayView)< [FFrameNumber](API\Runtime\Core\Misc\FFrameNumber) > OutKeyTimes )


description:
Get the total number of keys on this channel
The number of keys on this channel

code: virtual int32 GetNumKeys() const


description: Const access to this channel's times

code: [TArrayView](API\Runtime\Core\Containers\TArrayView)< const [FFrameNumber](API\Runtime\Core\Misc\FFrameNumber) > GetTimes() const


description: Const access to this channel's values

code: [TArrayView](API\Runtime\Core\Containers\TArrayView)< const uint8 > GetValues() const


description: Check whether this channel has any data

code: bool HasAnyData() const


description: Offset the keys within this channel by a given delta position

code: virtual void Offset ( [FFrameNumber](API\Runtime\Core\Misc\FFrameNumber) DeltaPosition )


description: Optimize this channel by removing any redundant data according to the specified parameters

code: virtual void Optimize ( const [FKeyDataOptimizationParams](API\Runtime\MovieScene\Channels\FKeyDataOptimizationParams) & InParameters )


description: Reset this channel back to its original state

code: virtual void Reset()


code: void RemoveDefault()


code: void SetDefault ( uint8 InDefaultValue )


description: Serialize this type from another

code: bool SerializeFromMismatchedTag ( const [FPropertyTag](API\Runtime\CoreUObject\UObject\FPropertyTag) & Tag, [FStructuredArchive::FSlot](API\Runtime\Core\Serialization\FStructuredArchive\FSlot) Slot )


code: void SetEnum ( [UEnum](API\Runtime\CoreUObject\UObject\UEnum) * InEnum )


description: Set key times for the specified key handles

code: virtual void SetKeyTimes ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< const [FKeyHandle](API\Runtime\Engine\Curves\FKeyHandle) > InHandles, [TArrayView](API\Runtime\Core\Containers\TArrayView)< const [FFrameNumber](API\Runtime\Core\Misc\FFrameNumber) > InKeyTimes )


className: FMovieSceneByteChannel

code: struct FMovieSceneByteChannel : public [FMovieSceneChannel](API\Runtime\MovieScene\Channels\FMovieSceneChannel)


description: Clear all the default value on this channel

code: virtual void ClearDefault()


description: Called when the frame resolution of this channel is to be changed.

code: virtual void ChangeFrameResolution ( [FFrameRate](API\Runtime\Core\Misc\FFrameRate) SourceRate, [FFrameRate](API\Runtime\Core\Misc\FFrameRate) DestinationRate )


description:
Compute the effective range of this channel, for example, the extents of its key times
A range that represents the greatest range of times occupied by this channel, in the sequence's frame resolution

code: virtual [TRange](API\Runtime\Core\Math\TRange)< [FFrameNumber](API\Runtime\Core\Misc\FFrameNumber) > ComputeEffectiveRange() const


description: Delete the keys for the specified key handles

code: virtual void DeleteKeys ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< const [FKeyHandle](API\Runtime\Engine\Curves\FKeyHandle) > InHandles )


description: Delete keys before or after a specified time

code: virtual void DeleteKeysFrom ( [FFrameNumber](API\Runtime\Core\Misc\FFrameNumber) InTime, bool bDeleteKeysBefore )


code: virtual void DuplicateKeys ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< const [FKeyHandle](API\Runtime\Engine\Curves\FKeyHandle) > InHandles, [TArrayView](API\Runtime\Core\Containers\TArrayView)< [FKeyHandle](API\Runtime\Engine\Curves\FKeyHandle) > OutNewHandles )


code: virtual void GetKeys ( const [TRange](API\Runtime\Core\Math\TRange)< [FFrameNumber](API\Runtime\Core\Misc\FFrameNumber) > & WithinRange, [TArray](API\Runtime\Core\Containers\TArray)< [FFrameNumber](API\Runtime\Core\Misc\FFrameNumber) > * OutKeyTimes, [TArray](API\Runtime\Core\Containers\TArray)< [FKeyHandle](API\Runtime\Engine\Curves\FKeyHandle) > * OutKeyHandles )


description: Get the time for the specified key handle

code: void GetKeyTime ( const [FKeyHandle](API\Runtime\Engine\Curves\FKeyHandle) InHandle, [FFrameNumber](API\Runtime\Core\Misc\FFrameNumber) & OutKeyTime )


code: virtual void GetKeyTimes ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< const [FKeyHandle](API\Runtime\Engine\Curves\FKeyHandle) > InHandles, [TArrayView](API\Runtime\Core\Containers\TArrayView)< [FFrameNumber](API\Runtime\Core\Misc\FFrameNumber) > OutKeyTimes )


code: virtual int32 GetNumKeys() const


description:
Get delegate that's called when a key is added
Returns key added event delegate


code: virtual void Offset ( [FFrameNumber](API\Runtime\Core\Misc\FFrameNumber) DeltaPosition )


description:
Get delegate that's called when a key is deleted
Returns key deleted event delegate


description:
Get delegate that's called when a key is moved
Returns key moved event delegate


description: Perfor a possibly heavy operation after an edit change

code: virtual void PostEditChange()


code: virtual void Reset()


description: Set the time for the specified key handle

code: void SetKeyTime ( const [FKeyHandle](API\Runtime\Engine\Curves\FKeyHandle) InHandle, const [FFrameNumber](API\Runtime\Core\Misc\FFrameNumber) InKeyTime )


description:
Add a new key at the specified time
The index of the key in its new position

code: int32 AddKeyInternal ( [FFrameNumber](API\Runtime\Core\Misc\FFrameNumber) InTime )


className: FMovieSceneChannel

code: struct FMovieSceneChannel

KeyAddedEvent

type: FMovieSceneChan...

description: Broadcasts a notification whenever key is added

KeyDeletedEvent

description: Broadcasts a notification whenever key is deleted

KeyMovedEvent

description: Broadcasts a notification whenever key is moved