UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FUObjectToken Class Reference

#include <UObjectToken.h>

+ Inheritance diagram for FUObjectToken:

Public Member Functions

virtual EMessageToken::Type GetType () const override
 
virtual const FOnMessageTokenActivatedGetOnMessageTokenActivated () const override
 
virtual const FWeakObjectPtrGetObject () const
 
const FString & GetOriginalObjectPathName () const
 
 DECLARE_DELEGATE_RetVal_TwoParams (FText, FOnGetDisplayName, const UObject *, bool)
 
- Public Member Functions inherited from IMessageToken
virtual ~IMessageToken ()
 
virtual const FTextToText () const
 
virtual TSharedRef< IMessageTokenOnMessageTokenActivated (FOnMessageTokenActivated InMessageTokenActivated)
 
- Public Member Functions inherited from TSharedFromThis< IMessageToken >
TSharedRef< IMessageToken, Mode > AsShared ()
 
TSharedRef< IMessageToken const, Mode > AsShared () const
 
TSharedRef< SubobjectType, Mode > AsSharedSubobject (SubobjectType *SubobjectPtr) const
 
TWeakPtr< IMessageToken, Mode > AsWeak ()
 
TWeakPtr< IMessageToken const, Mode > AsWeak () const
 
TWeakPtr< SubobjectType, Mode > AsWeakSubobject (SubobjectType *SubobjectPtr) const
 
void UpdateWeakReferenceInternal (TSharedPtr< SharedPtrType, SharedPtrMode > const *InSharedPtr, OtherType *InObject) const
 
void UpdateWeakReferenceInternal (TSharedRef< SharedRefType, SharedPtrMode > const *InSharedRef, OtherType *InObject) const
 
UE_FORCEINLINE_HINT bool DoesSharedInstanceExist () const
 

Static Public Member Functions

static COREUOBJECT_API TSharedRef< FUObjectTokenCreate (const UObject *InObject, const FText &InLabelOverride=FText())
 
static FOnMessageTokenActivatedDefaultOnMessageTokenActivated ()
 
static FOnGetDisplayNameDefaultOnGetObjectDisplayName ()
 

Additional Inherited Members

- Protected Member Functions inherited from TSharedFromThis< IMessageToken >
 TSharedFromThis ()
 
 TSharedFromThis (TSharedFromThis const &)
 
UE_FORCEINLINE_HINT TSharedFromThisoperator= (TSharedFromThis const &)
 
 ~TSharedFromThis ()
 
- Static Protected Member Functions inherited from TSharedFromThis< IMessageToken >
static UE_FORCEINLINE_HINT TSharedRef< OtherType, Mode > SharedThis (OtherType *ThisPtr)
 
static UE_FORCEINLINE_HINT TSharedRef< OtherType const, Mode > SharedThis (const OtherType *ThisPtr)
 
- Protected Attributes inherited from IMessageToken
FOnMessageTokenActivated MessageTokenActivated
 
FText CachedText
 

Detailed Description

A Message Log token that links to an object, with default behavior to link to the object in the content browser/scene.

Member Function Documentation

◆ Create()

TSharedRef< FUObjectToken > FUObjectToken::Create ( const UObject InObject,
const FText InLabelOverride = FText() 
)
static

Factory method, tokens can only be constructed as shared refs

◆ DECLARE_DELEGATE_RetVal_TwoParams()

FUObjectToken::DECLARE_DELEGATE_RetVal_TwoParams ( FText  ,
FOnGetDisplayName  ,
const UObject ,
bool   
)

Get the delegate for displaying the object name

◆ DefaultOnGetObjectDisplayName()

static FOnGetDisplayName & FUObjectToken::DefaultOnGetObjectDisplayName ( )
inlinestatic

◆ DefaultOnMessageTokenActivated()

static FOnMessageTokenActivated & FUObjectToken::DefaultOnMessageTokenActivated ( )
inlinestatic

Get the delegate for default token activation

◆ GetObject()

virtual const FWeakObjectPtr & FUObjectToken::GetObject ( ) const
inlinevirtual

End IMessageToken interface Get the object referenced by this token

◆ GetOnMessageTokenActivated()

const FOnMessageTokenActivated & FUObjectToken::GetOnMessageTokenActivated ( ) const
overridevirtual

Get the activated delegate associated with this token, if any

Returns
a reference to the delegate

Reimplemented from IMessageToken.

◆ GetOriginalObjectPathName()

const FString & FUObjectToken::GetOriginalObjectPathName ( ) const
inline

Get the original object Path Name as the object path name could be different when fetched later on

◆ GetType()

virtual EMessageToken::Type FUObjectToken::GetType ( ) const
inlineoverridevirtual

Begin IMessageToken interface

Implements IMessageToken.


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