1. Epic GamesDeveloper
  3. FUniversalObjectLocator

FUniversalObjectLocator

Universal Object Locators (UOLs) define an address to an object.

API > API/Runtime > API/Runtime/UniversalObjectLocator

References

   
Module UniversalObjectLocator
Header /Engine/Source/Runtime/UniversalObjectLocator/Public/UniversalObjectLocator.h
Include #include "UniversalObjectLocator.h"

Syntax

USTRUCT (BlueprintType , Category=GameFramework,  
        Meta=(HasNativeMake="/Script/Engine.UniversalObjectLocatorScriptingExtensions.MakeUniversalObjectLocator"))  
struct FUniversalObjectLocator

Remarks

Universal Object Locators (UOLs) define an address to an object.

The address is implemented as a chain of FUniversalObjectLocatorFragments, allowing addressing of objects that may be nested deeply within levels of externally defined spawn or ownership logic.

For example, a Universal Object Locator may reference an Anim Instance within a Skeletal Mesh Actor is spawned by a Child Actor Component that is spawned by Sequencer. This is impossible with a regular soft object path, but is perfectly feasible for a UOL.

This type is 16 bytes.

Constructors

  Type Name Description
Public function   Default constructor
Public function  

FUniversalObjectLocator ( UObject* Object,
UObject* Context,
UObject* StopAtContext
)

 Attempt to construct this locator from a given object.

Functions

  Type Name Description
Public function void Add a fragment to the end of this locator
Public function void

AddFragment ( ArgTypes&&... FragmentArgs
)

 Templated helper for AddFragment
Public function Const FResolveResult

AsyncFind ( UObject* Context
)

 Attempt to find the object this locator points to.
Public function Const FResolveResult

AsyncLoad ( UObject* Context
)

 Attempt to find the object this locator points to, loading it if necessary (and possible).
Public function Const FResolveResult

AsyncUnload ( UObject* Context
)

 Attempt to unload the object this locator points to if possible.
Public function Const bool

ExportTextItem ( FString& ValueStr,
const FUniversalObjectLocator& DefaultValue,
UObject* Parent,
int32 PortFlags,
UObject* ExportRootScope
)

  
Public function Const bool Iterate the fragments in this address
Public function Static FUniversalObjectLocator

FromString ( FStringView InString,
const FParseStringParams& InParams
)

 Attempt to deserialize a new locator from a string.
Public function Const UE::UniversalObjectLocator::EFragmentTypeFlags Iterates over all fragments and combines their types' default flags.
Public function Const const FUniversalObjectLocatorFragment * Retrieve the last fragment in this address
Public function FUniversalObjectLocatorFragment * Retrieve the last fragment in this address
Public function Const const UE::UniversalObjectLocator::FFragmentType * Retrieve the fragment type relating to the last locator in this address
Public function Const UE::UniversalObjectLocator::FFragmentTypeHandle Retrieve the fragment type handle relating to the last locator in this address
Public function bool

ImportTextItem ( const TCHAR*& Buffer,
int32 PortFlags,
UObject* Parent,
FOutputDevice* ErrorText,
FArchive* InSerializingArchive
)

  
Public function Const bool

IsEmpty ()

 Check if this locator is 'empty'. An empty locator contains no fragments and will never resolve.
Public function void

Reset ( UObject* Object,
UObject* Context,
UObject* StopAtContext
)

 Attempt to reset this locator to point at a different object.
Public function void

Reset ()

 Reset this locator back to its default-constructed, empty state
Public function Const FResolveResult

Resolve ( const FResolveParams& Params
)

 Attempt to resolve this locator by invoking the payload's 'Resolve' function
Public function bool  
Public function Const UObject *

SyncFind ( UObject* Context
)

 Attempt to find the object this locator points to.
Public function Const UObject *

SyncLoad ( UObject* Context
)

 Attempt to find the object this locator points to, loading it if necessary (and possible), and blocking until it is loaded.
Public function Const void

SyncUnload ( UObject* Context
)

 Attempt to unload the object this locator points to if possible.
Public function Const void

ToString ( FStringBuilderBase& OutString
)

 Convert this locator to its string representation
Public function FParseStringResult

TryParseString ( FStringView InString,
const FParseStringParams& InParams
)

 Attempt to deserialize this locator from a string

Typedefs

Name Description
FParseStringParams  
FParseStringResult  
FResolveParams  
FResolveResult  
FResolveResultData  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page