unreal.DataLayerManager

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

Bases: Object

Data Layer Manager

C++ Source:

  • Module: Engine

  • File: DataLayerManager.h

Editor Properties: (see get_editor_property/set_editor_property)

  • on_data_layer_instance_runtime_state_changed (OnDataLayerInstanceRuntimeStateChanged): [Read-Write] Called when a Data Layer instance runtime state has changed.

get_data_layer_instance_effective_runtime_state(data_layer_instance) → DataLayerRuntimeState

Finds a matching Data Layer instance referencing the provided Data Layer asset and returns the Data Layer Instance runtime state.

Parameters:

data_layer_instance (DataLayerInstance)

Return type:

DataLayerRuntimeState

get_data_layer_instance_from_asset(data_layer_asset) → DataLayerInstance

Returns the Data Layer instance referencing the provided Data Layer asset (if any).

Parameters:

data_layer_asset (DataLayerAsset)

Return type:

DataLayerInstance

get_data_layer_instance_from_name(data_layer_instance_name) → DataLayerInstance

Returns the Data Layer instance matching the provided Data Layer instance name (if any).

Parameters:

data_layer_instance_name (Name)

Return type:

DataLayerInstance

get_data_layer_instance_runtime_state(data_layer_instance) → DataLayerRuntimeState

Returns the Data Layer instance runtime state.

Parameters:

data_layer_instance (DataLayerInstance)

Return type:

DataLayerRuntimeState

get_data_layer_instances() → Array[DataLayerInstance]

Returns all Data Layer instances.

Return type:

Array[DataLayerInstance]

property on_data_layer_instance_runtime_state_changed: OnDataLayerInstanceRuntimeStateChanged

[Read-Write] Called when a Data Layer instance runtime state has changed.

Type:

(OnDataLayerInstanceRuntimeStateChanged)

set_data_layer_instance_runtime_state(data_layer_instance, state, is_recursive=False) → bool

Changes the Data Layer instance runtime state. If recursive is set to true, the runtime state will also be applied to all child Data Layer instances. Note: - Changing the runtime state of a Client-Only Data Layer instance must be done on the client side or else it will have no effect. - Changing the runtime state of a Server-Only Data Layer instance can only be done on the server side or else it will have no effect. - Changing the runtime state of a runtime Data Layer instance (with no Load Filter set on the asset) must be done on the server side

or else it will have no effect. The runtime state will then be replicated on the client.

(see Data Layer asset Load Filter for more details)

Parameters:
Return type:

bool

set_data_layer_runtime_state(data_layer_asset, state, is_recursive=False) → bool

Finds a matching Data Layer instance referencing the provided Data Layer asset and changes its runtime state (if any). If recursive is set to true, the runtime state will also be applied to all child Data Layer instances. Note: - Changing the runtime state of a Client-Only Data Layer instance must be done on the client side or else it will have no effect. - Changing the runtime state of a Server-Only Data Layer instance can only be done on the server side or else it will have no effect. - Changing the runtime state of a runtime Data Layer instance (with no Load Filter set on the asset) must be done on the server side

or else it will have no effect. The runtime state will then be replicated on the client.

(see Data Layer asset Load Filter for more details)

Parameters:
Return type:

bool