unreal.DataLayerEditorSubsystem
¶
- class unreal.DataLayerEditorSubsystem(outer=None, name='None')¶
Bases:
unreal.EditorSubsystem
Data Layer Editor Subsystem
C++ Source:
Module: DataLayerEditor
File: DataLayerEditorSubsystem.h
- add_actors_to_data_layers(actors, data_layers) bool ¶
Add the actors to the DataLayers
- Parameters
- Returns
true if at least one actor was added to at least one DataLayer. false is returned if all the actors already belonged to all specified DataLayers.
- Return type
- append_actors_from_data_layer(data_layer)¶
Appends all the actors associated with the specified DataLayer.
- append_actors_from_data_layers(data_layers)¶
Appends all the actors associated with ANY of the specified DataLayers.
- create_data_layer() DataLayer ¶
Creates a UDataLayer Object
- Returns
The newly created UDataLayer Object
- Return type
- delete_data_layer(data_layer_to_delete) None ¶
Deletes the provided DataLayer
- Parameters
data_layer_to_delete (DataLayer) – A valid DataLayer
- get_actors_from_data_layer(data_layer)¶
Gets all the actors associated with the specified DataLayer. Analog to AppendActorsFromDataLayer but it returns rather than appends the actors.
- get_actors_from_data_layers(data_layers)¶
Gets all the actors associated with ANY of the specified DataLayers. Analog to AppendActorsFromDataLayers but it returns rather than appends the actors.
- get_data_layer(actor_data_layer) DataLayer ¶
Gets the UDataLayer Object of the ActorDataLayer
- Parameters
actor_data_layer (ActorDataLayer) – The ActorDataLayer whose UDataLayer Object is returned
- Returns
The UDataLayer Object of the provided ActorDataLayer
- Return type
- get_data_layer_from_label(data_layer_label) DataLayer ¶
Gets the UDataLayer Object of the DataLayer label
- is_actor_valid_for_data_layer(actor) bool ¶
Checks to see if the specified actor is in an appropriate state to interact with DataLayers
- remove_actor_from_data_layer(actor, data_layer_to_remove) bool ¶
Removes an actor from the specified DataLayer.
- remove_actor_from_data_layers(actor, data_layers) bool ¶
Removes the provided actor from the DataLayers.
- remove_actors_from_data_layer(actors, data_layer) bool ¶
Removes the actors from the specified DataLayer.
- remove_actors_from_data_layers(actors, data_layers) bool ¶
Remove the actors to the DataLayers
- Parameters
- Returns
true if at least one actor was removed from at least one DataLayer. false is returned if none of the actors belonged to any of the specified DataLayers.
- Return type
- remove_selected_actors_from_data_layer(data_layer) bool ¶
Removes the selected actors from the DataLayer.
- remove_selected_actors_from_data_layers(data_layers) bool ¶
Removes selected actors from the DataLayers.
- rename_data_layer(data_layer, new_data_layer_label) bool ¶
Renames the provided DataLayer to the provided new label
- select_actors_in_data_layer(data_layer, select, notify, select_even_if_hidden=False) bool ¶
Selects/de-selects actors belonging to the DataLayer.
- Parameters
data_layer (DataLayer) – A valid DataLayer.
select (bool) – If true actors are selected; if false, actors are deselected.
notify (bool) – If true the Editor is notified of the selection change; if false, the Editor will not be notified.
select_even_if_hidden (bool) – [optional] If true even hidden actors will be selected; if false, hidden actors won’t be selected.
- Returns
true if at least one actor was selected/deselected.
- Return type
- select_actors_in_data_layers(data_layers, select, notify, select_even_if_hidden=False) bool ¶
Selects/de-selects actors belonging to the DataLayers.
- Parameters
data_layers (Array(DataLayer)) – A valid list of DataLayers.
select (bool) – If true actors are selected; if false, actors are deselected.
notify (bool) – If true the Editor is notified of the selection change; if false, the Editor will not be notified
select_even_if_hidden (bool) – [optional] If true even hidden actors will be selected; if false, hidden actors won’t be selected.
- Returns
true if at least one actor was selected/deselected.
- Return type
- set_data_layer_is_dynamically_loaded_in_editor(data_layer, is_loaded_in_editor, is_from_user_change) bool ¶
Set Data Layer Is Dynamically Loaded in Editor deprecated: Use SetDataLayerIsLoadedInEditor instead
- set_data_layer_is_loaded_in_editor(data_layer, is_loaded_in_editor, is_from_user_change) bool ¶
Changes the DataLayer’s IsLoadedInEditor flag to the provided state
- Parameters
data_layer (DataLayer) – The DataLayer to affect.
is_loaded_in_editor (bool) – The new value of the flag IsLoadedInEditor. If True, the Editor loading will consider this DataLayer to load or not an Actor part of this DataLayer. An Actor will not be loaded in the Editor if all its DataLayers are not LoadedInEditor.
is_from_user_change (bool) – If this change originates from a user change or not.
- Return type
- set_data_layer_visibility(data_layer, is_visible) None ¶
Changes the DataLayer’s visibility to the provided state
- set_data_layers_is_dynamically_loaded_in_editor(data_layers, is_loaded_in_editor, is_from_user_change) bool ¶
Set Data Layers Is Dynamically Loaded in Editor deprecated: Use SetDataLayersIsLoadedInEditor instead
- set_data_layers_is_loaded_in_editor(data_layers, is_loaded_in_editor, is_from_user_change) bool ¶
Changes the IsLoadedInEditor flag of the DataLayers to the provided state
- Parameters
is_loaded_in_editor (bool) – The new value of the flag IsLoadedInEditor. If True, the Editor loading will consider this DataLayer to load or not an Actor part of this DataLayer. An Actor will not be loaded in the Editor if all its DataLayers are not LoadedInEditor.
is_from_user_change (bool) – If this change originates from a user change or not.
- Return type
- set_data_layers_visibility(data_layers, is_visible) None ¶
Changes visibility of the DataLayers to the provided state
- set_parent_data_layer(data_layer, parent_data_layer) bool ¶
Sets a Parent DataLayer for a specified DataLayer
- toggle_data_layer_is_dynamically_loaded_in_editor(data_layer, is_from_user_change) bool ¶
Toggle Data Layer Is Dynamically Loaded in Editor deprecated: Use ToggleDataLayerIsLoadedInEditor instead
- toggle_data_layer_is_loaded_in_editor(data_layer, is_from_user_change) bool ¶
Toggles the DataLayer’s IsLoadedInEditor flag
- toggle_data_layer_visibility(data_layer) None ¶
Toggles the DataLayer’s visibility
- Parameters
data_layer (DataLayer) – The DataLayer to affect
- toggle_data_layers_is_dynamically_loaded_in_editor(data_layers, is_from_user_change) bool ¶
Toggle Data Layers Is Dynamically Loaded in Editor deprecated: Use ToggleDataLayersIsLoadedInEditor instead
- toggle_data_layers_is_loaded_in_editor(data_layers, is_from_user_change) bool ¶
Toggles the IsLoadedInEditor flag of all of the DataLayers
- update_actor_all_views_visibility(actor) None ¶
Update Actor All Views Visibility deprecated: Per-view Data Layer visibility was removed.
- Parameters
actor (Actor) –
- update_actor_visibility(actor, notify_selection_change, redraw_viewports) (out_selection_changed=bool, out_actor_modified=bool) or None ¶
Updates the provided actors visibility in the viewports
- Parameters
- Returns
out_selection_changed (bool): [OUT] Whether the Editors selection changed
out_actor_modified (bool): [OUT] Whether the actor was modified
- Return type
tuple or None