Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

Light Theme

Dark Theme

TScriptDelegate

Script delegate base class.

Windows

MacOS

Linux

Inheritance Hierarchy

TScriptDelegate

TBaseDynamicDelegate

References

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

Syntax

template<typename TWeakPtr>
class TScriptDelegate

Remarks

Script delegate base class.

Variables

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

Constructors

	Name	Description
	TScriptDelegate()	Although templated, the parameter is not intended to be anything other than the default, and is only a template for module organization reasons.

Functions

	Name	Description
void	BindUFunction ( UObject* InObject, const FName& InFunctionName )	Binds a UFunction to this delegate.
void	Clear()	Unbinds this delegate (another name to provide a similar interface to TMulticastScriptDelegate)
FName	GetFunctionName()	Gets the name of the function to call on the bound object
const UObjec...	GetUObject()	Gets the object bound to this delegate (const)
UObject *...	GetUObject()	Gets the object bound to this delegate
UObject *...	GetUObjectEvenIfUnreachable()	Gets the object bound to this delegate, even if the object is unreachable
const UObjec...	GetUObjectEvenIfUnreachable()	Gets the object bound to this delegate (const), even if the object is unreachable
bool	IsBound()	Checks to see if the user object bound to this delegate is still valid
bool	IsBoundToObject ( void const* InUserObject )	Checks to see if this delegate is bound to the given user object.
bool	IsBoundToObjectEvenIfUnreachable ( void const* InUserObject )	Checks to see if this delegate is bound to the given user object, even if the object is unreachable.
bool	IsCompactable()	Checks to see if the user object bound to this delegate will ever be valid again
void	ProcessDelegate ( void* Parameters )	Void ProcessDelegate(void* Parameters) const;
FString	ToString()	Converts this delegate to a string representation
void	Unbind()	Unbinds this delegate

Operators

	Name	Description
bool	operator!= ( const TScriptDelegate& Other )
void	operator= ( const TScriptDelegate& Other )
bool	operator== ( const TScriptDelegate& Other )	Comparison operators

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss