1. Epic GamesDeveloper
  3. UDataLayerEditorSubsystem

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,  
    public IActorEditorContextClient,  
    public FTickableGameObject

Constructors

  Type Name Description
Public function    

Destructors

  Type Name Description
Public function Virtual   Destructor

Functions

  Type Name Description
Public function bool

AddActorsToDataLayer ( const TArray< AActor* >& Actors,
UDataLayerInstance* DataLayer
)

 Add the actors to the DataLayer
Public function bool

AddActorsToDataLayers ( const TArray< AActor* >& Actors,
const TArray< UDataLayerInstance* >& DataLayers
)

 Add the actors to the DataLayers
Public function bool Adds the actor to the DataLayer.
Public function bool

AddActorToDataLayers ( AActor* Actor,
const TArray< UDataLayerInstance* >& DataLayers
)

 Adds the provided actor to the DataLayers.
Public function Const void Gets all known DataLayers and appends them to the provided array
Public function bool Adds selected actors to the DataLayer.
Public function bool Adds selected actors to the DataLayers.
Public function void

AddToActorEditorContext ( UDataLayerInstance* InDataLayerInstance
)

  
Public function Const void

AppendActorsFromDataLayer ( UDataLayerInstance* DataLayer,
TArray< AActor* >& InOutActors,
const TSharedPtr< FActorFilter >& Filter
)

 Appends all the actors associated with the specified DataLayer.
Public function Const void

AppendActorsFromDataLayer ( UDataLayerInstance* DataLayer,
TArray< AActor* >& InOutActors
)

 Appends all the actors associated with the specified DataLayer.
Public function Const void

AppendActorsFromDataLayers ( const TArray< UDataLayerInstance* >& DataLayers,
TArray< AActor* >& InOutActors,
const TSharedPtr< FActorFilter >& Filter
)

 Appends all the actors associated with ANY of the specified DataLayers.
Public function Const void

AppendActorsFromDataLayers ( const TArray< UDataLayerInstance* >& DataLayers,
TArray< AActor* >& InOutActors
)

 Appends all the actors associated with ANY of the specified DataLayers.
Public function UDataLayerInstance * Creates a UDataLayerInstance Object
Public function DataLayerType *

CreateDataLayerInstance ( AWorldDataLayers* WorldDataLayers,
Args&&... InArgs
)

  
Public function void

DeleteDataLayer ( UDataLayerInstance* DataLayerToDelete
)

 Deletes the provided DataLayer
Public function void

DeleteDataLayers ( const TArray< UDataLayerInstance* >& DataLayersToDelete
)

 Deletes all of the provided DataLayers
Public function Const bool Returns whether the DataLayer contains one of more actors that are part of the editor selection.
Public function Static UDataLayerEditorSubsystem *

Get ()

  
Public function Const TArray< AActor * > Gets all the actors associated with the specified DataLayer.
Public function Const TArray< AActor * > Gets all the actors associated with the specified DataLayer.
Public function Const TArray< AActor * >

GetActorsFromDataLayers ( const TArray< UDataLayerInstance* >& DataLayers,
const TSharedPtr< FActorFilter >& Filter
)

 Gets all the actors associated with ANY of the specified DataLayers.
Public function Const TArray< AActor * > Gets all the actors associated with ANY of the specified DataLayers.
Public function TArray< UDataLayerInstance * > Returns all Data Layers
Public function Const UDataLayerInstance *

GetDataLayerInstance ( const UDataLayerAsset* DataLayerAsset
)

 Gets the UDataLayerInstance associated to the DataLayerAsset
Public function Const UDataLayerInstance *

GetDataLayerInstance ( const FName& DataLayerInstanceName
)

 Gets the UDataLayerInstance Object of the DataLayer name
Public function Const TArray< UDataLayerInstance * >

GetDataLayerInstances ( const TArray< UDataLayerAsset* > DataLayerAssets
)

 Gets the UDataLayerInstances associated to the each DataLayerAssets
Public function Const TArray< const UDataLayerInstance * >

