1. Epic GamesDeveloper
  3. TMulticastScriptDelegate

TMulticastScriptDelegate

Script multi-cast delegate base class

Unreal Engine C++ API Reference > Runtime > Core > UObject

Inheritance Hierarchy

References

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

Syntax

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

Remarks

Script multi-cast delegate base class

Variables

  Type Name Description
Protected variable InvocationListType InvocationList Ordered list functions to invoke when the Broadcast function is called

Constructors

  Type Name Description
Public function    
Public function    
Public function    

Functions

  Type Name Description
Public function void

Add ( const TScriptDelegate< ThreadSafetyMode >& InDelegate
)

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

AddInternal ( UnicastDelegateType&& InDelegate
)

 Adds a function delegate to this multi-cast delegate's invocation list
Public function 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
Protected function void Adds a function delegate to this multi-cast delegate's invocation list, if a delegate with that signature doesn't already exist
Public function void

Clear ()

 Removes all functions from this delegate's invocation list
Protected function Const void Cleans up any delegates in our invocation list that have expired (performance is O(N))
Public function Const bool

Contains ( const TScriptDelegate< ThreadSafetyMode >& InDelegate
)

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

Contains ( const UObject* InObject,
FName InFunctionName
)

 Checks whether a function delegate is already a member of this multi-cast delegate's invocation list
Public function Const TArray< typename UnicastDelegateType::WeakPtrType * >  
Public function Const TArray< UObject * > Returns all objects associated with this multicast-delegate.
Public function Const TArray< UObject * > Returns all objects associated with this multicast-delegate, even if unreachable.
Public function Const SIZE_T Returns the amount of memory allocated by this delegate's invocation list, not including sizeof(*this).
Public function Const bool

IsBound ()

 Checks to see if any functions are bound to this multi-cast delegate
Public function Const void

ProcessMulticastDelegate ( void* Parameters
)

 Executes a multi-cast delegate by calling all functions on objects bound to the delegate.
Public function void

Remove ( const TScriptDelegate< ThreadSafetyMode >& InDelegate
)

 Removes a function from this multi-cast delegate's invocation list (performance is O(N)).
Public function void

Remove ( const UObject* InObject,
FName InFunctionName
)

 Removes a function from this multi-cast delegate's invocation list (performance is O(N)).
Public function void

RemoveAll ( const UObject* Object
)

 Removes all delegate bindings from this multicast delegate's invocation list that are bound to the specified object.
Protected function Const void

RemoveInternal ( const UnicastDelegateType& InDelegate
)

 Removes a function from this multi-cast delegate's invocation list (performance is O(N)).
Protected function Const void

RemoveInternal ( const UObject* InObject,
FName InFunctionName
)

 Removes a function from this multi-cast delegate's invocation list (performance is O(N)).
Public function Const FString Converts this delegate to a string representation

Operators

  Type Name Description
Public function TMulticastScriptDelegate &  
Public function TMulticastScriptDelegate &  

Typedefs

Name Description
InvocationListType  
Super  
ThreadSafetyMode  
UnicastDelegateType  

Deprecated Functions

  Type Name Description
Public function void

Add ( const TScriptDelegate< OtherThreadSafetyMode >& InDelegate
)

 Deprecated - remove after TScriptDelegateTraits is removed
Public function void

AddUnique ( const TScriptDelegate< OtherThreadSafetyMode >& InDelegate
)

 Deprecated - remove after TScriptDelegateTraits is removed
Public function Const bool

Contains ( const TScriptDelegate< OtherThreadSafetyMode >& InDelegate
)

 Deprecated - remove after TScriptDelegateTraits is removed
Public function void

Remove ( const TScriptDelegate< OtherThreadSafetyMode >& InDelegate
)

 Deprecated - remove after TScriptDelegateTraits is removed

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page