unreal.UniversalObjectLocatorScriptingExtensions

class unreal.UniversalObjectLocatorScriptingExtensions(outer: Object | None = None, name: Name | str = 'None')

Bases: BlueprintFunctionLibrary

Function library containing methods that should be hoisted onto FUniversalObjectLocators for scripting

C++ Source:

  • Module: Engine

  • File: UniversalObjectLocatorScriptingExtensions.h

classmethod is_empty(locator) → bool

Check whether the specified locator is empty; not equivalent to Resolve() != None. An empty locator will never resolve to a valid object.

Parameters:

locator (UniversalObjectLocator) –

Return type:

bool

classmethod make_universal_object_locator(object, context) → UniversalObjectLocator

Construct a new universal object locator

Parameters:
Return type:

UniversalObjectLocator

classmethod sync_find(locator, context=None) → Object

Attempt to resolve the object locator by finding the object. If it is not currently loaded or created,

Parameters:

  • locator (UniversalObjectLocator) –

  • context (Object) – (Optional) Context object to use for resolving the object. This should usually be the object that owns or created the locator.

Returns:

The resolve object pointer, or null if it was not found.

Return type:

Object

classmethod sync_load(locator, context=None) → Object

Attempt to resolve the object locator by finding or loading the object.

Parameters:

  • locator (UniversalObjectLocator) –

  • context (Object) – (Optional) Context object to use for resolving the object. This should usually be the object that owns or created the locator.

Returns:

The resolve object pointer, or null if it was not found.

Return type:

Object

classmethod sync_unload(locator, context=None) → None

Attempt to resolve the object locator by unloading the object if possible.

Parameters:

  • locator (UniversalObjectLocator) –

  • context (Object) – (Optional) Context object to use for resolving the object. This should usually be the object that owns or created the locator.

classmethod to_string(locator) → str

Convert the specified locator to its string representation

Parameters:

locator (UniversalObjectLocator) –

Return type:

str

classmethod universal_object_locator_from_string(string) → UniversalObjectLocator

Construct a new universal object locator from a string

Parameters:

string (str) –

Return type:

UniversalObjectLocator