TMulticastDelegateBase

Abstract base class for multicast delegates.

Windows
MacOS
Linux

References

Module

Core

Header

/Engine/Source/Runtime/Core/Public/Delegates/DelegateBase.h

Include

#include "Delegates/DelegateBase.h"

Syntax

template<typename UserPolicy>
class TMulticastDelegateBase

Remarks

Abstract base class for multicast delegates.

Constructors

Name Description

Protected function

TMulticastDelegateBase()

Hidden default constructor.

Functions

Name Description

Protected function

FDelegateHan...

 

AddDelegateInstance

(
    TDelegateBase< UserPolicy >&& NewD...
)

Adds the given delegate instance to the invocation list.

Public function

void

 

Clear()

Removes all functions from this delegate's invocation list.

Protected function

void

 

CompactInvocationList

(
    bool CheckThreshold
)

Removes any expired or deleted functions from the invocation list.

Protected function Static

auto *

 

GetDelegateInstanceProtectedHelper

(
    const DelegateType& Base
)

Helper function for derived classes of TMulticastDelegateBase to get at the delegate instance.

Protected function

InvocationLi...

 

GetInvocationList()

Gets a read-only reference to the invocation list.

Protected function Const

const Invoca...

 

GetInvocationList()

Protected function Const

int32

 

GetInvocationListLockCount()

Returns the lock counter for the invocation list.

Public function Const

bool

 

IsBound()

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

Public function Const

bool

 

IsBoundToObject

(
    void const* InUserObject
)

Checks to see if any functions are bound to the given user object.

Protected function Const

void

 

LockInvocationList()

Increments the lock counter for the invocation list.

Public function

int32

 

RemoveAll

(
    const void* InUserObject
)

Removes all functions from this multi-cast delegate's invocation list that are bound to the specified UserObject.

Protected function

bool

 

RemoveDelegateInstance

(
    FDelegateHandle Handle
)

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

Protected function Const

void

 

UnlockInvocationList()

Decrements the lock counter for the invocation list.

Typedefs

Name

Description

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