TScriptDelegate< InThreadSafetyMode > Class Template Reference

#include <ScriptDelegates.h>

Inheritance diagram for TScriptDelegate< InThreadSafetyMode >:

Public Types
using	ThreadSafetyMode = typename UE::Core::Private::TScriptDelegateTraits< InThreadSafetyMode >::ThreadSafetyMode
using	WeakPtrType = typename UE::Core::Private::TScriptDelegateTraits< InThreadSafetyMode >::WeakPtrType

Public Member Functions
	TScriptDelegate ()
	TScriptDelegate (const TScriptDelegate &Other)
template<typename OtherThreadSafetyMode >
	TScriptDelegate (const TScriptDelegate< OtherThreadSafetyMode > &Other)
TScriptDelegate &	operator= (const TScriptDelegate &Other)
template<typename OtherThreadSafetyMode >
TScriptDelegate &	operator= (const TScriptDelegate< OtherThreadSafetyMode > &Other)
void	BindUFunction (UObject *InObject, const FName &InFunctionName)
bool	IsBound () const
bool	IsBoundToObject (void const *InUserObject) const
bool	IsBoundToObjectEvenIfUnreachable (void const *InUserObject) const
bool	IsCompactable () const
void	Unbind ()
void	Clear ()
template<class UObjectTemplate >
FString	ToString () const
bool	operator== (const TScriptDelegate &Other) const
template<typename OtherThreadSafetyMode >
bool	operator== (const TScriptDelegate< OtherThreadSafetyMode > &Other) const
UE_FORCEINLINE_HINT bool	operator!= (const TScriptDelegate &Other) const
template<typename OtherThreadSafetyMode >
UE_FORCEINLINE_HINT bool	operator!= (const TScriptDelegate< OtherThreadSafetyMode > &Other) const
UObject *	GetUObject ()
const UObject *	GetUObject () const
UObject *	GetUObjectEvenIfUnreachable ()
const UObject *	GetUObjectEvenIfUnreachable () const
WeakPtrType &	GetUObjectRef ()
const WeakPtrType &	GetUObjectRef () const
FName	GetFunctionName () const
template<class UObjectTemplate >
void	ProcessDelegate (void *Parameters) const

Static Public Member Functions
template<typename OtherThreadSafetyMode >
static TScriptDelegate	CopyFrom (const TScriptDelegate< OtherThreadSafetyMode > &Other)

Protected Attributes
WeakPtrType	Object
FName	FunctionName

Friends
template<typename >
class	TScriptDelegate
template<typename >
class	TMulticastScriptDelegate
class	FCallDelegateHelper
struct	TIsZeroConstructType< TScriptDelegate >
FArchive &	operator<< (FArchive &Ar, TScriptDelegate &D)
void	operator<< (FStructuredArchive::FSlot Slot, TScriptDelegate &D)
uint32	GetTypeHash (const TScriptDelegate &Delegate)

Detailed Description

template<typename InThreadSafetyMode>
class TScriptDelegate< InThreadSafetyMode >

Script delegate base class.

Member Typedef Documentation

ThreadSafetyMode

template<typename InThreadSafetyMode >

using TScriptDelegate< InThreadSafetyMode >::ThreadSafetyMode = typename UE::Core::Private::TScriptDelegateTraits<InThreadSafetyMode>::ThreadSafetyMode

WeakPtrType

template<typename InThreadSafetyMode >

using TScriptDelegate< InThreadSafetyMode >::WeakPtrType = typename UE::Core::Private::TScriptDelegateTraits<InThreadSafetyMode>::WeakPtrType

Constructor & Destructor Documentation

TScriptDelegate() [1/3]

template<typename InThreadSafetyMode >

TScriptDelegate< InThreadSafetyMode >::TScriptDelegate ( )

inline

Default constructor.

TScriptDelegate() [2/3]

template<typename InThreadSafetyMode >

TScriptDelegate< InThreadSafetyMode >::TScriptDelegate ( const TScriptDelegate< InThreadSafetyMode > &  Other )

inline

TScriptDelegate() [3/3]

