#include <ScriptDelegates.h>

Inheritance diagram for TMulticastScriptDelegate< InThreadSafetyMode >:

Public Types
using	ThreadSafetyMode = typename UE::Core::Private::TScriptDelegateTraits< InThreadSafetyMode >::ThreadSafetyMode

using	InvocationListType = TArray< UnicastDelegateType >

Public Member Functions
	TMulticastScriptDelegate ()=default

	TMulticastScriptDelegate (const TMulticastScriptDelegate &Other)

TMulticastScriptDelegate &	operator= (const TMulticastScriptDelegate &Other)

	TMulticastScriptDelegate (TMulticastScriptDelegate &&Other)

TMulticastScriptDelegate &	operator= (TMulticastScriptDelegate &&Other)

bool	IsBound () const

bool	Contains (const TScriptDelegate< ThreadSafetyMode > &InDelegate) const

template<typename OtherThreadSafetyMode >
bool	Contains (const TScriptDelegate< OtherThreadSafetyMode > &InDelegate) const

bool	Contains (const UObject *InObject, FName InFunctionName) const

void	Add (const TScriptDelegate< ThreadSafetyMode > &InDelegate)

template<typename OtherThreadSafetyMode >
void	Add (const TScriptDelegate< OtherThreadSafetyMode > &InDelegate)

void	AddUnique (const TScriptDelegate< ThreadSafetyMode > &InDelegate)

template<typename OtherThreadSafetyMode >
void	AddUnique (const TScriptDelegate< OtherThreadSafetyMode > &InDelegate)

void	Remove (const TScriptDelegate< ThreadSafetyMode > &InDelegate)

template<typename OtherThreadSafetyMode >
void	Remove (const TScriptDelegate< OtherThreadSafetyMode > &InDelegate)

void	Remove (const UObject *InObject, FName InFunctionName)

void	RemoveAll (const UObject *Object)

void	Clear ()

template<typename UObjectTemplate >
FString	ToString () const

template<class UObjectTemplate >
void	ProcessMulticastDelegate (void *Parameters) const

TArray< UObject * >	GetAllObjects () const

TArray< UObject * >	GetAllObjectsEvenIfUnreachable () const

TArray< typename UnicastDelegateType::WeakPtrType * >	GetAllObjectRefsEvenIfUnreachable () const

SIZE_T	GetAllocatedSize () const

Protected Member Functions
void	AddInternal (UnicastDelegateType &&InDelegate)

void	AddUniqueInternal (UnicastDelegateType &&InDelegate)

void	RemoveInternal (const UnicastDelegateType &InDelegate) const

void	RemoveInternal (const UObject *InObject, FName InFunctionName) const

void	CompactInvocationList () const

Protected Attributes
InvocationListType	InvocationList

Friends
class	FMulticastDelegateProperty

class	FMulticastInlineDelegateProperty

class	FMulticastSparseDelegateProperty

class	FCallDelegateHelper

struct	TIsZeroConstructType< TMulticastScriptDelegate >

FArchive &	operator<< (FArchive &Ar, TMulticastScriptDelegate &D)

void	operator<< (FStructuredArchive::FSlot Slot, TMulticastScriptDelegate &D)

Detailed Description

template<typename InThreadSafetyMode>
class TMulticastScriptDelegate< InThreadSafetyMode >

Script multi-cast delegate base class

Member Typedef Documentation

◆ InvocationListType

template<typename InThreadSafetyMode >

using TMulticastScriptDelegate< InThreadSafetyMode >::InvocationListType = TArray<UnicastDelegateType>

◆ ThreadSafetyMode

template<typename InThreadSafetyMode >

using TMulticastScriptDelegate< InThreadSafetyMode >::ThreadSafetyMode = typename UE::Core::Private::TScriptDelegateTraits<InThreadSafetyMode>::ThreadSafetyMode

Constructor & Destructor Documentation

◆ TMulticastScriptDelegate() [1/3]

template<typename InThreadSafetyMode >

TMulticastScriptDelegate< InThreadSafetyMode >::TMulticastScriptDelegate ( )

default

◆ TMulticastScriptDelegate() [2/3]

template<typename InThreadSafetyMode >

TMulticastScriptDelegate< InThreadSafetyMode >::TMulticastScriptDelegate ( const TMulticastScriptDelegate< InThreadSafetyMode > & Other )

inline

◆ TMulticastScriptDelegate() [3/3]

template<typename InThreadSafetyMode >

TMulticastScriptDelegate< InThreadSafetyMode >::TMulticastScriptDelegate ( TMulticastScriptDelegate< InThreadSafetyMode > && Other )

inline

Member Function Documentation

◆ Add() [1/2]

template<typename InThreadSafetyMode >

template<typename OtherThreadSafetyMode >

void TMulticastScriptDelegate< InThreadSafetyMode >::Add ( const TScriptDelegate< OtherThreadSafetyMode > & InDelegate )

inline

◆ Add() [2/2]

template<typename InThreadSafetyMode >

void TMulticastScriptDelegate< InThreadSafetyMode >::Add ( const TScriptDelegate< ThreadSafetyMode > & InDelegate )

inline

Adds a function delegate to this multi-cast delegate's invocation list

Parameters

InDelegate Delegate to add

◆ AddInternal()

template<typename InThreadSafetyMode >

void TMulticastScriptDelegate< InThreadSafetyMode >::AddInternal ( UnicastDelegateType && InDelegate )

