Navigation
API > API/Runtime > API/Runtime/Engine > API/Runtime/Engine/WorldPartition > API/Runtime/Engine/WorldPartition/DataLayer
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UDataLayerInstance
- UDataLayerInstancePrivate
- UDataLayerInstanceWithAsset
- UExternalDataLayerInstance
- UDeprecatedDataLayerInstance
References
| Module | Engine |
| Header | /Engine/Source/Runtime/Engine/Public/WorldPartition/DataLayer/DataLayerInstance.h |
| Include | #include "WorldPartition/DataLayer/DataLayerInstance.h" |
Syntax
UCLASS (Config=Engine, PerObjectConfig, BlueprintType,
AutoCollapseCategories=("Data Layer|Advanced"),
AutoExpandCategories=("Data Layer|Editor", "Data Layer|Advanced|Runtime"), MinimalAPI)
class UDataLayerInstance : public UObject
Variables
| Type | Name | Description | |
|---|---|---|---|
| uint32: 1 | bIsInitiallyLoadedInEditor | Determines the default value of the data layer's loaded state in editor if it hasn't been changed in data layer outliner by the user | |
| uint32: 1 | bIsInitiallyVisible | Whether actors associated with the Data Layer should be initially visible in the viewport when loading the map | |
| uint32: 1 | bIsLoadedInEditor | Wheter the data layer is loaded in editor (user setting) | |
| uint32: 1 | bIsLoadedInEditorChangedByUserOperation | Whether this data layer editor visibility was changed by a user operation | |
| uint32: 1 | bIsLocked | Whether this data layer is locked, which means the user can't change actors assignation, remove or rename it | |
| uint32: 1 | bIsVisible | Whether actors associated with the DataLayer are visible in the viewport | |
| uint32: 1 | bUndoIsLoadedInEditor | ||
| EDataLayerRuntimeState | InitialRuntimeState | Initial runtime state of this data layer instance. |
Constructors
| Type | Name | Description | |
|---|---|---|---|
UDataLayerInstance
(
const FObjectInitializer& ObjectInitializer |
Functions
| Type | Name | Description | |
|---|---|---|---|
| bool | Actor assignation and removal. | ||
| bool | |||
| bool | CanAddActor
(
AActor* Actor, |
||
| bool | CanBeChildOf
(
const UDataLayerInstance* InParent, |
Data Layer Instance features support. | |
| bool | |||
| bool | CanBeRemoved () |
||
| bool | |||
| bool | |||
| bool | CanHaveChildDataLayerInstance
(
const UDataLayerInstance* InChildDataLayerInstance |
||
| bool | |||
| bool | |||
| bool | |||
| bool | CanParent
(
const UDataLayerInstance* InParent |
||
| bool | CanRemoveActor
(
AActor* Actor, |
||
| bool | CanUserAddActors
(
FText* OutReason |
||
| bool | CanUserRemoveActors
(
FText* OutReason |
||
| void | ForEachChild
(
TFunctionRef< bool(const UDataLayerInstance*)> Operation |
||
| const UDataLayerAsset * | GetAsset () |
||
| bool | GetAssetRegistryInfoFromPackage
(
const FAssetData& InAsset, |
||
| bool | GetAssetRegistryInfoFromPackage
(
FName InDataLayerInstancePackageName, |
||
| const TArray< TObjectPtr< UDataLayerInstance > > & | GetChildren () |
||
| FName | |||
| FString | |||
| const TCHAR * | Helpers. | ||
| FString | |||
| FText | GetDataLayerText
(
const UDataLayerInstance* InDataLayer |
||
| FColor | |||
| AWorldDataLayers * | |||
| EDataLayerRuntimeState | |||
| EDataLayerRuntimeState | |||
| UWorld * | |||
| AWorldDataLayers * | |||
| const UDataLayerInstance * | GetParent () |
||
| UDataLayerInstance * | GetParent () |
||
| const UExternalDataLayerInstance * | |||
| EDataLayerRuntimeState | |||
| EDataLayerType | GetType () |
||
| T * | |||
| bool | Actor Editor Context. | ||
| bool | IsClientOnly () |
||
| bool | |||
| bool | |||
| bool | |||
| bool | |||
| bool | |||
| bool | |||
| bool | |||
| bool | |||
| bool | IsLocked () |
||
| bool | |||
| bool | IsParentDataLayerTypeCompatible
(
const UDataLayerInstance* InParent, |
||
| bool | IsReadOnly
(
FText* OutReason |
||
| bool | IsRuntime () |
||
| bool | IsServerOnly () |
||
| bool | IsVisible () |
||
| bool | PerformAddActor
(
AActor* InActor |
||
| bool | PerformRemoveActor
(
AActor* InActor |
||
| void | PerformSetDataLayerShortName
(
const FString& InNewShortName |
||
| bool | RelabelDataLayer
(
FName NewDataLayerLabel |
||
| bool | RemoveActor
(
AActor* Actor |
||
| bool | |||
| void | SetChildParent
(
UDataLayerInstance* InParent |
||
| void | SetIsInitiallyVisible
(
bool bIsInitiallyVisible |
||
| void | SetIsLoadedInEditor
(
bool bIsLoadedInEditor, |
||
| void | SetIsLocked
(
bool bInIsLocked |
||
| bool | SetParent
(
UDataLayerInstance* InParent |
Getters/Setters. | |
| void | SetVisible
(
bool bIsVisible |
||
| bool | |||
| bool | |||
| bool | Validate
(
IStreamingGenerationErrorHandler* ErrorHandler |
Validation. |
Overridden from UObject
| Type | Name | Description | |
|---|---|---|---|
| bool | CanEditChange
(
const FProperty* InProperty |
Called by the editor to query whether a property of this object is allowed to be modified. | |
| void | GetAssetRegistryTags
(
FAssetRegistryTagsContext Context |
Gathers a list of asset registry searchable tags which are name/value pairs with some type information This only needs to be implemented for asset objects | |
| void | GetAssetRegistryTags
(
TArray< FAssetRegistryTag >& OutTags |
||
| bool | IsAsset () |
Returns true if this object is considered an asset. | |
| 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. |