UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
AWorldDataLayers Class Reference

#include <WorldDataLayers.h>

+ Inheritance diagram for AWorldDataLayers:

Public Member Functions

virtual ENGINE_API void PostLoad () override
 
virtual void Serialize (FArchive &Ar) override
 
ENGINE_API void DumpDataLayers (FOutputDevice &OutputDevice) const
 
ENGINE_API bool ContainsDataLayer (const UDataLayerInstance *InDataLayer) const
 
ENGINE_API const UDataLayerInstance * GetDataLayerInstance (const FName &InDataLayerInstanceName) const
 
ENGINE_API const UDataLayerInstance * GetDataLayerInstance (const UDataLayerAsset *InDataLayerAsset) const
 
ENGINE_API const UDataLayerInstance * GetDataLayerInstanceFromAssetName (const FName &InDataLayerAssetPathName) const
 
void ForEachDataLayer (TFunctionRef< bool(UDataLayerInstance *)> Func)
 
void ForEachDataLayer (TFunctionRef< bool(UDataLayerInstance *)> Func) const
 
ENGINE_API void ForEachDataLayerInstance (TFunctionRef< bool(UDataLayerInstance *)> Func)
 
ENGINE_API void ForEachDataLayerInstance (TFunctionRef< bool(UDataLayerInstance *)> Func) const
 
ENGINE_API TArray< const UDataLayerInstance * > GetDataLayerInstances (const TArray< FName > &InDataLayerInstanceNames) const
 
ENGINE_API const UExternalDataLayerInstance * GetExternalDataLayerInstance (const UExternalDataLayerAsset *InExternalDataLayerAsset) const
 
ENGINE_API bool IsExternalDataLayerWorldDataLayers () const
 
ENGINE_API bool SetDataLayerRuntimeState (const UDataLayerInstance *InDataLayerInstance, EDataLayerRuntimeState InState, bool bIsRecursive=false)
 
ENGINE_API EDataLayerRuntimeState GetDataLayerRuntimeStateByName (FName InDataLayerName) const
 
ENGINE_API EDataLayerRuntimeState GetDataLayerEffectiveRuntimeStateByName (FName InDataLAyerName) const
 
const TSet< FName > & GetEffectiveActiveDataLayerNames () const
 
const TSet< FName > & GetEffectiveLoadedDataLayerNames () const
 
ENGINE_API void OnDataLayerRuntimeStateChanged (const UDataLayerInstance *InDataLayer, EDataLayerRuntimeState InState)
 
int32 GetDataLayersStateEpoch () const
 
PRAGMA_DISABLE_DEPRECATION_WARNINGS void SetDataLayerState (FActorDataLayer InDataLayer, EDataLayerState InState)
 
EDataLayerState GetDataLayerStateByName (FName InDataLayerName) const
 
const TSet< FName > & GetActiveDataLayerNames () const
 
const TSet< FName > & GetLoadedDataLayerNames () const
 
ENGINE_API bool ContainsDataLayer (const UDEPRECATED_DataLayer *InDataLayer) const
 
PRAGMA_ENABLE_DEPRECATION_WARNINGS ENGINE_API const UDataLayerInstance * GetDataLayerInstance (const FActorDataLayer &InActorDataLayer) const
 
ENGINE_API TArray< FNameGetDataLayerInstanceNames (const TArray< FActorDataLayer > &InActorDataLayers) const
 
ENGINE_API TArray< const UDataLayerInstance * > GetDataLayerInstances (const TArray< FActorDataLayer > &InActorDataLayers) const
 
ENGINE_API const UDataLayerInstance * GetDataLayerFromLabel (const FName &InDataLayerLabel) const
 
void GetUserLoadedInEditorStates (TArray< FName > &OutDataLayersLoadedInEditor, TArray< FName > &OutDataLayersNotLoadedInEditor) const
 
- Public Member Functions inherited from IDataLayerInstanceProvider
virtual const UExternalDataLayerAssetGetRootExternalDataLayerAsset () const
 

Static Public Member Functions

static FName GetWorldPartionWorldDataLayersName ()
 
static FName GetWorldPartitionWorldDataLayersName ()
 

Protected Member Functions

ENGINE_API void InitializeDataLayerRuntimeStates ()
 
ENGINE_API void ResetDataLayerRuntimeStates (bool bFlushNet=true)
 
ENGINE_API void OnRep_ActiveDataLayerNames ()
 
ENGINE_API void OnRep_LoadedDataLayerNames ()
 
ENGINE_API void OnRep_EffectiveActiveDataLayerNames ()
 
ENGINE_API void OnRep_EffectiveLoadedDataLayerNames ()
 

Friends

class UWorldPartition
 
class UDataLayerManager
 
class UExternalDataLayerManager
 
class UDataLayerEditorSubsystem
 
struct FWorldDataLayersEffectiveStatesAccessor
 

Detailed Description

Actor containing data layers instances within a world.

Member Function Documentation

◆ ContainsDataLayer() [1/2]

bool AWorldDataLayers::ContainsDataLayer ( const UDataLayerInstance *  InDataLayer) const

◆ ContainsDataLayer() [2/2]

PRAGMA_DISABLE_DEPRECATION_WARNINGS bool AWorldDataLayers::ContainsDataLayer ( const UDEPRECATED_DataLayer InDataLayer) const

◆ DumpDataLayers()

void AWorldDataLayers::DumpDataLayers ( FOutputDevice OutputDevice) const

◆ ForEachDataLayer() [1/2]

void AWorldDataLayers::ForEachDataLayer ( TFunctionRef< bool(UDataLayerInstance *)>  Func)
inline

◆ ForEachDataLayer() [2/2]

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

◆ ForEachDataLayerInstance() [1/2]