GetDataLayerInstances ( const TArray< const UDataLayerAsset* > DataLayerAssets
)

  
Public function Const bool Whether there are any deprecated DataLayerInstance found
Public function bool Checks to see if the specified actor is in an appropriate state to interact with DataLayers
Public function void Set the visibility of all DataLayers to true
Public function FOnActorDataLayersChanged &  
Public function FOnActorDataLayersEditorLoadingStateChanged &  
Public function FOnDataLayerChanged &  
Public function bool Removes an actor from all DataLayers.
Public function bool

RemoveActorFromDataLayer ( AActor* Actor,
UDataLayerInstance* DataLayerToRemove
)

 Removes an actor from the specified DataLayer.
Public function bool

RemoveActorFromDataLayers ( AActor* Actor,
const TArray< UDataLayerInstance* >& DataLayers
)

 Removes the provided actor from the DataLayers.
Public function bool Removes an actor from all DataLayers.
Public function bool

RemoveActorsFromDataLayer ( const TArray< AActor* >& Actors,
UDataLayerInstance* DataLayer
)

 Removes the actors from the specified DataLayer.
Public function bool

RemoveActorsFromDataLayers ( const TArray< AActor* >& Actors,
const TArray< UDataLayerInstance* >& DataLayers
)

 Remove the actors from the DataLayers
Public function void  
Public function bool Removes the selected actors from the DataLayer.
Public function bool Removes selected actors from the DataLayers.
Public function bool Resets user override settings of all DataLayers
Public function bool

SelectActorsInDataLayer ( UDataLayerInstance* DataLayer,
const bool bSelect,
const bool bNotify,
const bool bSelectEvenIfHidden,
const TSharedPtr< FActorFilter >& Filter
)

 Selects/de-selects actors belonging to the DataLayer.
Public function bool

SelectActorsInDataLayer ( UDataLayerInstance* DataLayer,
const bool bSelect,
const bool bNotify,
const bool bSelectEvenIfHidden
)

 Selects/de-selects actors belonging to the DataLayer.
Public function bool

SelectActorsInDataLayers ( const TArray< UDataLayerInstance* >& DataLayers,
const bool bSelect,
const bool bNotify,
const bool bSelectEvenIfHidden
)

 Selects/de-selects actors belonging to the DataLayers.
Public function bool

SelectActorsInDataLayers ( const TArray< UDataLayerInstance* >& DataLayers,
const bool bSelect,
const bool bNotify,
const bool bSelectEvenIfHidden,
const TSharedPtr< FActorFilter >& Filter
)

 Selects/de-selects actors belonging to the DataLayers.
Public function bool

SetDataLayerIsLoadedInEditor ( UDataLayerInstance* DataLayer,
const bool bIsLoadedInEditor,
const bool bIsFromUserChange
)

 Changes the DataLayer's IsLoadedInEditor flag to the provided state
Public function bool

SetDataLayerShortName ( UDataLayerInstance* InDataLayerInstance,
const FString& InNewShortName
)

 Assign new unique short name to DataLayerInstance if it supports it.
Public function bool

SetDataLayersIsLoadedInEditor ( const TArray< UDataLayerInstance* >& DataLayers,
const bool bIsLoadedInEditor,
const bool bIsFromUserChange
)

 Changes the IsLoadedInEditor flag of the DataLayers to the provided state
Public function void

SetDataLayersVisibility ( const TArray< UDataLayerInstance* >& DataLayers,
const bool bIsVisible
)

 Changes visibility of the DataLayers to the provided state
Public function void

SetDataLayerVisibility ( UDataLayerInstance* DataLayer,
const bool bIsVisible
)

 Changes the DataLayer's visibility to the provided state
Public function bool

SetParentDataLayer ( UDataLayerInstance* DataLayer,
UDataLayerInstance* ParentDataLayer
)

 Sets a Parent DataLayer for a specified DataLayer
Public function bool

ToggleDataLayerIsLoadedInEditor ( UDataLayerInstance* DataLayer,
const bool bIsFromUserChange
)

 Toggles the DataLayer's IsLoadedInEditor flag
Public function bool

ToggleDataLayersIsLoadedInEditor ( const TArray< UDataLayerInstance* >& DataLayers,
const bool bIsFromUserChange
)

 Toggles the IsLoadedInEditor flag of all of the DataLayers
