1. Epic GamesDeveloper
  3. TScriptDelegate

TScriptDelegate

Script delegate base class.

API > API/Runtime > API/Runtime/Core

Script delegate base class.

   
Name TScriptDelegate
Type class
Header File /Engine/Source/Runtime/Core/Public/UObject/ScriptDelegates.h
Include Path #include "UObject/ScriptDelegates.h"

Syntax

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

Inheritance Hierarchy

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

TScriptDelegate ( const TScriptDelegate& Other
)

   UObject/ScriptDelegates.h  
Default constructor. UObject/ScriptDelegates.h  

TScriptDelegate ( const TScriptDelegate< OtherThreadSafetyMode >& Other
)

   UObject/ScriptDelegates.h  

Typedefs

Name Type Remarks Include Path
Super TDelegateAccessHandlerBase< ThreadSafetyMode >   UObject/ScriptDelegates.h
ThreadSafetyMode typename UE::Core::Private::TScriptDelegateTraits< InThreadSafetyMode >::ThreadSafetyMode   UObject/ScriptDelegates.h
WeakPtrType typename UE::Core::Private::TScriptDelegateTraits< InThreadSafetyMode >::WeakPtrType   UObject/ScriptDelegates.h

Functions

Public

Name Remarks Include Path Unreal Specifiers

void BindUFunction ( UObject* InObject,
const FName& InFunctionName
)

 Binds a UFunction to this delegate. UObject/ScriptDelegates.h  

void Clear()

 Unbinds this delegate (another name to provide a similar interface to TMulticastScriptDelegate) UObject/ScriptDelegates.h  

FName GetFunctionName()

 Gets the name of the function to call on the bound object UObject/ScriptDelegates.h  

UObject * GetUObject ()

 Gets the object bound to this delegate UObject/ScriptDelegates.h  

const UObject * GetUObject ()

 Gets the object bound to this delegate (const) UObject/ScriptDelegates.h  

const UObject * GetUObjectEvenIfUnreachable ()

 Gets the object bound to this delegate (const), even if the object is unreachable UObject/ScriptDelegates.h  
Gets the object bound to this delegate, even if the object is unreachable UObject/ScriptDelegates.h  

WeakPtrType & GetUObjectRef ()

   UObject/ScriptDelegates.h  

const WeakPtrType & GetUObjectRef ()

   UObject/ScriptDelegates.h  

bool IsBound()

 Checks to see if the user object bound to this delegate is still valid UObject/ScriptDelegates.h  

bool IsBoundToObject ( void const* InUserObject
) const

 Checks to see if this delegate is bound to the given user object. UObject/ScriptDelegates.h  

bool IsBoundToObjectEvenIfUnreachable ( void const* InUserObject
) const

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

bool IsCompactable()

 Checks to see if the user object bound to this delegate will ever be valid again UObject/ScriptDelegates.h  

void ProcessDelegate ( void* Parameters
) const

 Void ProcessDelegate(void* Parameters) const; UObject/ScriptDelegates.h  

FString ToString()

 Converts this delegate to a string representation UObject/ScriptDelegates.h  

void Unbind()

 Unbinds this delegate UObject/ScriptDelegates.h  

Static

Name Remarks Include Path Unreal Specifiers

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

   UObject/ScriptDelegates.h  

Operators

Name Remarks Include Path Unreal Specifiers

bool operator!= ( const TScriptDelegate& Other
) const

   UObject/ScriptDelegates.h  

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

   UObject/ScriptDelegates.h  
  UObject/ScriptDelegates.h  

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

   UObject/ScriptDelegates.h  

bool operator== ( const TScriptDelegate& Other
) const

 Comparison operators UObject/ScriptDelegates.h  

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

   UObject/ScriptDelegates.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page