unreal.DataRegistryId

class unreal.DataRegistryId(registry_type: DataRegistryType = Ellipsis, item_name: Name = 'None')

Bases: StructBase

Identifier for a specific DataRegistryItem, provides the user with a Tag or dropdown-based UI for selecting based on the available index info

C++ Source:

  • Plugin: DataRegistry

  • Module: DataRegistry

  • File: DataRegistryId.h

Editor Properties: (see get_editor_property/set_editor_property)

  • item_name (Name): [Read-Write] Item Name: The name of this object, may be a leaf gameplay tag or a raw name depending on the type

  • registry_type (DataRegistryType): [Read-Write] Registry Type: The type of this item, used to look up the correct registry

__bool__() → bool

Returns true if this is a non-empty item identifier, does not check if it is currently registered

__eq__(other: object) → bool

Overloads:

  • DataRegistryId Returns true if the values are equal (A == B)

__ne__(other: object) → bool

Overloads:

  • DataRegistryId Returns true if the values are not equal (A != B)

is_valid() → bool

Returns true if this is a non-empty item identifier, does not check if it is currently registered

Return type:

bool

property item_name: Name

[Read-Write] Item Name: The name of this object, may be a leaf gameplay tag or a raw name depending on the type

Type:

(Name)

property registry_type: DataRegistryType

[Read-Write] Registry Type: The type of this item, used to look up the correct registry

Type:

(DataRegistryType)

to_string() → str

Converts a Data Registry Id to a string. The other direction is not provided because it cannot be validated

Return type:

str