UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FSparseDelegate Struct Reference

#include <SparseDelegate.h>

+ Inheritance diagram for FSparseDelegate:

Public Member Functions

 FSparseDelegate ()
 
bool IsBound () const
 
void __Internal_AddUnique (const UObject *DelegateOwner, FName DelegateName, FScriptDelegate InDelegate)
 
void __Internal_Remove (const UObject *DelegateOwner, FName DelegateName, const FScriptDelegate &InDelegate)
 
void __Internal_Clear (const UObject *DelegateOwner, FName DelegateName)
 

Protected Attributes

bool bIsBound
 

Friends

class FMulticastSparseDelegateProperty
 

Detailed Description

Base implementation for all sparse delegate types

Constructor & Destructor Documentation

◆ FSparseDelegate()

FSparseDelegate::FSparseDelegate ( )
inline

Member Function Documentation

◆ __Internal_AddUnique()

void FSparseDelegate::__Internal_AddUnique ( const UObject DelegateOwner,
FName  DelegateName,
FScriptDelegate  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
DelegateOwnerUObject that owns the resolved sparse delegate
DelegateNameName of the resolved sparse delegate
InDelegateDelegate to bind to the sparse delegate

NOTE: Only call this function from blueprint sparse delegate infrastructure on a resolved generic FScriptDelegate pointer. Generally from C++ you should call AddUnique() directly.

◆ __Internal_Clear()

void FSparseDelegate::__Internal_Clear ( const UObject DelegateOwner,
FName  DelegateName 
)
inline

Removes all functions from this delegate's invocation list

Parameters
DelegateOwnerUObject that owns the resolved sparse delegate
DelegateNameName of the resolved sparse delegate

NOTE: Only call this function from blueprint sparse delegate infrastructure on a resolved generic FScriptDelegate pointer. Generally from C++ you should call Clear() directly.

◆ __Internal_Remove()

void FSparseDelegate::__Internal_Remove ( const UObject DelegateOwner,
FName  DelegateName,
const FScriptDelegate InDelegate 
)
inline

Removes a function from this multi-cast delegate's invocation list (performance is O(N)). Note that the order of the delegates may not be preserved!

Parameters
DelegateOwnerUObject that owns the resolved sparse delegate
DelegateNameName of the resolved sparse delegate
InDelegateDelegate to remove from the sparse delegate

NOTE: Only call this function from blueprint sparse delegate infrastructure on a resolved generic FScriptDelegate pointer. Generally from C++ you should call Remove() directly.

◆ IsBound()

bool FSparseDelegate::IsBound ( ) const
inline

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

Returns
True if any functions are bound

Friends And Related Symbol Documentation

◆ FMulticastSparseDelegateProperty

Member Data Documentation

◆ bIsBound

bool FSparseDelegate::bIsBound
protected

The documentation for this struct was generated from the following file: