1. Epic GamesDeveloper
  3. AWorldDataLayers

AWorldDataLayers

Actor containing data layers instances within a world.

API > API/Runtime > API/Runtime/Engine

Actor containing data layers instances within a world.

   
Name AWorldDataLayers
Type class
Header File /Engine/Source/Runtime/Engine/Public/WorldPartition/DataLayer/WorldDataLayers.h
Include Path #include "WorldPartition/DataLayer/WorldDataLayers.h"

Syntax

UCLASS (  
       HideCategories=(Actor, HLOD, Cooking, Transform, Advanced, Display, Events, Object, Physics, Attachment, Info, Input, Blueprint, Layers, Tags, Replication),  
       NotPlaceable, MinimalAPI)  
class AWorldDataLayers :  
    public AInfo ,  
    public IDataLayerInstanceProvider

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

AWorldDataLayers ( const FObjectInitializer& ObjectInitializer
)

   WorldPartition/DataLayer/WorldDataLayers.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
ActiveDataLayerNames TSet< FName > TSet do not support replication so we replicate an array and update the set in the OnRep_ActiveDataLayerNames/OnRep_LoadedDataLayerNames. WorldPartition/DataLayer/WorldDataLayers.h  
bAllowRuntimeDataLayerEditing bool True when Runtime Data Layer editing is allowed. WorldPartition/DataLayer/WorldDataLayers.h  
bHasDeprecatedDataLayers bool   WorldPartition/DataLayer/WorldDataLayers.h  
bUseExternalPackageDataLayerInstances bool   WorldPartition/DataLayer/WorldDataLayers.h  
CachedDataLayerInstances TSet< TObjectPtr< UDataLayerInstance > > Used to compare state pre/post undo. WorldPartition/DataLayer/WorldDataLayers.h  
CurrentDataLayers FActorPlacementDataLayers   WorldPartition/DataLayer/WorldDataLayers.h
  • Transient
CurrentDataLayersStack TArray< FActorPlacementDataLayers >   WorldPartition/DataLayer/WorldDataLayers.h  
DataLayerInstances TSet< TObjectPtr< UDataLayerInstance > >   WorldPartition/DataLayer/WorldDataLayers.h  
DataLayersStateEpoch int32   WorldPartition/DataLayer/WorldDataLayers.h  
DeprecatedDataLayerNameToDataLayerInstance TMap< FName, TWeakObjectPtr< UDataLayerInstance > >   WorldPartition/DataLayer/WorldDataLayers.h  
EffectiveStates FWorldDataLayersEffectiveStates   WorldPartition/DataLayer/WorldDataLayers.h  
ExternalPackageDataLayerInstances TSet< TObjectPtr< UDataLayerInstance > > Data layer instances stored in their external package (only used when UseExternalPackageDataLayerInstances is True) WorldPartition/DataLayer/WorldDataLayers.h
  • Transient
LoadedDataLayerNames TSet< FName >   WorldPartition/DataLayer/WorldDataLayers.h  
LoadedExternalPackageDataLayerInstances TArray< TObjectPtr< UDataLayerInstance > > Temporary array containing data layer instances manually loaded from their external packages WorldPartition/DataLayer/WorldDataLayers.h
  • Transient
LocalActiveDataLayerNames TSet< FName >   WorldPartition/DataLayer/WorldDataLayers.h  
LocalLoadedDataLayerNames TSet< FName >   WorldPartition/DataLayer/WorldDataLayers.h  
RepActiveDataLayerNames TArray< FName >   WorldPartition/DataLayer/WorldDataLayers.h
  • Transient
  • Replicated
  • ReplicatedUsing=OnRep_ActiveDataLayerNames
RepEffectiveActiveDataLayerNames TArray< FName >   WorldPartition/DataLayer/WorldDataLayers.h
  • Transient
  • Replicated
  • ReplicatedUsing=OnRep_EffectiveActiveDataLayerNames
RepEffectiveLoadedDataLayerNames TArray< FName >   WorldPartition/DataLayer/WorldDataLayers.h
  • Transient
  • Replicated
  • ReplicatedUsing=OnRep_EffectiveLoadedDataLayerNames
RepLoadedDataLayerNames TArray< FName >   WorldPartition/DataLayer/WorldDataLayers.h
  • Transient
  • Replicated
  • ReplicatedUsing=OnRep_LoadedDataLayerNames