Public function void Toggles the visibility of all of the DataLayers
Public function void Toggles the DataLayer's visibility
Public function bool

UpdateActorVisibility ( AActor* Actor,
bool& bOutSelectionChanged,
bool& bOutActorModified,
const bool bNotifySelectionChange,
const bool bRedrawViewports
)

 Updates the provided actors visibility in the viewports
Public function bool

UpdateAllActorsVisibility ( const bool bNotifySelectionChange,
const bool bRedrawViewports
)

 Updates the visibility of all actors in the viewports

Overridden from USubsystem

  Type Name Description
Public function Virtual void Internal cleanup
Public function Virtual void Prepares for use

Overridden from UObject

  Type Name Description
Public function Virtual void Called before destroying the object.

Overridden from IActorEditorContextClient

  Type Name Description
Public function Virtual Const bool

CanResetContext ( UWorld* InWorld
)

  
Public function Virtual Const bool  
Public function Virtual Const TSharedRef< SWidget >  
Public function Virtual FOnActorEditorContextClientChanged &  
Public function Virtual void

OnExecuteActorEditorContextAction ( UWorld* InWorld,
const EActorEditorContextAction& InType,
AActor* InActor
)

  

Overridden from FTickableGameObject

  Type Name Description
Public function Virtual Const UWorld *  
Public function Virtual Const bool Used to determine whether the object should be ticked in the editor.

Overridden from FTickableObjectBase

  Type Name Description
Public function Virtual Const TStatId Return the stat id to use for this tickable
Public function Virtual Const ETickableTickType Virtual that can be overloaded by the inheriting class.
Public function Virtual Const bool Virtual that can be overloaded by the inheriting class.
Public function Virtual 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
Public function UDataLayerInstance *

CreateDataLayer ( UDataLayerInstance* ParentDataLayer
)

 Use CreateDataLayerInstance with FDataLayerCreationParameters instead
Public function Const UDataLayerInstance *

GetDataLayer ( const FActorDataLayer& ActorDataLayer
)

 Use GetDataLayerInstance instead
Public function Const UDataLayerInstance *

GetDataLayerFromLabel ( const FName& DataLayerLabel
)

 Use GetDataLayerInstance instead
Public function bool

RenameDataLayer ( UDataLayerInstance* DataLayer,
const FName& NewDataLayerLabel
)

 Renaming is not permitted anymore
Public function bool

SetDataLayerIsDynamicallyLoadedInEditor ( UDEPRECATED_DataLayer* DataLayer,
const bool bIsLoadedInEditor,
const bool bIsFromUserChange
)

 Use SetDataLayerIsLoadedInEditor() instead.
Public function bool

SetDataLayersIsDynamicallyLoadedInEditor ( const TArray< UDEPRECATED_DataLayer* >& DataLayers,
const bool bIsLoadedInEditor,
const bool bIsFromUserChange
)

 Use SetDataLayersIsLoadedInEditor() instead.
Public function bool

ToggleDataLayerIsDynamicallyLoadedInEditor ( UDEPRECATED_DataLayer* DataLayer,
const bool bIsFromUserChange
)

 Use ToggleDataLayerIsLoadedInEditor() instead.
Public function bool

ToggleDataLayersIsDynamicallyLoadedInEditor ( const TArray< UDEPRECATED_DataLayer* >& DataLayers,
const bool bIsFromUserChange
)

 Use ToggleDataLayersIsLoadedInEditor() instead.
Public function void Per-view Data Layer visibility was removed.
Public function void

UpdateActorViewVisibility ( FLevelEditorViewportClient* ViewportClient,
AActor* Actor,
const bool bReregisterIfDirty
)

 Per-view Data Layer visibility was removed.
Public function PRAGMA_DISABLE_DEPRECATION_WARNINGSvoid Per-view Data Layer visibility was removed.
Public function void

UpdatePerViewVisibility ( FLevelEditorViewportClient* ViewportClient,
UDEPRECATED_DataLayer* DataLayerThatChanged
)

 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

On this page