unreal.DataRegistrySubsystem

class unreal.DataRegistrySubsystem(outer=None, name='None')

Bases: unreal.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.

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 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