RootExternalDataLayerInstance TObjectPtr< UExternalDataLayerInstance >   WorldPartition/DataLayer/WorldDataLayers.h  
TransientDataLayerInstances TArray< TObjectPtr< UDataLayerInstance > >   WorldPartition/DataLayer/WorldDataLayers.h
  • Transient

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool AddToActorEditorContext ( UDataLayerInstance* InDataLayerInstance
)

   WorldPartition/DataLayer/WorldDataLayers.h  

bool CanReferenceDataLayerAsset ( const UDataLayerAsset* InDataLayerAsset,
FText* OutFailureReason
) const

   WorldPartition/DataLayer/WorldDataLayers.h  

bool ContainsDataLayer ( const UDEPRECATED_DataLayer* InDataLayer
) const

   WorldPartition/DataLayer/WorldDataLayers.h  

bool ContainsDataLayer ( const UDataLayerInstance* InDataLayer
) const

   WorldPartition/DataLayer/WorldDataLayers.h  

DataLayerInstanceType * CreateDataLayer ( CreationsArgs... InCreationArgs
)

   WorldPartition/DataLayer/WorldDataLayers.h  

void DumpDataLayers ( FOutputDevice& OutputDevice
) const

   WorldPartition/DataLayer/WorldDataLayers.h  
  WorldPartition/DataLayer/WorldDataLayers.h  

void ForEachDataLayer ( TFunctionRef< bool(UDataLayerInstance*)> Func
) const

   WorldPartition/DataLayer/WorldDataLayers.h  
  WorldPartition/DataLayer/WorldDataLayers.h  
  WorldPartition/DataLayer/WorldDataLayers.h  

const TSet< FName > & GetActiveDataLayerNames()

   WorldPartition/DataLayer/WorldDataLayers.h  

TArray< UDataLayerInstance * > GetActorEditorContextDataLayers()

   WorldPartition/DataLayer/WorldDataLayers.h  

bool GetAllowRuntimeDataLayerEditing()

   WorldPartition/DataLayer/WorldDataLayers.h  

EDataLayerRuntimeState GetDataLayerEffectiveRuntimeStateByName ( FName InDataLAyerName
) const

   WorldPartition/DataLayer/WorldDataLayers.h  

const UDataLayerInstance * GetDataLayerFromLabel ( const FName& InDataLayerLabel
) const

   WorldPartition/DataLayer/WorldDataLayers.h  

const UDataLayerInstance * GetDataLayerInstance ( const FName& InDataLayerInstanceName
) const

   WorldPartition/DataLayer/WorldDataLayers.h  

const UDataLayerInstance * GetDataLayerInstance ( const FActorDataLayer& InActorDataLayer
) const

   WorldPartition/DataLayer/WorldDataLayers.h  

const UDataLayerInstance * GetDataLayerInstance ( const UDataLayerAsset* InDataLayerAsset
) const

   WorldPartition/DataLayer/WorldDataLayers.h  

const UDataLayerInstance * GetDataLayerInstanceFromAssetName ( const FName& InDataLayerAssetPathName
) const

   WorldPartition/DataLayer/WorldDataLayers.h  

TArray< FName > GetDataLayerInstanceNames ( const TArray< const UDataLayerAsset* >& InDataLayersAssets
) const

   WorldPartition/DataLayer/WorldDataLayers.h  

TArray< FName > GetDataLayerInstanceNames ( const TArray< FActorDataLayer >& InActorDataLayers
) const

   WorldPartition/DataLayer/WorldDataLayers.h  

TArray< const UDataLayerInstance * > GetDataLayerInstances ( const TArray< FActorDataLayer >& InActorDataLayers
) const

   WorldPartition/DataLayer/WorldDataLayers.h  

TArray< const UDataLayerInstance * > GetDataLayerInstances ( const TArray< FName >& InDataLayerInstanceNames
) const

   WorldPartition/DataLayer/WorldDataLayers.h  

TArray< const UDataLayerInstance * > GetDataLayerInstances ( const TArray< UDataLayerAsset* >& InDataLayersAssets
) const

   WorldPartition/DataLayer/WorldDataLayers.h  