template<typename InThreadSafetyMode >

template<typename OtherThreadSafetyMode >

TScriptDelegate< InThreadSafetyMode >::TScriptDelegate ( const TScriptDelegate< OtherThreadSafetyMode > &  Other )

inline

Member Function Documentation

BindUFunction()

template<typename InThreadSafetyMode >

void TScriptDelegate< InThreadSafetyMode >::BindUFunction ( UObject *  InObject, const FName &  InFunctionName  )

inline

Binds a UFunction to this delegate.

Parameters

InObject	The object to call the function on.
InFunctionName	The name of the function to call.

Clear()

template<typename InThreadSafetyMode >

void TScriptDelegate< InThreadSafetyMode >::Clear ( )

inline

Unbinds this delegate (another name to provide a similar interface to TMulticastScriptDelegate)

CopyFrom()

template<typename InThreadSafetyMode >

template<typename OtherThreadSafetyMode >

static TScriptDelegate TScriptDelegate< InThreadSafetyMode >::CopyFrom ( const TScriptDelegate< OtherThreadSafetyMode > &  Other )

inlinestatic

GetFunctionName()

template<typename InThreadSafetyMode >

FName TScriptDelegate< InThreadSafetyMode >::GetFunctionName ( ) const

inline

Gets the name of the function to call on the bound object

Returns

Function name

GetUObject() [1/2]

template<typename InThreadSafetyMode >

UObject * TScriptDelegate< InThreadSafetyMode >::GetUObject ( )

inline

Gets the object bound to this delegate

Returns

The object

GetUObject() [2/2]

template<typename InThreadSafetyMode >

const UObject * TScriptDelegate< InThreadSafetyMode >::GetUObject ( ) const

inline

Gets the object bound to this delegate (const)

Returns

The object

GetUObjectEvenIfUnreachable() [1/2]

template<typename InThreadSafetyMode >

UObject * TScriptDelegate< InThreadSafetyMode >::GetUObjectEvenIfUnreachable ( )

inline

Gets the object bound to this delegate, even if the object is unreachable

Returns

The object

GetUObjectEvenIfUnreachable() [2/2]

template<typename InThreadSafetyMode >

const UObject * TScriptDelegate< InThreadSafetyMode >::GetUObjectEvenIfUnreachable ( ) const

inline

Gets the object bound to this delegate (const), even if the object is unreachable

Returns

The object

GetUObjectRef() [1/2]

template<typename InThreadSafetyMode >

WeakPtrType & TScriptDelegate< InThreadSafetyMode >::GetUObjectRef ( )

inline

GetUObjectRef() [2/2]

template<typename InThreadSafetyMode >

const WeakPtrType & TScriptDelegate< InThreadSafetyMode >::GetUObjectRef ( ) const

inline

IsBound()

template<typename InThreadSafetyMode >

bool TScriptDelegate< InThreadSafetyMode >::IsBound ( ) const

inline

Checks to see if the user object bound to this delegate is still valid

Returns

True if the object is still valid and it's safe to execute the function call

IsBoundToObject()

template<typename InThreadSafetyMode >

bool TScriptDelegate< InThreadSafetyMode >::IsBoundToObject ( void const *  InUserObject ) const

inline

Checks to see if this delegate is bound to the given user object.

Returns

True if this delegate is bound to InUserObject, false otherwise.

IsBoundToObjectEvenIfUnreachable()

template<typename InThreadSafetyMode >

bool TScriptDelegate< InThreadSafetyMode >::IsBoundToObjectEvenIfUnreachable ( void const *  InUserObject ) const

inline

Checks to see if this delegate is bound to the given user object, even if the object is unreachable.

Returns

True if this delegate is bound to InUserObject, false otherwise.

IsCompactable()

template<typename InThreadSafetyMode >

bool TScriptDelegate< InThreadSafetyMode >::IsCompactable ( ) const

inline

Checks to see if the user object bound to this delegate will ever be valid again

Returns

True if the object is still valid and it's safe to execute the function call

operator!=() [1/2]

