Navigation
API > API/Runtime > API/Runtime/Core
Abstract base class for multicast delegates.
| Name | TMulticastDelegateBase |
| Type | class |
| Header File | /Engine/Source/Runtime/Core/Public/Delegates/MulticastDelegateBase.h |
| Include Path | #include "Delegates/MulticastDelegateBase.h" |
Syntax
template<typename UserPolicy>
class TMulticastDelegateBase : public TDelegateAccessHandlerBase< UserPolicy::FThreadSafetyMode >
Inheritance Hierarchy
- TDelegateAccessHandlerBase → TMulticastDelegateBase
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Hidden default constructor. | Delegates/MulticastDelegateBase.h | ||
TMulticastDelegateBase
(
TMulticastDelegateBase&& Other |
Delegates/MulticastDelegateBase.h |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| InvocationListType | TArray< UnicastDelegateType, FMulticastInvocationListAllocatorType > | Delegates/MulticastDelegateBase.h | |
| Super | TDelegateAccessHandlerBase< typename UserPolicy::FThreadSafetyMode > | Delegates/MulticastDelegateBase.h | |
| UnicastDelegateType | TDelegateBase< FNotThreadSafeNotCheckedDelegateMode > | Individual bindings are not checked for races as it's done for the parent delegate | Delegates/MulticastDelegateBase.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| CompactionThreshold | int32 | Used to determine when a compaction should happen. | Delegates/MulticastDelegateBase.h | |
| InvocationList | InvocationListType | Holds the collection of delegate instances to invoke. | Delegates/MulticastDelegateBase.h | |
| InvocationListLockCount | int32 | Holds a lock counter for the invocation list. | Delegates/MulticastDelegateBase.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void Clear() |
Removes all functions from this delegate's invocation list. | Delegates/MulticastDelegateBase.h | |
SIZE_T GetAllocatedSize() |
Returns the amount of memory allocated by this delegate's invocation list and the delegates stored within it, not including sizeof(*this). | Delegates/MulticastDelegateBase.h | |
bool IsBound() |
Checks to see if any functions are bound to this multi-cast delegate. | Delegates/MulticastDelegateBase.h | |
bool IsBoundToObject
(
FDelegateUserObjectConst InUserObject |
Checks to see if any functions are bound to the given user object. | Delegates/MulticastDelegateBase.h | |
int32 RemoveAll
(
FDelegateUserObjectConst InUserObject |
Removes all functions from this multi-cast delegate's invocation list that are bound to the specified UserObject. | Delegates/MulticastDelegateBase.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FDelegateHandle AddDelegateInstance
(
NewDelegateType&& NewDelegateBaseRef |
Adds the given delegate instance to the invocation list. | Delegates/MulticastDelegateBase.h | |
void Broadcast
(
ParamTypes... Params |
Delegates/MulticastDelegateBase.h | ||
void CopyFrom
(
const TMulticastDelegateBase& Other |
Delegates/MulticastDelegateBase.h | ||
bool RemoveDelegateInstance
(
FDelegateHandle Handle |
Removes a function from this multi-cast delegate's invocation list (performance is O(N)). | Delegates/MulticastDelegateBase.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
TMulticastDelegateBase & operator=
(
TMulticastDelegateBase&& Other |
Delegates/MulticastDelegateBase.h |