inlineprotected

Adds a function delegate to this multi-cast delegate's invocation list

Parameters

InDelegate Delegate to add

◆ AddUnique() [1/2]

template<typename InThreadSafetyMode >

template<typename OtherThreadSafetyMode >

void TMulticastScriptDelegate< InThreadSafetyMode >::AddUnique ( const TScriptDelegate< OtherThreadSafetyMode > & InDelegate )

inline

◆ AddUnique() [2/2]

template<typename InThreadSafetyMode >

void TMulticastScriptDelegate< InThreadSafetyMode >::AddUnique ( const TScriptDelegate< ThreadSafetyMode > & InDelegate )

inline

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

Parameters

InDelegate Delegate to add

◆ AddUniqueInternal()

template<typename InThreadSafetyMode >

void TMulticastScriptDelegate< InThreadSafetyMode >::AddUniqueInternal ( UnicastDelegateType && InDelegate )

inlineprotected

Adds a function delegate to this multi-cast delegate's invocation list, if a delegate with that signature doesn't already exist

Parameters

InDelegate Delegate to add

◆ Clear()

template<typename InThreadSafetyMode >

void TMulticastScriptDelegate< InThreadSafetyMode >::Clear ( )

inline

Removes all functions from this delegate's invocation list

◆ CompactInvocationList()

template<typename InThreadSafetyMode >

void TMulticastScriptDelegate< InThreadSafetyMode >::CompactInvocationList ( ) const

inlineprotected

Cleans up any delegates in our invocation list that have expired (performance is O(N))

◆ Contains() [1/3]

template<typename InThreadSafetyMode >

template<typename OtherThreadSafetyMode >

bool TMulticastScriptDelegate< InThreadSafetyMode >::Contains ( const TScriptDelegate< OtherThreadSafetyMode > & InDelegate ) const

inline

◆ Contains() [2/3]

template<typename InThreadSafetyMode >

bool TMulticastScriptDelegate< InThreadSafetyMode >::Contains ( const TScriptDelegate< ThreadSafetyMode > & InDelegate ) const

inline

Checks whether a function delegate is already a member of this multi-cast delegate's invocation list

Parameters

InDelegate Delegate to check

Returns: True if the delegate is already in the list.

◆ Contains() [3/3]

template<typename InThreadSafetyMode >

bool TMulticastScriptDelegate< InThreadSafetyMode >::Contains	(	const UObject *	InObject,
		FName	InFunctionName
	)		const

inline

Checks whether a function delegate is already a member of this multi-cast delegate's invocation list

Parameters

InObject	Object of the delegate to check
InFunctionName	Function name of the delegate to check

Returns: True if the delegate is already in the list.

◆ GetAllObjectRefsEvenIfUnreachable()

template<typename InThreadSafetyMode >

TArray< typename UnicastDelegateType::WeakPtrType * > TMulticastScriptDelegate< InThreadSafetyMode >::GetAllObjectRefsEvenIfUnreachable ( ) const

inline

◆ GetAllObjects()

template<typename InThreadSafetyMode >

TArray< UObject * > TMulticastScriptDelegate< InThreadSafetyMode >::GetAllObjects ( ) const

inline

Returns all objects associated with this multicast-delegate. For advanced uses only – you should never need call this function in normal circumstances.

Returns: List of objects bound to this delegate

◆ GetAllObjectsEvenIfUnreachable()

template<typename InThreadSafetyMode >

TArray< UObject * > TMulticastScriptDelegate< InThreadSafetyMode >::GetAllObjectsEvenIfUnreachable ( ) const

inline

Returns all objects associated with this multicast-delegate, even if unreachable. For advanced uses only – you should never need call this function in normal circumstances.

Returns: List of objects bound to this delegate

◆ GetAllocatedSize()

template<typename InThreadSafetyMode >

SIZE_T TMulticastScriptDelegate< InThreadSafetyMode >::GetAllocatedSize ( ) const

inline

Returns the amount of memory allocated by this delegate's invocation list, not including sizeof(*this).

◆ IsBound()

template<typename InThreadSafetyMode >

bool TMulticastScriptDelegate< InThreadSafetyMode >::IsBound ( ) const

inline

Checks to see if any functions are bound to this multi-cast delegate

Returns: True if any functions are bound

◆ operator=() [1/2]

template<typename InThreadSafetyMode >

TMulticastScriptDelegate & TMulticastScriptDelegate< InThreadSafetyMode >::operator= ( const TMulticastScriptDelegate< InThreadSafetyMode > & Other )

inline

◆ operator=() [2/2]

template<typename InThreadSafetyMode >

TMulticastScriptDelegate & TMulticastScriptDelegate< InThreadSafetyMode >::operator= ( TMulticastScriptDelegate< InThreadSafetyMode > && Other )

inline

◆ ProcessMulticastDelegate()

template<typename InThreadSafetyMode >

template<class UObjectTemplate >

void TMulticastScriptDelegate< InThreadSafetyMode >::ProcessMulticastDelegate ( void * Parameters ) const

inline

Executes a multi-cast delegate by calling all functions on objects bound to the delegate. Always safe to call, even if when no objects are bound, or if objects have expired. In general, you should never call this function directly. Instead, call Broadcast() on a derived class. Note that this function is not truly const because it will clean up any compactable entries in the invocation list.

Parameters

Params Parameter structure