unreal.DataLayerSubsystem

class unreal.DataLayerSubsystem(outer: Optional[Object] = None, name: Union[Name, str] = 'None')

Bases: 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() → Set[Name]

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

Return type:

Set[Name]

get_data_layer(data_layer) → DataLayerInstance

Get Data Layer

Parameters:

data_layer (ActorDataLayer) –

Return type:

DataLayerInstance

get_data_layer_effective_runtime_state(data_layer) → DataLayerRuntimeState

Get Data Layer Effective Runtime State

Parameters:

data_layer (ActorDataLayer) –

Return type:

DataLayerRuntimeState

get_data_layer_effective_runtime_state_by_label(data_layer_label) → DataLayerRuntimeState

Get Data Layer Effective Runtime State by Label

Parameters:

data_layer_label (Name) –

Return type:

DataLayerRuntimeState

get_data_layer_from_label(data_layer_label) → DataLayerInstance

Get Data Layer from Label

Parameters:

data_layer_label (Name) –

Return type:

DataLayerInstance

get_data_layer_from_name(data_layer_name) → DataLayerInstance

Get Data Layer from Name

Parameters:

data_layer_name (Name) –

Return type:

DataLayerInstance

get_data_layer_instance_effective_runtime_state(data_layer_asset) → DataLayerRuntimeState

Get Data Layer Instance Effective Runtime State

Parameters:

data_layer_asset (DataLayerAsset) –

Return type:

DataLayerRuntimeState

get_data_layer_instance_from_asset(data_layer_asset) → DataLayerInstance

Find a Data Layer by its asset.

Parameters:

data_layer_asset (DataLayerAsset) –

Return type:

DataLayerInstance

get_data_layer_instance_runtime_state(data_layer_asset) → DataLayerRuntimeState

Get Data Layer Instance Runtime State

Parameters:

data_layer_asset (DataLayerAsset) –

Return type:

DataLayerRuntimeState

get_data_layer_runtime_state(data_layer) → DataLayerRuntimeState

Get Data Layer Runtime State

Parameters:

data_layer (ActorDataLayer) –

Return type:

DataLayerRuntimeState

get_data_layer_runtime_state_by_label(data_layer_label) → DataLayerRuntimeState

Get Data Layer Runtime State by 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() → Set[Name]

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

Return type:

Set[Name]

property on_data_layer_runtime_state_changed: OnDataLayerRuntimeStateChanged

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

Type:

(OnDataLayerRuntimeStateChanged)

property on_data_layer_state_changed: OnDataLayerRuntimeStateChanged

‘on_data_layer_state_changed’ was renamed to ‘on_data_layer_runtime_state_changed’.

Type:

deprecated

set_data_layer_instance_runtime_state(data_layer_asset, state, is_recursive=False) → None

Set the Data Layer state using its name.

Parameters:

• data_layer_asset (DataLayerAsset) –

• state (DataLayerRuntimeState) –

• is_recursive (bool) –

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

Set Data Layer Runtime State

Parameters:

• data_layer (ActorDataLayer) –

• state (DataLayerRuntimeState) –

• is_recursive (bool) –

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

Set Data Layer Runtime State by Label

Parameters:

• data_layer_label (Name) –

• state (DataLayerRuntimeState) –

• is_recursive (bool) –

set_data_layer_state(data_layer, state) → None

Set Data Layer State deprecated: Use SetDataLayerRuntimeState instead

Parameters:

• data_layer (ActorDataLayer) –

• state (DataLayerStateType) –

set_data_layer_state_by_label(data_layer_label, state) → None

Set Data Layer State by Label deprecated: Use SetDataLayerRuntimeStateByLabel instead

Parameters:

• data_layer_label (Name) –

• state (DataLayerStateType) –