UDataLayerEditorSubsystem

Unreal Engine C++ API Reference > Editor > DataLayerEditor > DataLayer

Inheritance Hierarchy

References

   
Module DataLayerEditor
Header /Engine/Source/Editor/DataLayerEditor/Public/DataLayer/DataLayerEditorSubsystem.h
Include #include "DataLayer/DataLayerEditorSubsystem.h"

Syntax

class UDataLayerEditorSubsystem :  
    public [UEditorSubsystem](API\Editor\EditorSubsystem\UEditorSubsystem),  
    public [IActorEditorContextClient](API\Editor\UnrealEd\IActorEditorContextClient),  
    public [FTickableGameObject](API\Runtime\Engine\FTickableGameObject)  

Constructors

Type Name Description
  UDataLayerEditorSubsystem ()  

Destructors

Type Name Description
  ~UDataLayerEditorSubsystem () Destructor

Functions

Type Name Description
bool AddActorsToDataLayer ( const TArray< AActor* >& Acto..., UDataLayerInstance* DataLayer ) Add the actors to the DataLayer
bool AddActorsToDataLayers ( const TArray< AActor* >& Acto..., const TArray< UDataLayerInstance&#... ) Add the actors to the DataLayers
bool AddActorToDataLayer ( AActor* Actor, UDataLayerInstance* DataLayer ) Adds the actor to the DataLayer.
bool AddActorToDataLayers ( AActor* Actor, const TArray< UDataLayerInstance&#... ) Adds the provided actor to the DataLayers.
void AddAllDataLayersTo ( TArray< TWeakObjectPtr< UDataLayerI... ) Gets all known DataLayers and appends them to the provided array
bool AddSelectedActorsToDataLayer ( UDataLayerInstance* DataLayer ) Adds selected actors to the DataLayer.
bool AddSelectedActorsToDataLayers ( const TArray< UDataLayerInstance&#... ) Adds selected actors to the DataLayers.
void AddToActorEditorContext ( UDataLayerInstance* InDataLaye... )  
void AppendActorsFromDataLayer ( UDataLayerInstance* DataLayer, TArray< AActor* >& InOutActor..., const TSharedPtr< FActorFilter >& ... ) Appends all the actors associated with the specified DataLayer.
void AppendActorsFromDataLayer ( UDataLayerInstance* DataLayer, TArray< AActor* >& InOutActor... ) Appends all the actors associated with the specified DataLayer.
void AppendActorsFromDataLayers ( const TArray< UDataLayerInstance&#..., TArray< AActor* >& InOutActor..., const TSharedPtr< FActorFilter >& ... ) Appends all the actors associated with ANY of the specified DataLayers.
void AppendActorsFromDataLayers ( const TArray< UDataLayerInstance&#..., TArray< AActor* >& InOutActor... ) Appends all the actors associated with ANY of the specified DataLayers.
UDataLayerIn... CreateDataLayerInstance ( const FDataLayerCreationParameters ... ) Creates a UDataLayerInstance Object
DataLayerTyp... CreateDataLayerInstance ( AWorldDataLayers* WorldDataLay..., Args&&... InArgs )  
void DeleteDataLayer ( UDataLayerInstance* DataLayerT... ) Deletes the provided DataLayer
void DeleteDataLayers ( const TArray< UDataLayerInstance&#... ) Deletes all of the provided DataLayers
bool DoesDataLayerContainSelectedActors ( const UDataLayerInstance* Data... ) Returns whether the DataLayer contains one of more actors that are part of the editor selection.
UDataLayerEd... Get ()  
TArray< AAct... GetActorsFromDataLayer ( UDataLayerInstance* DataLayer ) Gets all the actors associated with the specified DataLayer.
TArray< AAct... GetActorsFromDataLayer ( UDataLayerInstance* DataLayer, const TSharedPtr< FActorFilter >& ... ) Gets all the actors associated with the specified DataLayer.
TArray< AAct... GetActorsFromDataLayers ( const TArray< UDataLayerInstance&#..., const TSharedPtr< FActorFilter >& ... ) Gets all the actors associated with ANY of the specified DataLayers.
TArray< AAct... GetActorsFromDataLayers ( const TArray< UDataLayerInstance&#... ) Gets all the actors associated with ANY of the specified DataLayers.
TArray< UDat... GetAllDataLayers () Returns all Data Layers
UDataLayerIn... GetDataLayerInstance ( const UDataLayerAsset* DataLay... ) Gets the UDataLayerInstance associated to the DataLayerAsset
UDataLayerIn... GetDataLayerInstance ( const FName& DataLayerInstanceName ) Gets the UDataLayerInstance Object of the DataLayer name
TArray< UDat... GetDataLayerInstances ( const TArray< UDataLayerAsset*... ) Gets the UDataLayerInstances associated to the each DataLayerAssets
TArray< cons... GetDataLayerInstances ( const TArray< const UDataLayerAsset... )  
bool HasDeprecatedDataLayers () Whether there are any deprecated DataLayerInstance found
bool IsActorValidForDataLayer ( AActor* Actor ) Checks to see if the specified actor is in an appropriate state to interact with DataLayers
void MakeAllDataLayersVisible () Set the visibility of all DataLayers to true
FOnActorData... OnActorDataLayersChanged ()  
FOnActorData... OnActorDataLayersEditorLoadingStateChanged ()  
FOnDataLayer... OnDataLayerChanged ()  
bool RemoveActorFromAllDataLayers ( AActor* Actor ) Removes an actor from all DataLayers.
bool RemoveActorFromDataLayer ( AActor* Actor, UDataLayerInstance* DataLayerT... ) Removes an actor from the specified DataLayer.
bool RemoveActorFromDataLayers ( AActor* Actor, const TArray< UDataLayerInstance&#... ) Removes the provided actor from the DataLayers.
bool RemoveActorsFromAllDataLayers ( const TArray< AActor* >& Acto... ) Removes an actor from all DataLayers.
bool RemoveActorsFromDataLayer ( const TArray< AActor* >& Acto..., UDataLayerInstance* DataLayer ) Removes the actors from the specified DataLayer.
bool RemoveActorsFromDataLayers ( const TArray< AActor* >& Acto..., const TArray< UDataLayerInstance&#... ) Remove the actors from the DataLayers
void RemoveFromActorEditorContext ( UDataLayerInstance* InDataLaye... )  
bool RemoveSelectedActorsFromDataLayer ( UDataLayerInstance* DataLayer ) Removes the selected actors from the DataLayer.
bool RemoveSelectedActorsFromDataLayers ( const TArray< UDataLayerInstance&#... ) Removes selected actors from the DataLayers.
bool ResetUserSettings () Resets user override settings of all DataLayers
bool SelectActorsInDataLayer ( UDataLayerInstance* DataLayer, const bool bSelect, const bool bNotify, const bool bSelectEvenIfHidden, const TSharedPtr< FActorFilter >& ... ) Selects/de-selects actors belonging to the DataLayer.
bool SelectActorsInDataLayer ( UDataLayerInstance* DataLayer, const bool bSelect, const bool bNotify, const bool bSelectEvenIfHidden ) Selects/de-selects actors belonging to the DataLayer.
bool SelectActorsInDataLayers ( const TArray< UDataLayerInstance&#..., const bool bSelect, const bool bNotify, const bool bSelectEvenIfHidden ) Selects/de-selects actors belonging to the DataLayers.
bool SelectActorsInDataLayers ( const TArray< UDataLayerInstance&#..., const bool bSelect, const bool bNotify, const bool bSelectEvenIfHidden, const TSharedPtr< FActorFilter >& ... ) Selects/de-selects actors belonging to the DataLayers.
bool SetDataLayerIsLoadedInEditor ( UDataLayerInstance* DataLayer, const bool bIsLoadedInEditor, const bool bIsFromUserChange ) Changes the DataLayer's IsLoadedInEditor flag to the provided state
bool SetDataLayerShortName ( UDataLayerInstance* InDataLaye..., const FString& InNewShortName ) Assign new unique short name to DataLayerInstance if it supports it.
bool SetDataLayersIsLoadedInEditor ( const TArray< UDataLayerInstance&#..., const bool bIsLoadedInEditor, const bool bIsFromUserChange ) Changes the IsLoadedInEditor flag of the DataLayers to the provided state
void SetDataLayersVisibility ( const TArray< UDataLayerInstance&#..., const bool bIsVisible ) Changes visibility of the DataLayers to the provided state
void SetDataLayerVisibility ( UDataLayerInstance* DataLayer, const bool bIsVisible ) Changes the DataLayer's visibility to the provided state
bool SetParentDataLayer ( UDataLayerInstance* DataLayer, UDataLayerInstance* ParentData... ) Sets a Parent DataLayer for a specified DataLayer
bool ToggleDataLayerIsLoadedInEditor ( UDataLayerInstance* DataLayer, const bool bIsFromUserChange ) Toggles the DataLayer's IsLoadedInEditor flag
bool ToggleDataLayersIsLoadedInEditor ( const TArray< UDataLayerInstance&#..., const bool bIsFromUserChange ) Toggles the IsLoadedInEditor flag of all of the DataLayers
void ToggleDataLayersVisibility ( const TArray< UDataLayerInstance&#... ) Toggles the visibility of all of the DataLayers
void ToggleDataLayerVisibility ( UDataLayerInstance* DataLayer ) Toggles the DataLayer's visibility
bool UpdateActorVisibility ( AActor* Actor, bool& bOutSelectionChanged, bool& bOutActorModified, const bool bNotifySelectionChange, const bool bRedrawViewports ) Updates the provided actors visibility in the viewports
bool UpdateAllActorsVisibility ( const bool bNotifySelectionChange, const bool bRedrawViewports ) Updates the visibility of all actors in the viewports

Overridden from USubsystem

Type Name Description
void Deinitialize () Internal cleanup
void Initialize ( FSubsystemCollectionBase& Collecti... ) Prepares for use

Overridden from UObject

Type Name Description
void BeginDestroy () Called before destroying the object.

Overridden from IActorEditorContextClient

Type Name Description
bool CanResetContext ( UWorld* InWorld )  
bool GetActorEditorContextDisplayInfo ( UWorld* InWorld, FActorEditorContextClientDisplayInf... )  
TSharedRef< ... GetActorEditorContextWidget ( UWorld* InWorld )  
FOnActorEdit... GetOnActorEditorContextClientChanged ()  
void OnExecuteActorEditorContextAction ( UWorld* InWorld, const EActorEditorContextAction& I..., AActor* InActor )  

Overridden from FTickableGameObject

Type Name Description
UWorld * GetTickableGameObjectWorld ()  
bool IsTickableInEditor () Used to determine whether the object should be ticked in the editor.

Overridden from FTickableObjectBase

Type Name Description
TStatId GetStatId () Return the stat id to use for this tickable
ETickableTic... GetTickableTickType () Virtual that can be overloaded by the inheriting class.
bool IsAllowedToTick () Virtual that can be overloaded by the inheriting class.
void Tick ( float DeltaTime ) Pure virtual that must be overloaded by the inheriting class.

Classes

Type Name Description
Public class FOnActorDataLayersChanged Broadcasts whenever one or more Actors changed UDataLayerInstances
Public class FOnActorDataLayersEditorLoadingStateChanged Broadcasts whenever one or more DataLayers editor loading state changed
Public class FOnDataLayerChanged Broadcasts whenever one or more DataLayers are modified

Typedefs

Name Description
FActorFilter  

Deprecated Functions

Type Name Description
UDataLayerIn... CreateDataLayer ( UDataLayerInstance* ParentData... ) Use CreateDataLayerInstance with FDataLayerCreationParameters instead
UDataLayerIn... GetDataLayer ( const FActorDataLayer& ActorDataLa... ) Use GetDataLayerInstance instead
UDataLayerIn... GetDataLayerFromLabel ( const FName& DataLayerLabel ) Use GetDataLayerInstance instead
bool RenameDataLayer ( UDataLayerInstance* DataLayer, const FName& NewDataLayerLabel ) Renaming is not permitted anymore
bool SetDataLayerIsDynamicallyLoadedInEditor ( UDEPRECATED_DataLayer* DataLay..., const bool bIsLoadedInEditor, const bool bIsFromUserChange ) Use SetDataLayerIsLoadedInEditor() instead.
bool SetDataLayersIsDynamicallyLoadedInEditor ( const TArray< UDEPRECATED_DataLayer..., const bool bIsLoadedInEditor, const bool bIsFromUserChange ) Use SetDataLayersIsLoadedInEditor() instead.
bool ToggleDataLayerIsDynamicallyLoadedInEditor ( UDEPRECATED_DataLayer* DataLay..., const bool bIsFromUserChange ) Use ToggleDataLayerIsLoadedInEditor() instead.
bool ToggleDataLayersIsDynamicallyLoadedInEditor ( const TArray< UDEPRECATED_DataLayer..., const bool bIsFromUserChange ) Use ToggleDataLayersIsLoadedInEditor() instead.
void UpdateActorAllViewsVisibility ( AActor* Actor ) Per-view Data Layer visibility was removed.
void UpdateActorViewVisibility ( FLevelEditorViewportClient* Vi..., AActor* Actor, const bool bReregisterIfDirty ) Per-view Data Layer visibility was removed.
PRAGMA_DISAB... UpdateAllViewVisibility ( UDEPRECATED_DataLayer* DataLay... ) Per-view Data Layer visibility was removed.
void UpdatePerViewVisibility ( FLevelEditorViewportClient* Vi..., UDEPRECATED_DataLayer* DataLay... ) Per-view Data Layer visibility was removed.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library