1. Epic GamesDeveloper
  3. ALandscape

ALandscape

API > API/Runtime > API/Runtime/Landscape

Inheritance Hierarchy

References

   
Module Landscape
Header /Engine/Source/Runtime/Landscape/Classes/Landscape.h
Include #include "Landscape.h"

Syntax

UCLASS (MinimalAPI, ShowCategories=(Display, Movement, Collision, Lighting, LOD, Input),  
       HideCategories=(Mobility))  
class ALandscape : public ALandscapeProxy

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere bool bAreNewLandscapeActorsSpatiallyLoaded Landscape actor has authority on default streaming behavior for new actors : LandscapeStreamingProxies & LandscapeSplineActors
Public variable UProperty Category, EditAnywhere bool bCanHaveLayersContent  
Public variable UProperty Transient bool bEnableEditorLayersTick  
Public variable bool bGrassUpdateEnabled Used to temporarily disable Grass Update in Editor
Public variable UProperty bool bIncludeGridSizeInNameForLandscapeActors If true, LandscapeStreamingProxy actors have the grid size included in their name, for backward compatibility we also check the AWorldSettings::bIncludeGridSizeInNameForPartitionedActors
Public variable UProperty bool bUseGeneratedLandscapeSplineMeshesActors If true, WorldPartitionLandscapeSplineMeshesBuilder is responsible of generating partitioned actors of type ALandscapeSplineMeshesActor that will contain all landscape spline/controlpoints static meshes.
Public variable UProperty Transient duplicatetransient, nonpieduplicatetransient, textexporttransient bool bWarnedGlobalMergeDimensionsExceeded  
Public variable FGuid EditingLayer Current Editing Landscape Layer
Public variable UProperty Transient TArray< TObjectPtr< UTextureRenderTarget2D > > HeightmapRTList  
Public variable UProperty TArray< FLandscapeLayer > LandscapeLayers  
Public variable UProperty FGuid LandscapeSplinesTargetLayerGuid Target Landscape Layer for Landscape Splines
Public variable UProperty Transient duplicatetransient, textexporttransient TArray< TWeakObjectPtr< UTexture2D > > TrackedStreamingInTextures List of textures that are not fully streamed in yet (updated every frame to track textures that have finished streaming in)
Public variable UProperty Transient TArray< TObjectPtr< UTextureRenderTarget2D > > WeightmapRTList  

Constructors

  Type Name Description
Public function  

ALandscape ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function void

AddBrushToLayer ( int32 InLayerIndex,
ALandscapeBlueprintBrushBase* InBrush
)

  
Public function void  
Public function Static void

CalcComponentIndicesNoOverlap ( const int32 X1,
const int32 Y1,
const int32 X2,
const int32 Y2,
const int32 ComponentSizeQuads,
int32& ComponentIndexX1,
int32& ComponentIndexY1,
int32& ComponentIndexX2,
int32& ComponentIndexY2
)

 Exclude Components with overlapped vertices X2/Y2 Coordinates are "inclusive" max values
Public function Static void

CalcComponentIndicesOverlap ( const int32 X1,
const int32 Y1,
const int32 X2,
const int32 Y2,
const int32 ComponentSizeQuads,
int32& ComponentIndexX1,
int32& ComponentIndexY1,
int32& ComponentIndexX2,
int32& ComponentIndexY2
)

 Include Components with overlapped vertices X2/Y2 Coordinates are "inclusive" max values
Public function Virtual Const bool  
Public function Virtual Const bool

CanDeleteSelectedActor ( FText& OutReason
)

  
Public function void

ClearDirtyData ( ULandscapeComponent* InLandscapeComponent
)

  
Public function void

ClearLayer ( const FGuid& InLayerGuid,
TSet< TObjectPtr< ULandscapeComponent > >* InComponents,
ELandscapeClearMode InClearMode,
bool bMarkPackageDirty
)

  
Public function void

ClearLayer ( int32 InLayerIndex,
TSet< TObjectPtr< ULandscapeComponent > >* InComponents,
ELandscapeClearMode InClearMode
)

  
Public function void

ClearPaintLayer ( const FGuid& InLayerGuid,
ULandscapeLayerInfoObject* InLayerInfo
)

  
Public function void

ClearPaintLayer ( int32 InLayerIndex,
ULandscapeLayerInfoObject* InLayerInfo
)

  
Public function void

CollapseLayer ( int32 InLayerIndex
)

  
Public function Const FIntPoint  
Public function bool

