unreal.DataLayerSubsystem

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

Bases: unreal.WorldSubsystem

Data Layer Subsystem

C++ Source:

  • Module: Engine

  • File: DataLayerSubsystem.h

Editor Properties: (see get_editor_property/set_editor_property)

  • on_data_layer_runtime_state_changed (OnDataLayerRuntimeStateChanged): [Read-Write] On Data Layer Runtime State Changed: Called when a Data Layer changes state.

get_active_data_layer_names()

Get Active Data Layer Names deprecated: GetActiveDataLayerNames will be removed.

Return type

Set(Name)

get_data_layer(data_layer) → DataLayer

Find a Data Layer by name.

Parameters

data_layer (ActorDataLayer) –

Return type

DataLayer

get_data_layer_effective_runtime_state(data_layer) → DataLayerRuntimeState

Get the Data Layer effective state using its name.

Parameters

data_layer (ActorDataLayer) –

Return type

DataLayerRuntimeState

get_data_layer_effective_runtime_state_by_label(data_layer_label) → DataLayerRuntimeState

Get the Data Layer effective state using its label.

Parameters

data_layer_label (Name) –

Return type

DataLayerRuntimeState

get_data_layer_from_label(data_layer_label) → DataLayer

Find a Data Layer by label.

Parameters

data_layer_label (Name) –

Return type

DataLayer

get_data_layer_from_name(data_layer_name) → DataLayer

Find a Data Layer by name.

Parameters

data_layer_name (Name) –

Return type

DataLayer

get_data_layer_runtime_state(data_layer) → DataLayerRuntimeState

Get the Data Layer state using its name.

Parameters

data_layer (ActorDataLayer) –

Return type

DataLayerRuntimeState

get_data_layer_runtime_state_by_label(data_layer_label) → DataLayerRuntimeState

Get the Data Layer state using its label.

Parameters

data_layer_label (Name) –

Return type

DataLayerRuntimeState

get_data_layer_state(data_layer) → DataLayerStateType

Get Data Layer State deprecated: Use GetDataLayerRuntimeState instead

Parameters

data_layer (ActorDataLayer) –

Return type

DataLayerStateType

get_data_layer_state_by_label(data_layer_label) → DataLayerStateType

Get Data Layer State by Label deprecated: Use GetDataLayerRuntimeStateByLabel instead

Parameters

data_layer_label (Name) –

Return type

DataLayerStateType

get_loaded_data_layer_names()

Get Loaded Data Layer Names deprecated: GetLoadedDataLayerNames will be removed.

Return type

Set(Name)

property on_data_layer_runtime_state_changed

[Read-Write] On Data Layer Runtime State Changed: Called when a Data Layer changes state.

Type

(OnDataLayerRuntimeStateChanged)

property on_data_layer_state_changed

‘on_data_layer_state_changed’ was renamed to ‘on_data_layer_runtime_state_changed’.

Type

deprecated

set_data_layer_runtime_state(data_layer, state, is_recursive=False) → None

Set the Data Layer state using its name.

Parameters
set_data_layer_runtime_state_by_label(data_layer_label, state, is_recursive=False) → None

Set the Data Layer state using its label.

Parameters
set_data_layer_state(data_layer, state) → None

Set Data Layer State deprecated: Use SetDataLayerRuntimeState instead

Parameters
set_data_layer_state_by_label(data_layer_label, state) → None

Set Data Layer State by Label deprecated: Use SetDataLayerRuntimeStateByLabel instead

Parameters