Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Engine > WorldPartition > DataLayer > AWorldDataLayers

Light Theme

Dark Theme

AWorldDataLayers

Actor containing data layers instances within a world.

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

AActor

AInfo

AWorldDataLayers

References

Module	Engine
Header	/Engine/Source/Runtime/Engine/Public/WorldPartition/DataLayer/WorldDataLayers.h
Include	#include "WorldPartition/DataLayer/WorldDataLayers.h"

Syntax

class AWorldDataLayers : public AInfo

Remarks

Actor containing data layers instances within a world.

Constructors

	Name	Description
	AWorldDataLayers ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
bool	AddToActorEditorContext ( UDataLayerInstance* InDataLaye... )
bool	ContainsDataLayer ( const UDataLayerInstance* InDa... )
AWorldDataLa...	Create ( UWorld* World, FName InWorldDataLayerName )
AWorldDataLa...	Create ( const FActorSpawnParameters& Spawn... )
DataLayerIns...	CreateDataLayer ( CreationsArgs... InCreationArgs )
void	DumpDataLayers ( FOutputDevice& OutputDevice )
void	ForEachDataLayer ( TFunctionRef< bool(UDataLayerInstan... )
void	ForEachDataLayer ( TFunctionRef< bool(UDataLayerInstan... )
TArray< UDat...	GetActorEditorContextDataLayers()
bool	GetAllowRuntimeDataLayerEditing()
EDataLayerRu...	GetDataLayerEffectiveRuntimeStateByName ( FName InDataLAyerName )
const UDataL...	GetDataLayerInstance ( const UDataLayerAsset* InDataL... )
const UDataL...	GetDataLayerInstance ( const FName& InDataLayerInstanceNa... )
const UDataL...	GetDataLayerInstanceFromAssetName ( const FName& InDataLayerAssetFullN... )
TArray< FNam...	GetDataLayerInstanceNames ( const TArray< const UDataLayerAsset... )
TArray< cons...	GetDataLayerInstances ( const TArray< UDataLayerAsset*... )
TArray< cons...	GetDataLayerInstances ( const TArray< FName >& InDataLayer... )
TArray< cons...	GetDataLayerInstances ( const TArray< const UDataLayerAsset... )
EDataLayerRu...	GetDataLayerRuntimeStateByName ( FName InDataLayerName )
int32	GetDataLayersStateEpoch()
const TSet< ...	GetEffectiveActiveDataLayerNames()
const TSet< ...	GetEffectiveLoadedDataLayerNames()
FName	GetWorldPartionWorldDataLayersName()
bool	HasDeprecatedDataLayers()
void	InitializeDataLayerRuntimeStates()
bool	IsEmpty()
bool	IsInActorEditorContext ( const UDataLayerInstance* InDa... )
bool	IsRuntimeRelevant()
bool	IsSubWorldDataLayers()
bool	IsTheMainWorldDataLayers()
void	OnDataLayerRuntimeStateChanged ( const UDataLayerInstance* InDa..., EDataLayerRuntimeState InState )
void	OnRep_ActiveDataLayerNames()
void	OnRep_EffectiveActiveDataLayerNames()
void	OnRep_EffectiveLoadedDataLayerNames()
void	OnRep_LoadedDataLayerNames()
void	OverwriteDataLayerRuntimeStates ( const TArray< IdentifierType >..., const TArray< IdentifierType >... )
void	OverwriteDataLayerRuntimeStates ( const TArray< T >* InActiveDat..., const TArray< T >* InLoadedDat... )	Allows overriding of DataLayers with PlayFromHere.
void	PopActorEditorContext ( int32 InContextID )
void	PushActorEditorContext ( int32 InContextID )
bool	RemoveDataLayer ( const UDataLayerInstance* InDa... )
int32	RemoveDataLayers ( const TArray< UDataLayerInstance&#... )
bool	RemoveFromActorEditorContext ( UDataLayerInstance* InDataLaye... )
void	ResetDataLayerRuntimeStates()
void	SetAllowRuntimeDataLayerEditing ( bool bInAllowRuntimeDataLayerEditin... )
void	SetDataLayerRuntimeState ( const UDataLayerInstance* InDa..., EDataLayerRuntimeState InState, bool bIsRecursive )	DataLayer Runtime State.

Overridden from AActor

	Name	Description
void	BeginPlay()	Overridable native event for when play begins for this actor.
TUniquePtr< ...	CreateClassActorDesc()	Creates an uninitialized actor descriptor from this actor. Meant to be called on the class CDO.
bool	IsLockLocation()	Returns true if actor location should be locked.
bool	IsUserManaged()	Used to know if actor supports some editor operations. (Delete, Replace)
void	PostUnregisterAllComponents()	Called after all currently registered components are cleared
void	PreRegisterAllComponents()	Called before all the components in the Components array are registered, called both in editor and during gameplay
void	RewindForReplay()	Called on the actor before checkpoint data is applied during a replay.
bool	ShouldImport ( FStringView ActorPropString, bool IsMovingLevel )	Called before editor paste, true allow import
bool	ShouldLevelKeepRefIfExternal()	Determine how this actor should be referenced by the level when external (saved in its own package).

Overridden from UObject

	Name	Description
void	PostEditUndo()	Called after applying a transaction to the object.
void	PostLoad()	Do any object-specific cleanup required immediately after loading an object.
void	PreEditUndo()	Called before applying a transaction to the object.

Typedefs

Name	Description
FDataLayersFilterDelegate

Constants

Name	Description
DataLayersStateEpoch

Deprecated Variables

		Name	Description
	FDataLayersFilt...	DataLayersFilterDelegate	do not use, will be replaced by another mechanism for initial release.

Deprecated Functions

	Name	Description
bool	ContainsDataLayer ( const UDEPRECATED_DataLayer* I... )	Convert DataLayer using UDataLayerToAssetCommandlet and use UDataLayerInstance* overload instead.
FName	GenerateUniqueDataLayerLabel ( const FName& InDataLayerLabel )	Label usage is deprecated.
const TSet< ...	GetActiveDataLayerNames()	Use GetEffectiveActiveDataLayerNames() instead.
const UDataL...	GetDataLayerFromLabel ( const FName& InDataLayerLabel )	Convert UDataLayers to UDataLayerAsset and UDataLayerInstance using DataLayerToAssetCommandLet
const UDataL...	GetDataLayerInstance ( const FActorDataLayer& InActorData... )	Use GetDataLayerInstance with FName or UDataLayerAsset instead
TArray< FNam...	GetDataLayerInstanceNames ( const TArray< FActorDataLayer >& I... )	Use GetDataLayerInstanceNames with UDataLayerAsset instead
TArray< cons...	GetDataLayerInstances ( const TArray< FActorDataLayer >& I... )	Use GetDataLayerInstances with FName or UDataLayerAsset instead
EDataLayerSt...	GetDataLayerStateByName ( FName InDataLayerName )	Use GetDataLayerRuntimeStateByName() instead.
const TSet< ...	GetLoadedDataLayerNames()	Use GetEffectiveLoadedDataLayerNames() instead.
void	GetUserLoadedInEditorStates ( TArray< FName >& OutDataLayersLoad..., TArray< FName >& OutDataLayersNotL... )	Use UDataLayerSubsystem::GetUserLoadedInEditorStates insteaed
bool	RemoveDataLayer ( const UDEPRECATED_DataLayer* I... )	Convert DataLayer using UDataLayerToAssetCommandlet and use UDataLayerInstance* overload instead.
PRAGMA_DISAB...	SetDataLayerState ( FActorDataLayer InDataLayer, EDataLayerState InState )	Use SetDataLayerRuntimeState() instead.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Cancel