unreal.DataRegistrySubsystem

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

Bases: EngineSubsystem

Singleton manager that provides synchronous and asynchronous access to data registries

C++ Source:

  • Plugin: DataRegistry

  • Module: DataRegistry

  • File: DataRegistrySubsystem.h

classmethod acquire_item_bp(item_id, acquire_callback) → bool

Starts an asynchronous acquire of a data registry item that may not yet be cached, and then accessed with Get Data Registry Item From Lookup This function will only work properly if the data registry is set up for asynchronous querying.

Parameters:
Returns:

Returns true if request was started, false on unrecoverable error

Return type:

bool

classmethod conv_data_registry_id_to_string(data_registry_id) → str

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

Parameters:

data_registry_id (DataRegistryId)

Return type:

str

classmethod conv_data_registry_type_to_string(data_registry_type) → str

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

Parameters:

data_registry_type (DataRegistryType)

Return type:

str

classmethod equal_equal_data_registry_id(a, b) → bool

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

Parameters:
Return type:

bool

classmethod equal_equal_data_registry_type(a, b) → bool

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

Parameters:
Return type:

bool

classmethod evaluate_data_registry_curve(item_id, input_value, default_value) -> (out_result=DataRegistrySubsystemGetItemResult, out_value=float)

Attempts to evaluate a curve stored in a DataRegistry cache using a specific input value

Parameters:

  • item_id (DataRegistryId) – Item identifier to lookup in cache

  • input_value (float) – Time/level/parameter input value used to evaluate curve at certain position

  • default_value (float) – Value to use if no curve found or input is outside acceptable range

Returns:

out_result (DataRegistrySubsystemGetItemResult):

out_value (float): Result will be replaced with evaluated value, or default if that fails

Return type:

tuple

classmethod get_possible_data_registry_id_list(registry_type) → Array[DataRegistryId]

Returns the list of known identifiers for an active data registry so they can be iterated with Find or Acquire. Depending on how the registry is setup, this could be a large number of identifiers and they may not all be available.

Parameters:

registry_type (DataRegistryType) – The type of data registry to query

Returns:

out_id_list (Array[DataRegistryId]): The list of known identifiers for the type, which will be empty if the type is not registered

Return type:

Array[DataRegistryId]

classmethod is_valid_data_registry_id(data_registry_id) → bool

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

Parameters:

data_registry_id (DataRegistryId)

Return type:

bool

classmethod is_valid_data_registry_type(data_registry_type) → bool

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

Parameters:

data_registry_type (DataRegistryType)

Return type:

bool

classmethod not_equal_data_registry_id(a, b) → bool

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

Parameters:
Return type:

bool

classmethod not_equal_data_registry_type(a, b) → bool

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

Parameters:
Return type:

bool