TArray< const UDataLayerInstance * > GetDataLayerInstances ( const TArray< const UDataLayerAsset* >& InDataLayersAssets
) const

   WorldPartition/DataLayer/WorldDataLayers.h  

EDataLayerRuntimeState GetDataLayerRuntimeStateByName ( FName InDataLayerName
) const

   WorldPartition/DataLayer/WorldDataLayers.h  

int32 GetDataLayersStateEpoch()

   WorldPartition/DataLayer/WorldDataLayers.h
  • NetMulticast
  • Reliable

EDataLayerState GetDataLayerStateByName ( FName InDataLayerName
) const

   WorldPartition/DataLayer/WorldDataLayers.h  

const TSet< FName > & GetEffectiveActiveDataLayerNames()

   WorldPartition/DataLayer/WorldDataLayers.h  

const TSet< FName > & GetEffectiveLoadedDataLayerNames()

   WorldPartition/DataLayer/WorldDataLayers.h  

const UExternalDataLayerInstance * GetExternalDataLayerInstance ( const UExternalDataLayerAsset* InExternalDataLayerAsset
) const

   WorldPartition/DataLayer/WorldDataLayers.h  

const TSet< FName > & GetLoadedDataLayerNames()

   WorldPartition/DataLayer/WorldDataLayers.h  

void GetUserLoadedInEditorStates ( TArray< FName >& OutDataLayersLoadedInEditor,
TArray< FName >& OutDataLayersNotLoadedInEditor
) const

   WorldPartition/DataLayer/WorldDataLayers.h  

bool HasDeprecatedDataLayers()

   WorldPartition/DataLayer/WorldDataLayers.h  

bool IsActorEditorContextCurrentColorized ( const UDataLayerInstance* InDataLayerInstance
) const

   WorldPartition/DataLayer/WorldDataLayers.h  

bool IsEmpty()

   WorldPartition/DataLayer/WorldDataLayers.h  

bool IsExternalDataLayerWorldDataLayers()

   WorldPartition/DataLayer/WorldDataLayers.h  

bool IsInActorEditorContext ( const UDataLayerInstance* InDataLayerInstance
) const

   WorldPartition/DataLayer/WorldDataLayers.h  

bool IsReadOnly ( FText* OutReason
) const

   WorldPartition/DataLayer/WorldDataLayers.h  

bool IsSubWorldDataLayers()

   WorldPartition/DataLayer/WorldDataLayers.h  

bool IsUsingExternalPackageDataLayerInstances()

   WorldPartition/DataLayer/WorldDataLayers.h  

void OnDataLayerRuntimeStateChanged ( const UDataLayerInstance* InDataLayer,
EDataLayerRuntimeState InState
)

   WorldPartition/DataLayer/WorldDataLayers.h
  • NetMulticast
  • Reliable

void OverwriteDataLayerRuntimeStates ( const TArray< IdentifierType >* InActiveDataLayers,
const TArray< IdentifierType >* InLoadedDataLayers
)

 Todo_ow: Remove this WorldPartition/DataLayer/WorldDataLayers.h  

void OverwriteDataLayerRuntimeStates ( const TArray< T >* InActiveDataLayers,
const TArray< T >* InLoadedDataLayers
)

 Allows overriding of DataLayers with PlayFromHere. WorldPartition/DataLayer/WorldDataLayers.h  

void PopActorEditorContext ( int32 InContextID
)

   WorldPartition/DataLayer/WorldDataLayers.h  

void PushActorEditorContext ( int32 InContextID,
bool bDuplicateContext
)

   WorldPartition/DataLayer/WorldDataLayers.h  

bool RemoveDataLayer ( const UDataLayerInstance* InDataLayer,
bool bInResolveActorDescContainers
)

   WorldPartition/DataLayer/WorldDataLayers.h  

bool RemoveDataLayer ( const UDEPRECATED_DataLayer* InDataLayer
)

   WorldPartition/DataLayer/WorldDataLayers.h  

int32 RemoveDataLayers ( const TArray< UDataLayerInstance* >& InDataLayerInstances,
bool bInResolveActorDescContainers
)

   WorldPartition/DataLayer/WorldDataLayers.h  

bool RemoveFromActorEditorContext ( UDataLayerInstance* InDataLayerInstance
)

   WorldPartition/DataLayer/WorldDataLayers.h  