ComputeLandscapeLayerBrushInfo ( FTransform& OutLandscapeTransform,
FIntPoint& OutLandscapeSize,
FIntPoint& OutLandscapeRenderTargetSize
)

  
Public function void  
Public function void  
Public function void  
Public function int32

CreateLayer ( FName InName
)

  
Public function void

DeleteLayer ( int32 InLayerIndex
)

  
Public function void  
Public function FLandscapeLayer *  
Public function void

EnableNaniteSkirts ( bool bInEnable,
float InSkirtDepth,
bool bInShouldDirtyPackage
)

  
Public function UFunction BlueprintCallable, Category void  
Public function void

ForceUpdateLayersContent ( bool bIntermediateRender
)

  
Public function void

ForEachLayer ( TFunctionRef< void(struct FLandscapeLayer&)> Fn
)

  
Protected function Const FName

GenerateUniqueLayerName ( FName InName
)

  
Public function Const TArray< class ALandscapeBlueprintBrushBase * >

GetBrushesForLayer ( int32 InLayerIndex
)

  
Public function Const ALandscapeBlueprintBrushBase *

GetBrushForLayer ( int32 InLayerIndex,
int32 BrushIndex
)

  
Public function int32

GetBrushIndexForLayer ( int32 InLayerIndex,
ALandscapeBlueprintBrushBase* InBrush
)

  
Public function Const int32  
Public function Const float

GetClampedLayerAlpha ( float InAlpha,
bool bInHeightmap
)

  
Public function Const FBox Computes & returns bounds containing all landscape proxies (if any) or this landscape's bounds otherwise.
Public function Const const FGuid &  
Public function Const const FLandscapeLayer *  
Public function FLandscapeLayer *  
Public function FLandscapeLayer *

GetLayer ( int32 InLayerIndex
)

  
Public function Const const FLandscapeLayer *

GetLayer ( const FGuid& InLayerGuid
)

  
Public function Const const FLandscapeLayer *

GetLayer ( const FName& InLayerName
)

  
Public function Const const FLandscapeLayer *

GetLayer ( int32 InLayerIndex
)

  
Public function Const float

GetLayerAlpha ( int32 InLayerIndex,
bool bInHeightmap
)

  
Public function Const uint8  
Public function Const int32

GetLayerIndex ( FName InLayerName
)

  
Public function Const FBox Computes & returns bounds containing all currently loaded landscape proxies (if any) or this landscape's bounds otherwise
Public function uint32  
Public function Const UFunction BlueprintCallable, BlueprintPure, Category, Meta TArray< FName >

GetTargetLayerNames ( bool bInIncludeVisibilityLayer
)

 Retrieves the names of valid paint layers on this landscape (editor-only : returns nothing at runtime) @Param bInIncludeVisibilityLayer whether the visibility layer's name should be included in the list or not
Public function Const void

GetUsedPaintLayers ( int32 InLayerIndex,
TArray< ULandscapeLayerInfoObject* >& OutUsedLayerInfos
)

  
Public function Const void

GetUsedPaintLayers ( const FGuid& InLayerGuid,
TArray< ULandscapeLayerInfoObject* >& OutUsedLayerInfos
)

  
Public function Const bool  
Public function Const bool  
Public function bool  
Public function Const bool  
Public function UFunction BlueprintCallable, Category void  
Public function Const bool  
Public function Const bool

IsLayerBlendSubstractive ( int32 InLayerIndex,
const TWeakObjectPtr< ULandscapeLayerInfoObject >& InLayerInfoObj
)

  
Public function Const bool

IsLayerNameUnique ( const FName& InName
)

  
Public function Const bool  
Public function Const bool  
Public function bool

IsValidRenderTargetFormatHeightmap ( EPixelFormat InRenderTargetFormat,
bool& bOutCompressHeight
)

  
Public function bool

IsValidRenderTargetFormatWeightmap ( EPixelFormat InRenderTargetFormat,
int32& OutNumChannels
)

  
Public function void  
Public function FLandscapeBlueprintBrushChangedDelegate &  
Public function FLandscapeFullHeightmapRenderDoneDelegate &  
Public function void  
Public function void  
Public function Virtual void  
Public function Virtual void

PostDuplicate ( bool bDuplicateForPIE
)

  
Public function Virtual void  
Public function Virtual void

PreEditChange ( FProperty* PropertyThatWillChange
)

  
Public function bool

PrepareTextureResources ( bool bInWaitForStreaming
)

  
Public function void  
Public function void  
Public function void  
Public function void

RemoveBrushFromLayer ( int32 InLayerIndex,
int32 InBrushIndex
)

  
Public function void

RemoveBrushFromLayer ( int32 InLayerIndex,
ALandscapeBlueprintBrushBase* InBrush
)

  
Public function UFunction BlueprintCallable, Category bool

