1. Epic GamesDeveloper
  3. TScriptDelegate

TScriptDelegate

Script delegate base class.

Unreal Engine C++ API Reference > Runtime > Core > UObject

Inheritance Hierarchy

References

   
Module Core
Header /Engine/Source/Runtime/Core/Public/UObject/ScriptDelegates.h
Include #include "UObject/ScriptDelegates.h"

Syntax

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

Remarks

Script delegate base class.

Variables

  Type Name Description
Protected variable FName FunctionName Name of the function to call on the bound object
Protected variable WeakPtrType Object The object bound to this delegate, or nullptr if no object is bound

Constructors

  Type Name Description
Public function   Default constructor.
Public function  

TScriptDelegate ( const TScriptDelegate& Other
)

  
Public function  

TScriptDelegate ( const TScriptDelegate< OtherThreadSafetyMode >& Other
)

TScriptDelegate ( const TScriptDelegate< OtherThreadSafetyMode >& Other
)

 Deprecated - remove after TScriptDelegateTraits is removed

Functions

  Type Name Description
Public function void

BindUFunction ( UObject* InObject,
const FName& InFunctionName
)

 Binds a UFunction to this delegate.
Public function void

Clear ()

 Unbinds this delegate (another name to provide a similar interface to TMulticastScriptDelegate)
Public function Static TScriptDelegate

CopyFrom ( const TScriptDelegate< OtherThreadSafetyMode >& Other
)

  
Public function Const FName Gets the name of the function to call on the bound object
Public function Const const UObject * Gets the object bound to this delegate (const)
Public function UObject * Gets the object bound to this delegate
Public function Const const UObject * Gets the object bound to this delegate (const), even if the object is unreachable
Public function UObject * Gets the object bound to this delegate, even if the object is unreachable
Public function WeakPtrType &  
Public function Const bool

IsBound ()

 Checks to see if the user object bound to this delegate is still valid
Public function Const bool

IsBoundToObject ( void const* InUserObject
)

 Checks to see if this delegate is bound to the given user object.
Public function Const bool

IsBoundToObjectEvenIfUnreachable ( void const* InUserObject
)

 Checks to see if this delegate is bound to the given user object, even if the object is unreachable.
Public function Const bool Checks to see if the user object bound to this delegate will ever be valid again
Public function Const void

ProcessDelegate ( void* Parameters
)

 Void ProcessDelegate(void* Parameters) const;
Public function Const FString Converts this delegate to a string representation
Public function void

Unbind ()

 Unbinds this delegate

Operators

  Type Name Description
Public function Const bool

operator!= ( const TScriptDelegate& Other
)

  
Public function TScriptDelegate &

operator= ( const TScriptDelegate& Other
)

  
Public function Const bool

operator== ( const TScriptDelegate& Other
)

 Comparison operators

Typedefs

Name Description
Super  
ThreadSafetyMode  
WeakPtrType  

Deprecated Functions

  Type Name Description
Public function Const bool

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

 Deprecated - remove after TScriptDelegateTraits is removed
Public function TScriptDelegate &

operator= ( const TScriptDelegate< OtherThreadSafetyMode >& Other
)

 Deprecated - remove after TScriptDelegateTraits is removed
Public function Const bool

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

 Deprecated - remove after TScriptDelegateTraits is removed
Public function  

TScriptDelegate ( const TScriptDelegate< OtherThreadSafetyMode >& Other
)

TScriptDelegate ( const TScriptDelegate< OtherThreadSafetyMode >& Other
)

 Deprecated - remove after TScriptDelegateTraits is removed

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page