Ark Server API (ASA) - Wiki
Loading...
Searching...
No Matches
Public Member Functions | Private Types | Friends | List of all members
TDelegateBase< UserPolicy > Class Template Reference

#include <DelegateBase.h>

+ Inheritance diagram for TDelegateBase< UserPolicy >:
+ Collaboration diagram for TDelegateBase< UserPolicy >:

Public Member Functions

FORCEINLINE struct UObject * GetUObject () const
 
FORCEINLINE bool IsBound () const
 
FORCEINLINE const void * GetObjectForTimerManager () const
 
uint64 GetBoundProgramCounterForTimerManager () const
 
FORCEINLINE bool IsBoundToObject (void const *InUserObject) const
 
FORCEINLINE FDelegateHandle GetHandle () const
 

Private Types

using Super = typename UserPolicy::FDelegateExtras
 

Friends

template<typename >
class TMulticastDelegateBase
 

Detailed Description

template<typename UserPolicy>
class TDelegateBase< UserPolicy >

Definition at line 200 of file DelegateBase.h.

Member Typedef Documentation

◆ Super

template<typename UserPolicy >
using TDelegateBase< UserPolicy >::Super = typename UserPolicy::FDelegateExtras
private

Definition at line 205 of file DelegateBase.h.

Member Function Documentation

◆ GetBoundProgramCounterForTimerManager()

template<typename UserPolicy >
uint64 TDelegateBase< UserPolicy >::GetBoundProgramCounterForTimerManager ( ) const
inline

Returns the address of the method pointer which can be used to learn the address of the function that will be executed. Returns nullptr if this delegate type does not directly invoke a function pointer.

Note: Only intended to be used to aid debugging of delegates.

Returns
The address of the function pointer that would be executed by this delegate

Definition at line 278 of file DelegateBase.h.

◆ GetHandle()

template<typename UserPolicy >
FORCEINLINE FDelegateHandle TDelegateBase< UserPolicy >::GetHandle ( ) const
inline

Gets a handle to the delegate.

Returns
The delegate instance.

Definition at line 310 of file DelegateBase.h.

◆ GetObjectForTimerManager()

template<typename UserPolicy >
FORCEINLINE const void * TDelegateBase< UserPolicy >::GetObjectForTimerManager ( ) const
inline

Returns a pointer to an object bound to this delegate, intended for quick lookup in the timer manager,

Returns
A pointer to an object referenced by the delegate.

Definition at line 262 of file DelegateBase.h.

◆ GetUObject()

template<typename UserPolicy >
FORCEINLINE struct UObject * TDelegateBase< UserPolicy >::GetUObject ( ) const
inline

If this is a UFunction or UObject delegate, return the UObject.

Returns
The object associated with this delegate if there is one.

Definition at line 235 of file DelegateBase.h.

◆ IsBound()

template<typename UserPolicy >
FORCEINLINE bool TDelegateBase< UserPolicy >::IsBound ( ) const
inline

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

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

Definition at line 250 of file DelegateBase.h.

◆ IsBoundToObject()

template<typename UserPolicy >
FORCEINLINE bool TDelegateBase< UserPolicy >::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.

Definition at line 293 of file DelegateBase.h.

Friends And Related Symbol Documentation

◆ TMulticastDelegateBase

template<typename UserPolicy >
template<typename >
friend class TMulticastDelegateBase
friend

Definition at line 203 of file DelegateBase.h.

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