RenderHeightmap ( FTransform InWorldTransform,
FBox2D InExtents,
UTextureRenderTarget2D* OutRenderTarget
)

 Render the final heightmap in the requested top-down window as one -atlased- texture in the provided render target 2D Can be called at runtime.
Public function UFunction BlueprintCallable, Category bool

RenderWeightmap ( FTransform InWorldTransform,
FBox2D InExtents,
FName InWeightmapLayerName,
UTextureRenderTarget2D* OutRenderTarget
)

 Render the final weightmap for the requested layer, in the requested top-down window, as one -atlased- texture in the provided render target 2D Can be called at runtime.
Public function UFunction BlueprintCallable, Category bool

RenderWeightmaps ( FTransform InWorldTransform,
FBox2D InExtents,
const TArray< FName >& InWeightmapLayerNames,
UTextureRenderTarget* OutRenderTarget
)

 Render the final weightmaps for the requested layers, in the requested top-down window, as one -atlased- texture in the provided render target (2D or 2DArray) Can be called at runtime.
Public function bool

ReorderLayer ( int32 InStartingLayerIndex,
int32 InDestinationLayerIndex
)

  
Public function bool

ReorderLayerBrush ( int32 InLayerIndex,
int32 InStartingLayerBrushIndex,
int32 InDestinationLayerBrushIndex
)

  
Public function void  
Public function void

RequestLayersContentUpdateForceAll ( ELandscapeLayerUpdateMode InModeMask,
bool bInUserTriggered
)

  
Public function void

RequestLayersInitialization ( bool bInRequestContentUpdate
)

  
Public function void  
Public function void

SetDisableRuntimeGrassMapGeneration ( bool bInDisableRuntimeGrassMapGeneration
)

  
Public function void

SetEditingLayer ( const FGuid& InLayerGuid
)

  
Public function void

SetGrassUpdateEnabled ( bool bInGrassUpdateEnabled
)

  
Public function void

SetLandscapeSplinesReservedLayer ( int32 InLayerIndex
)

  
Public function void

SetLayerAlpha ( int32 InLayerIndex,
const float InAlpha,
bool bInHeightmap
)

  
Public function void

SetLayerLocked ( int32 InLayerIndex,
bool bLocked
)

  
Public function void

SetLayerName ( int32 InLayerIndex,
const FName& InName
)

  
Public function void

SetLayerSubstractiveBlendStatus ( int32 InLayerIndex,
bool InStatus,
const TWeakObjectPtr< ULandscapeLayerInfoObject >& InLayerInfoObj
)

  
Public function void

SetLayerVisibility ( int32 InLayerIndex,
bool bInVisible
)

  
Public function void

SetLODGroupKey ( uint32 InLODGroupKey
)

  
Public function void

SetNanitePositionPrecision ( int32 InPrecision,
bool bInShouldDirtyPackage
)

 Set the target precision on nanite vertex position.
Public function void  
Public function Virtual bool

ShouldImport ( FStringView ActorPropString,
bool IsMovingLevel
)

  
Public function void  
Public function void

ShowOnlySelectedLayer ( int32 InLayerIndex
)

  
Public function Static void

SplitHeightmap ( ULandscapeComponent* Comp,
ALandscapeProxy* TargetProxy,
FMaterialUpdateContext* InOutUpdateContext,
TArray< class FComponentRecreateRenderStateContext >* InOutRecreateRenderStateContext,
bool InReregisterComponent
)

  
Public function void

TickLayers ( float DeltaTime
)

  
Public function void  
Public function void  
Public function void

UpdateLandscapeSplines ( const FGuid& InLayerGuid,
bool bInUpdateOnlySelected,
bool bInForceUpdateAllCompoments
)

  
Public function void  
Public function Const void  

Overridden from ALandscapeProxy

  Type Name Description
Public function Virtual void  
Public function Virtual void Delete all unused layers in components.
Public function Virtual void  
Public function Virtual ALandscape *  
Public function Virtual Const const ALandscape *  
Public function Virtual Const bool Will tell if the landscape proxy as some content related to the layer system
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

  
Public function Virtual void  
Public function Virtual void

PostEditMove ( bool bFinished
)

  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void

UpdateCachedHasLayersContent ( bool bInCheckComponentDataIntegrity
)

  

Classes

  Type Name Description
Public class FLandscapeBlueprintBrushChangedDelegate    
Public class FLandscapeFullHeightmapRenderDoneDelegate    

Constants

Name Description
AffectsLandscapeActorDescProperty  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page