1. Epic GamesDeveloper
  3. TMulticastScriptDelegate

TMulticastScriptDelegate

Script multi-cast delegate base class

API > API/Runtime > API/Runtime/Core

Script multi-cast delegate base class

   
Name TMulticastScriptDelegate
Type class
Header File /Engine/Source/Runtime/Core/Public/UObject/ScriptDelegates.h
Include Path #include "UObject/ScriptDelegates.h"

Syntax

template<typename InThreadSafetyMode>  
class TMulticastScriptDelegate : public TDelegateAccessHandlerBase< UE::Core::Private::TScriptDelegateTraits< InThreadSafetyMode >::ThreadSafetyMode >

Inheritance Hierarchy

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers
  UObject/ScriptDelegates.h  
  UObject/ScriptDelegates.h  
  UObject/ScriptDelegates.h  

Typedefs

Name Type Remarks Include Path
InvocationListType TArray< UnicastDelegateType >   UObject/ScriptDelegates.h
Super TDelegateAccessHandlerBase< InThreadSafetyMode >   UObject/ScriptDelegates.h
ThreadSafetyMode typename UE::Core::Private::TScriptDelegateTraits< InThreadSafetyMode >::ThreadSafetyMode   UObject/ScriptDelegates.h
UnicastDelegateType TScriptDelegate< typename UE::Core::Private::TScriptDelegateTraits< InThreadSafetyMode >::UnicastThreadSafetyModeForMulticasts >   UObject/ScriptDelegates.h

Functions

Public

Name Remarks Include Path Unreal Specifiers

void Add ( const TScriptDelegate< OtherThreadSafetyMode >& InDelegate
)

   UObject/ScriptDelegates.h  

void Add ( const TScriptDelegate< ThreadSafetyMode >& InDelegate
)

 Adds a function delegate to this multi-cast delegate's invocation list UObject/ScriptDelegates.h  

void AddUnique ( const TScriptDelegate< OtherThreadSafetyMode >& InDelegate
)

   UObject/ScriptDelegates.h  

void AddUnique ( const TScriptDelegate< ThreadSafetyMode >& InDelegate
)

 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 UObject/ScriptDelegates.h  

void Clear()

 Removes all functions from this delegate's invocation list UObject/ScriptDelegates.h  

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

 Checks whether a function delegate is already a member of this multi-cast delegate's invocation list UObject/ScriptDelegates.h  

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

 Checks whether a function delegate is already a member of this multi-cast delegate's invocation list UObject/ScriptDelegates.h  

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

   UObject/ScriptDelegates.h  

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

   UObject/ScriptDelegates.h  

TArray< UObject * > GetAllObjects ()

 Returns all objects associated with this multicast-delegate. UObject/ScriptDelegates.h  
Returns all objects associated with this multicast-delegate, even if unreachable. UObject/ScriptDelegates.h  

SIZE_T GetAllocatedSize()

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

bool IsBound()

 Checks to see if any functions are bound to this multi-cast delegate UObject/ScriptDelegates.h  

void ProcessMulticastDelegate ( void* Parameters
) const

 Executes a multi-cast delegate by calling all functions on objects bound to the delegate. UObject/ScriptDelegates.h  

void Remove ( const TScriptDelegate< ThreadSafetyMode >& InDelegate
)

 Removes a function from this multi-cast delegate's invocation list (performance is O(N)). UObject/ScriptDelegates.h  

void Remove ( const TScriptDelegate< OtherThreadSafetyMode >& InDelegate
)

   UObject/ScriptDelegates.h  

void Remove ( const UObject* InObject,
FName InFunctionName
)

 Removes a function from this multi-cast delegate's invocation list (performance is O(N)). UObject/ScriptDelegates.h  

void RemoveAll ( const UObject* Object
)

 Removes all delegate bindings from this multicast delegate's invocation list that are bound to the specified object. UObject/ScriptDelegates.h  

FString ToString()

 Converts this delegate to a string representation UObject/ScriptDelegates.h  

Protected

Name Remarks Include Path Unreal Specifiers

void AddInternal ( UnicastDelegateType&& InDelegate
)

 Adds a function delegate to this multi-cast delegate's invocation list UObject/ScriptDelegates.h  

void AddUniqueInternal ( UnicastDelegateType&& InDelegate
)

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

void CompactInvocationList()

 Cleans up any delegates in our invocation list that have expired (performance is O(N)) UObject/ScriptDelegates.h  

void RemoveInternal ( const UnicastDelegateType& InDelegate
) const

 Removes a function from this multi-cast delegate's invocation list (performance is O(N)). UObject/ScriptDelegates.h  

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

 Removes a function from this multi-cast delegate's invocation list (performance is O(N)). UObject/ScriptDelegates.h  

Operators

Name Remarks Include Path Unreal Specifiers
  UObject/ScriptDelegates.h  
  UObject/ScriptDelegates.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page