void AWorldDataLayers::ForEachDataLayerInstance ( TFunctionRef< bool(UDataLayerInstance *)>  Func)

◆ ForEachDataLayerInstance() [2/2]

void AWorldDataLayers::ForEachDataLayerInstance ( TFunctionRef< bool(UDataLayerInstance *)>  Func) const

◆ GetActiveDataLayerNames()

const TSet< FName > & AWorldDataLayers::GetActiveDataLayerNames ( ) const
inline

◆ GetDataLayerEffectiveRuntimeStateByName()

EDataLayerRuntimeState AWorldDataLayers::GetDataLayerEffectiveRuntimeStateByName ( FName  InDataLAyerName) const

◆ GetDataLayerFromLabel()

const UDataLayerInstance * AWorldDataLayers::GetDataLayerFromLabel ( const FName InDataLayerLabel) const

◆ GetDataLayerInstance() [1/3]

PRAGMA_ENABLE_DEPRECATION_WARNINGS const UDataLayerInstance * AWorldDataLayers::GetDataLayerInstance ( const FActorDataLayer InActorDataLayer) const

◆ GetDataLayerInstance() [2/3]

const UDataLayerInstance * AWorldDataLayers::GetDataLayerInstance ( const FName InDataLayerInstanceName) const

◆ GetDataLayerInstance() [3/3]

const UDataLayerInstance * AWorldDataLayers::GetDataLayerInstance ( const UDataLayerAsset InDataLayerAsset) const

◆ GetDataLayerInstanceFromAssetName()

const UDataLayerInstance * AWorldDataLayers::GetDataLayerInstanceFromAssetName ( const FName InDataLayerAssetPathName) const

◆ GetDataLayerInstanceNames()

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

◆ GetDataLayerInstances() [1/2]

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

◆ GetDataLayerInstances() [2/2]

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

◆ GetDataLayerRuntimeStateByName()

EDataLayerRuntimeState AWorldDataLayers::GetDataLayerRuntimeStateByName ( FName  InDataLayerName) const

◆ GetDataLayersStateEpoch()

int32 AWorldDataLayers::GetDataLayersStateEpoch ( ) const
inline

◆ GetDataLayerStateByName()

EDataLayerState AWorldDataLayers::GetDataLayerStateByName ( FName  InDataLayerName) const
inline

◆ GetEffectiveActiveDataLayerNames()

const TSet< FName > & AWorldDataLayers::GetEffectiveActiveDataLayerNames ( ) const

◆ GetEffectiveLoadedDataLayerNames()

const TSet< FName > & AWorldDataLayers::GetEffectiveLoadedDataLayerNames ( ) const

◆ GetExternalDataLayerInstance()

const UExternalDataLayerInstance * AWorldDataLayers::GetExternalDataLayerInstance ( const UExternalDataLayerAsset InExternalDataLayerAsset) const

◆ GetLoadedDataLayerNames()

const TSet< FName > & AWorldDataLayers::GetLoadedDataLayerNames ( ) const
inline

◆ GetUserLoadedInEditorStates()

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

◆ GetWorldPartionWorldDataLayersName()

static FName AWorldDataLayers::GetWorldPartionWorldDataLayersName ( )
inlinestatic

◆ GetWorldPartitionWorldDataLayersName()

static FName AWorldDataLayers::GetWorldPartitionWorldDataLayersName ( )
inlinestatic

◆ InitializeDataLayerRuntimeStates()

void AWorldDataLayers::InitializeDataLayerRuntimeStates ( )
protected

◆ IsExternalDataLayerWorldDataLayers()

bool AWorldDataLayers::IsExternalDataLayerWorldDataLayers ( ) const

◆ OnDataLayerRuntimeStateChanged()

ENGINE_API void AWorldDataLayers::OnDataLayerRuntimeStateChanged ( const UDataLayerInstance *  InDataLayer,
EDataLayerRuntimeState  InState 
)

◆ OnRep_ActiveDataLayerNames()

void AWorldDataLayers::OnRep_ActiveDataLayerNames ( )
protected

◆ OnRep_EffectiveActiveDataLayerNames()

void AWorldDataLayers::OnRep_EffectiveActiveDataLayerNames ( )
protected

◆ OnRep_EffectiveLoadedDataLayerNames()

void AWorldDataLayers::OnRep_EffectiveLoadedDataLayerNames ( )
protected

◆ OnRep_LoadedDataLayerNames()

void AWorldDataLayers::OnRep_LoadedDataLayerNames ( )
protected

◆ PostLoad()

void AWorldDataLayers::PostLoad ( )
overridevirtual

◆ ResetDataLayerRuntimeStates()

void AWorldDataLayers::ResetDataLayerRuntimeStates ( bool  bFlushNet = true)
protected

◆ Serialize()

void AWorldDataLayers::Serialize ( FArchive Ar)
overridevirtual

◆ SetDataLayerRuntimeState()

bool AWorldDataLayers::SetDataLayerRuntimeState ( const UDataLayerInstance *  InDataLayerInstance,
EDataLayerRuntimeState  InState,
bool  bIsRecursive = false 
)

◆ SetDataLayerState()

PRAGMA_DISABLE_DEPRECATION_WARNINGS void AWorldDataLayers::SetDataLayerState ( FActorDataLayer  InDataLayer,
EDataLayerState  InState 
)
inline

Friends And Related Symbol Documentation

◆ FWorldDataLayersEffectiveStatesAccessor

◆ UDataLayerEditorSubsystem

friend class UDataLayerEditorSubsystem
friend

◆ UDataLayerManager

friend class UDataLayerManager
friend

◆ UExternalDataLayerManager

◆ UWorldPartition

friend class UWorldPartition
friend

The documentation for this class was generated from the following files: