Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Core > UObject > TMulticastScriptDelegate

Light Theme

Dark Theme

TMulticastScriptDelegate

Script multi-cast delegate base class

Windows

MacOS

Linux

Inheritance Hierarchy

TMulticastScriptDelegate

TBaseDynamicMulticastDelegate

References

Module	Core
Header	/Engine/Source/Runtime/Core/Public/UObject/ScriptDelegates.h
Include	#include "UObject/ScriptDelegates.h"

Syntax

template<typename TWeakPtr>
class TMulticastScriptDelegate

Remarks

Script multi-cast delegate base class

Variables

		Name	Description
	FInvocationList	InvocationList	Ordered list functions to invoke when the Broadcast function is called

Constructors

	Name	Description
	TMulticastScriptDelegate()	Default constructor

Functions

	Name	Description
void	Add ( const TScriptDelegate< TWeakPtr >&... )	Adds a function delegate to this multi-cast delegate's invocation list
void	AddInternal ( const TScriptDelegate< TWeakPtr >&... )	Adds a function delegate to this multi-cast delegate's invocation list
void	AddUnique ( const TScriptDelegate< TWeakPtr >&... )	Adds a function delegate to this multi-cast delegate's invocation list if a delegate with the same signature doesn't already exist in the invocation list
void	AddUniqueInternal ( const TScriptDelegate< TWeakPtr >&... )	Adds a function delegate to this multi-cast delegate's invocation list, if a delegate with that signature doesn't already exist
void	Clear()	Removes all functions from this delegate's invocation list
void	CompactInvocationList()	Cleans up any delegates in our invocation list that have expired (performance is O(N))
bool	Contains ( const UObject* InObject, FName InFunctionName )	Checks whether a function delegate is already a member of this multi-cast delegate's invocation list
bool	Contains ( const TScriptDelegate< TWeakPtr >&... )	Checks whether a function delegate is already a member of this multi-cast delegate's invocation list
TArray< UObj...	GetAllObjects()	Returns all objects associated with this multicast-delegate.
TArray< UObj...	GetAllObjectsEvenIfUnreachable()	Returns all objects associated with this multicast-delegate, even if unreachable.
bool	IsBound()	Checks to see if any functions are bound to this multi-cast delegate
void	ProcessMulticastDelegate ( void* Parameters )	Executes a multi-cast delegate by calling all functions on objects bound to the delegate.
void	Remove ( const TScriptDelegate< TWeakPtr >&... )	Removes a function from this multi-cast delegate's invocation list (performance is O(N)).
void	Remove ( const UObject* InObject, FName InFunctionName )	Removes a function from this multi-cast delegate's invocation list (performance is O(N)).
void	RemoveAll ( const UObject* Object )	Removes all delegate bindings from this multicast delegate's invocation list that are bound to the specified object.
void	RemoveInternal ( const TScriptDelegate< TWeakPtr >&... )	Removes a function from this multi-cast delegate's invocation list (performance is O(N)).
void	RemoveInternal ( const UObject* InObject, FName InFunctionName )	Removes a function from this multi-cast delegate's invocation list (performance is O(N)).
FString	ToString()	Converts this delegate to a string representation

Typedefs

Name	Description
FInvocationList

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

Take our survey

Dismiss