void SetAllowRuntimeDataLayerEditing ( bool bInAllowRuntimeDataLayerEditing
)

   WorldPartition/DataLayer/WorldDataLayers.h  

bool SetDataLayerRuntimeState ( const UDataLayerInstance* InDataLayerInstance,
EDataLayerRuntimeState InState,
bool bIsRecursive
)

 DataLayer Runtime State. WorldPartition/DataLayer/WorldDataLayers.h  

PRAGMA_DISABLE_DEPRECATION_WARNINGS void SetDataLayerState ( FActorDataLayer InDataLayer,
EDataLayerState InState
)

   WorldPartition/DataLayer/WorldDataLayers.h  

bool SetUseExternalPackageDataLayerInstances ( bool bInNewValue,
bool bInInteractiveMode
)

   WorldPartition/DataLayer/WorldDataLayers.h  

bool SupportsExternalPackageDataLayerInstances()

   WorldPartition/DataLayer/WorldDataLayers.h  

Overridden from AActor

Name Remarks Include Path Unreal Specifiers

virtual bool ActorTypeSupportsDataLayer()

   WorldPartition/DataLayer/WorldDataLayers.h  

virtual bool ActorTypeSupportsExternalDataLayer()

   WorldPartition/DataLayer/WorldDataLayers.h  

virtual TUniquePtr< class FWorldPartitionActorDesc > CreateClassActorDesc()

 Creates an uninitialized actor descriptor from this actor. Meant to be called on the class CDO. WorldPartition/DataLayer/WorldDataLayers.h  

virtual bool IsLockLocation()

 Returns true if actor location should be locked. WorldPartition/DataLayer/WorldDataLayers.h  

virtual bool IsUserManaged()

 Used to know if actor supports some editor operations. (Delete, Replace) WorldPartition/DataLayer/WorldDataLayers.h  

virtual void OnLoadedActorRemovedFromLevel()

 Called when this actor gets removed from the level in the editor by world partition unloading. WorldPartition/DataLayer/WorldDataLayers.h  

virtual bool ShouldImport ( FStringView ActorPropString,
bool IsMovingLevel
)

 Called before editor paste, true allow import WorldPartition/DataLayer/WorldDataLayers.h  
Determine how this actor should be referenced by the level when external (saved in its own package). WorldPartition/DataLayer/WorldDataLayers.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual bool IsEditorOnly()

   WorldPartition/DataLayer/WorldDataLayers.h  

virtual void PostEditUndo()

   WorldPartition/DataLayer/WorldDataLayers.h  

virtual void PostLoad()

   WorldPartition/DataLayer/WorldDataLayers.h  

virtual void PreEditUndo()

   WorldPartition/DataLayer/WorldDataLayers.h  

virtual void Serialize ( FArchive& Ar
)

   WorldPartition/DataLayer/WorldDataLayers.h  

Protected

Name Remarks Include Path Unreal Specifiers

void InitializeDataLayerRuntimeStates()

   WorldPartition/DataLayer/WorldDataLayers.h  

void OnRep_ActiveDataLayerNames()

   WorldPartition/DataLayer/WorldDataLayers.h  

void OnRep_EffectiveActiveDataLayerNames()

   WorldPartition/DataLayer/WorldDataLayers.h  

void OnRep_EffectiveLoadedDataLayerNames()

   WorldPartition/DataLayer/WorldDataLayers.h  

void OnRep_LoadedDataLayerNames()

   WorldPartition/DataLayer/WorldDataLayers.h  

void ResetDataLayerRuntimeStates ( bool bFlushNet
)

   WorldPartition/DataLayer/WorldDataLayers.h  

Static

Name Remarks Include Path Unreal Specifiers

static AWorldDataLayers * Create ( UWorld* World,
FName InWorldDataLayerName
)

   WorldPartition/DataLayer/WorldDataLayers.h  

static AWorldDataLayers * Create ( const FActorSpawnParameters& SpawnParameters
)

   WorldPartition/DataLayer/WorldDataLayers.h  

static FName GetWorldPartionWorldDataLayersName()

   WorldPartition/DataLayer/WorldDataLayers.h  

static FName GetWorldPartitionWorldDataLayersName()

   WorldPartition/DataLayer/WorldDataLayers.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page