unreal.Object

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

Bases: _ObjectBase

The base class of all UE objects. The type of an object is defined by its UClass. This provides support functions for creating and using objects, and virtual functions that should be overridden in child classes. see: https://docs.unrealengine.com/ProgrammingAndScripting/ProgrammingWithCPP/UnrealArchitecture/Objects

C++ Source:

  • Module: CoreUObject

  • File: Object.h

acquire_editor_element_handle(allow_create=True) → ScriptTypedElementHandle

K2 Acquire Editor Object Element Handle

Parameters:

allow_create (bool)

Return type:

ScriptTypedElementHandle

is_editor_property_overridden(property_name) → EditorPropertyValueState

Attempts to query whether the value of a named property on the given object overrides the value of its archetype (ie, would ResetEditorProperty do anything?).

Parameters:

property_name (Name) – The name of the object property to query the value of.

Returns:

What state the requested property is in.

Return type:

EditorPropertyValueState

reset_editor_property(property_name, change_notify_mode=PropertyAccessChangeNotifyMode.DEFAULT) → bool

Attempts to reset the value of a named property on the given object so that it matches the value of the archetype.

Parameters:

  • property_name (Name) – The name of the object property to reset the value of.

  • change_notify_mode (PropertyAccessChangeNotifyMode) – When to emit property change notifications.

Returns:

Whether the property value was found and correctly reset.

Return type:

bool