template<typename InThreadSafetyMode >

UE_FORCEINLINE_HINT bool TScriptDelegate< InThreadSafetyMode >::operator!= ( const TScriptDelegate< InThreadSafetyMode > &  Other ) const

inline

operator!=() [2/2]

template<typename InThreadSafetyMode >

template<typename OtherThreadSafetyMode >

UE_FORCEINLINE_HINT bool TScriptDelegate< InThreadSafetyMode >::operator!= ( const TScriptDelegate< OtherThreadSafetyMode > &  Other ) const

inline

operator=() [1/2]

template<typename InThreadSafetyMode >

TScriptDelegate & TScriptDelegate< InThreadSafetyMode >::operator= ( const TScriptDelegate< InThreadSafetyMode > &  Other )

inline

operator=() [2/2]

template<typename InThreadSafetyMode >

template<typename OtherThreadSafetyMode >

TScriptDelegate & TScriptDelegate< InThreadSafetyMode >::operator= ( const TScriptDelegate< OtherThreadSafetyMode > &  Other )

inline

operator==() [1/2]

template<typename InThreadSafetyMode >

bool TScriptDelegate< InThreadSafetyMode >::operator== ( const TScriptDelegate< InThreadSafetyMode > &  Other ) const

inline

Comparison operators

operator==() [2/2]

template<typename InThreadSafetyMode >

template<typename OtherThreadSafetyMode >

bool TScriptDelegate< InThreadSafetyMode >::operator== ( const TScriptDelegate< OtherThreadSafetyMode > &  Other ) const

inline

ProcessDelegate()

template<typename InThreadSafetyMode >

template<class UObjectTemplate >

void TScriptDelegate< InThreadSafetyMode >::ProcessDelegate ( void *  Parameters ) const

inline

Executes a delegate by calling the named function on the object bound to the delegate. You should always first verify that the delegate is safe to execute by calling IsBound() before calling this function. In general, you should never call this function directly. Instead, call Execute() on a derived class.

Parameters

Parameters

Parameter structure

ToString()

template<typename InThreadSafetyMode >

template<class UObjectTemplate >

FString TScriptDelegate< InThreadSafetyMode >::ToString ( ) const

inline

Converts this delegate to a string representation

Returns

Delegate in string format

Unbind()

template<typename InThreadSafetyMode >

void TScriptDelegate< InThreadSafetyMode >::Unbind ( )

inline

Unbinds this delegate

Friends And Related Symbol Documentation

FCallDelegateHelper

template<typename InThreadSafetyMode >

friend class FCallDelegateHelper

friend

GetTypeHash

template<typename InThreadSafetyMode >

uint32 GetTypeHash ( const TScriptDelegate< InThreadSafetyMode > &  Delegate )

friend

operator<< [1/2]

template<typename InThreadSafetyMode >

FArchive & operator<< ( FArchive &  Ar, TScriptDelegate< InThreadSafetyMode > &  D  )

friend

Delegate serialization

operator<< [2/2]

template<typename InThreadSafetyMode >

void operator<< ( FStructuredArchive::FSlot  Slot, TScriptDelegate< InThreadSafetyMode > &  D  )

friend

Delegate serialization

TIsZeroConstructType< TScriptDelegate >

template<typename InThreadSafetyMode >

friend struct TIsZeroConstructType< TScriptDelegate >

friend

TMulticastScriptDelegate

template<typename InThreadSafetyMode >

template<typename >

friend class TMulticastScriptDelegate

friend

TScriptDelegate

template<typename InThreadSafetyMode >

template<typename >

friend class TScriptDelegate

friend

Member Data Documentation

FunctionName

template<typename InThreadSafetyMode >

FName TScriptDelegate< InThreadSafetyMode >::FunctionName

protected

Name of the function to call on the bound object

Object

template<typename InThreadSafetyMode >

WeakPtrType TScriptDelegate< InThreadSafetyMode >::Object

protected

The object bound to this delegate, or nullptr if no object is bound

---

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

• Engine/Source/Runtime/Core/Public/UObject/ScriptDelegates.h