1. Epic GamesDeveloper
  3. ALandscapeProxy

ALandscapeProxy

API > API/Runtime > API/Runtime/Landscape

Inheritance Hierarchy

References

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

Syntax

UCLASS (Abstract, MinimalAPI, NotBlueprintable, NotPlaceable,  
       HideCategories=(Display, Attachment, Physics, Debug, Lighting),  
       ShowCategories=(Lighting, Rendering, Transformation), HideCategories=(Mobility))  
class ALandscapeProxy :  
    public APartitionActor,  
    public ILandscapeSplineInterface

Variables

  Type Name Description
Protected variable TSet< FWorldPartitionReference > ActorDescReferences Hard refs to actors that need to be loaded when this proxy is loaded.
Public variable TArray< FAsyncTask< FAsyncGrassTask > * > AsyncFoliageTasks A transient data structure for tracking the grass tasks
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadOnly uint8: 1 bAffectDistanceFieldLighting Controls whether the primitive should affect dynamic distance field lighting methods.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta uint32: 1 bBakeMaterialPositionOffsetIntoCollision Whether to bake the landscape material's vertical world position offset into the collision heightfield.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadOnly uint8: 1 bCastContactShadow Whether the object should cast contact shadows. This flag is only used if CastShadow is true.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadOnly uint8: 1 bCastDynamicShadow Controls whether the primitive should cast shadows in the case of non precomputed shadowing.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadOnly uint32: 1 bCastFarShadow When enabled, the component will be rendering into the far shadow cascades(only for directional lights).
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadOnly uint8: 1 bCastHiddenShadow If true, the primitive will cast shadows even if bHidden is true.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadOnly uint32: 1 bCastShadowAsTwoSided Whether this primitive should cast dynamic shadows as if it were a two sided material.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadOnly uint8: 1 bCastStaticShadow Whether the object should cast a static shadow from shadow casting lights.
Protected variable UProperty Meta bool bDisableRuntimeGrassMapGeneration Disable runtime grass data generation.
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly bool bEnableNanite Use Nanite to render landscape as a mesh on supported platforms.
Public variable UProperty Category, EditAnywhere, Meta uint32: 1 bFillCollisionUnderLandscapeForNavmesh Set to true to prevent navmesh generation under the terrain geometry
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly uint32: 1 bGenerateOverlapEvents If true, Landscape will generate overlap events when other components are overlapping it (eg Begin Overlap).
Public variable UProperty bool bHasLayersContent Flag that tell if we have some layers content
Public variable UProperty Transient bool bIsPerformingInteractiveActionOnLandscapeMaterialOverride  
Public variable bool bIsRegisteredWithLandscapeInfo True when this Proxy is registered with the LandscapeInfo
Protected variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta bool bNaniteSkirtEnabled  
Public variable bool bNeedsWeightmapUsagesUpdate Set to true when on undo, when it's necessary to completely regenerate weightmap usages (since some weightmap allocations are transactional and others not, e.g. splines edit layer)
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly FBodyInstance BodyInstance Collision profile settings for this landscape
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadOnly uint32: 1 bRenderCustomDepth If true, the Landscape will be rendered in the CustomDepth pass (usually used for outlines)
Public variable UProperty Category Transient visibleanywhere bool bSetCreateRuntimeVirtualTextureVolumes Placeholder for details customization button.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta bool bStripGrassWhenCookedClient Strip Grass data when cooked for client
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta bool bStripGrassWhenCookedServer Strip Grass data when cooked for server
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta bool bStripPhysicsWhenCookedClient Strip Physics/collision components when cooked for client
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta bool bStripPhysicsWhenCookedServer Strip Physics/collision components when cooked for server
Public variable bool bTemporarilyDisableWeightmapUsagesValidation Set to true when we know that weightmap usages are being reconstructed and might be temporarily invalid as a result (ValidateProxyLayersWeightmapUsage should be called after setting this back to false)
Protected variable bool bUpgradeSharedPropertiesPerformed Used to know if the deprecation of shared properties modified before the enforcement system introduction has been performed on load.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta bool bUseCompressedHeightmapStorage Enable compressed heightmap texture storage.
Public variable UProperty Category, EditAnywhere, Meta uint32: 1 bUsedForNavigation Hints navigation system whether this landscape will ever be navigated on.
Public variable UProperty Category, EditAnywhere, Meta bool bUseDynamicMaterialInstance When set to true it will generate MaterialInstanceDynamic for each components, so material can be changed at runtime
Public variable UProperty Category, EditAnywhere, Meta bool bUseLandscapeForCullingInvisibleHLODVertices Flag whether or not this Landscape's surface can be used for culling hidden triangles
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta uint32: 1 bUseMaterialPositionOffsetInStaticLighting Whether to use the landscape material's vertical world position offset when calculating static lighting.
Public variable UProperty Category, EditAnywhere, Meta bool bUseScalableLODSettings Allows to specify LOD distribution settings per quality level.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadOnly bool bVirtualTextureRenderWithQuad Use a single quad to render this landscape to runtime virtual texture pages.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadOnly bool bVirtualTextureRenderWithQuadHQ Use highest quality heightmap interpolation when using a single quad to render this landscape to runtime virtual texture pages.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly uint8: 1 CastShadow Controls whether the primitive component should cast a shadow or not.
Public variable UProperty TArray< TObjectPtr< ULandscapeHeightfieldCollisionComponent > > CollisionComponents Array of LandscapeHeightfieldCollisionComponent
Public variable UProperty Category, EditAnywhere, Meta int32 CollisionMipLevel Landscape LOD to use for collision tests. Higher numbers use less memory and process faster, but are much less accurate.
Public variable TArray< ULandscapeComponent * > Components  
Public variable UProperty float ComponentScreenSizeToUseSubSections  
Public variable UProperty Meta int32 ComponentSizeQuads Data set at creation time
Public variable uint32 CurrentVersion CurrentVersion is bumped whenever a landscape component has an undo/redo operation applied.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadOnly int32 CustomDepthStencilValue Optionally write this 0-255 value to the stencil buffer in CustomDepth pass (Requires project setting or r.CustomDepth == 3)
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadOnly ERendererStencilMask CustomDepthStencilWriteMask Mask used for stencil buffer writes.
Public variable UProperty Category, EditAnywhere, Meta TObjectPtr< UPhysicalMaterial > DefaultPhysMaterial Default physical material, used when no per-layer values physical materials
Public variable UProperty TArray< FLandscapeEditorLayerSettings > EditorLayerSettings  
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta int32 ExportLOD LOD level to use when exporting the landscape to obj or FBX
Public variable FDelegateHandle FeatureLevelChangedDelegateHandle Handle so we can unregister the delegate
Public variable FCachedLandscapeFoliage FoliageCache A transient data structure for tracking the grass
Public variable UProperty Transient duplicatetransient TArray< TObjectPtr< UHierarchicalInstancedStaticMeshComponent > > FoliageComponents  
Public variable uint32 FrameOffsetForTickInterval Frame offset for tick interval
Public variable UProperty float GrassTypesMaxDiscardDistance Only used outside of the editor (e.g. in cooked builds) - this value is no longer authoritative TODO [chris.tchou] remove Cached grass max discard distance for all grass types in all landscape components with landscape grass configured
Public variable FGrassTypeSummary GrassTypeSummary  
Public variable TMap< UTexture2D *, FLandscapeEditLayerReadback * > HeightmapsCPUReadback  
Public variable UProperty Category, EditAnywhere, Meta int32 HLODMeshSourceLOD Specify which LOD to use for the HLOD mesh if HLODMeshSourceLODPolicy is set to SpecificLOD
Public variable UProperty Category, EditAnywhere, Meta ELandscapeHLODMeshSourceLODPolicy HLODMeshSourceLODPolicy Specify how to choose the LOD used as input for the HLOD mesh
Public variable UProperty Category, EditAnywhere, Meta int32 HLODTextureSize Specify the texture size to use for the HLOD mesh if HLODTextureSizePolicy is set to SpecificSize
Public variable UProperty Category, EditAnywhere, Meta ELandscapeHLODTextureSizePolicy HLODTextureSizePolicy Specify how to choose the texture size of the resulting HLOD mesh
Public variable UProperty TArray< TObjectPtr< ULandscapeComponent > > LandscapeComponents The array of LandscapeComponent that are used by the landscape
Protected variable UProperty Meta FGuid LandscapeGuid Guid for LandscapeEditorInfo, all proxies that belong to the same landscape should have the same LandscapeGuid, even if split across world partitions Note that this value may change when the landscape is instanced (or in PIE) in order to allow multiple instances of the same landscape to exist.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta TObjectPtr< UMaterialInterface > LandscapeHoleMaterial Material used to render landscape components with holes.
Public variable UProperty Category, EditAnywhere, Meta blueprintsetter TObjectPtr< UMaterialInterface > LandscapeMaterial Combined material used to render the landscape
Protected variable FLandscapeMaterialChangedDelegate LandscapeMaterialChangedDelegate  
Public variable UProperty FIntPoint LandscapeSectionOffset Offset in quads from global components grid origin (in quads)
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadOnly float LDMaxDrawDistance Max draw distance exposed to LDs.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadOnly FLightingChannels LightingChannels Channels that this Landscape should be in.
Public variable UProperty Category, EditAnywhere, Meta FLightmassPrimitiveSettings LightmassSettings The Lightmass settings for this object.
Public variable UProperty Category, EditAnywhere, Meta float LOD0DistributionSetting The distribution setting used to change the LOD 0 generation, 1.25 is the normal distribution, numbers influence directly the LOD0 proportion on screen.
Public variable UProperty Category, EditAnywhere, Meta float LOD0ScreenSize This is the starting screen size used to calculate the distribution.
Public variable UProperty Category, EditAnywhere, Meta float LODBlendRange This controls the area that blends LOD between neighboring sections.
Public variable UProperty Category, EditAnywhere, Meta float LODDistributionSetting The distribution setting used to change the LOD generation, 3 is the normal distribution, small number mean you want your last LODs to take more screen space and big number mean you want your first LODs to take more screen space.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta uint32 LODGroupKey Specifies the LOD Group (Zero is No Group).
Public variable TMap< FString, TObjectPtr< UMaterialInstanceConstant > > MaterialInstanceConstantMap Map of material instance constants used to for the components.
Public variable UProperty Category, EditAnywhere, Meta int32 MaxLODLevel Max LOD level to use when rendering, -1 means the max available
Public variable UProperty Category, EditAnywhere, Meta int32 MaxPaintedLayersPerComponent  
Public variable UProperty nonpieduplicatetransient, nontransactional, textexporttransient TArray< TObjectPtr< ULandscapeNaniteComponent > > NaniteComponents  
Protected variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta int32 NaniteLODIndex LOD level of the landscape when generating the Nanite mesh.
Protected variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta float NaniteMaxEdgeLengthFactor  
Protected variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta int32 NanitePositionPrecision  
Protected variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta float NaniteSkirtDepth  
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta ENavDataGatheringMode NavigationGeometryGatheringMode  
Public variable UProperty Category, EditAnywhere, Meta float NegativeZBoundsExtension Allows overriding the landscape bounds.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta float NonNaniteVirtualShadowMapConstantDepthBias Constant bias to handle the worst artifacts of the continuous LOD morphing when rendering to VSM.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta float NonNaniteVirtualShadowMapInvalidationHeightErrorThreshold For non-Nanite landscape, cached VSM pages need to be invalidated when continuous LOD morphing introduces a height difference that is too large between the current landscape component's profile and the one that was used when the shadow was shadow was last cached.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta float NonNaniteVirtualShadowMapInvalidationScreenSizeLimit Screen size under which VSM invalidation stops occurring.
Public variable int32 NumComponentsNeedingTextureBaking  
Public variable UProperty Meta int32 NumSubsections  
Public variable FOnLandscapeProxyComponentDataChanged OnComponentDataChanged  
Protected variable FGuid OriginalLandscapeGuid The original unmutated LandscapeGuid on the source asset, before instancing modfications.
Protected variable UProperty Category, EditAnywhere, Meta TArray< FLandscapePerLODMaterialOverride > PerLODOverrideMaterials  
Public variable UProperty Category, EditAnywhere, Meta float PositiveZBoundsExtension Allows overriding the landscape bounds.
Public variable UProperty Transient TObjectPtr< UMaterialInterface > PreEditLandscapeHoleMaterial  
Public variable UProperty Transient PRAGMA_ENABLE_DEPRECATION_WARNINGS TObjectPtr< UMaterialInterface > PreEditLandscapeMaterial  
Protected variable UProperty Transient TArray< FLandscapePerLODMaterialOverride > PreEditPerLODOverrideMaterials  
Public variable UProperty FGuid ReimportDestinationLayerGuid Height and weightmap import destination layer guid
Public variable UProperty FString ReimportHeightmapFilePath  
Public variable FRenderCommandFence ReleaseResourceFence  
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite TArray< TObjectPtr< URuntimeVirtualTexture > > RuntimeVirtualTextures Array of runtime virtual textures into which we draw this landscape.
Public variable UProperty Category, EditAnywhere, Meta FPerQualityLevelFloat ScalableLOD0DistributionSetting Scalable (per-quality) version of 'LOD 0'.
Public variable UProperty Category, EditAnywhere, Meta FPerQualityLevelFloat ScalableLOD0ScreenSize Scalable (per-quality) version of 'LOD 0 Screen Size'.
Public variable UProperty Category, EditAnywhere, Meta FPerQualityLevelFloat ScalableLODDistributionSetting Scalable (per-quality) version of 'Other LODs'.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadOnly EShadowCacheInvalidationBehavior ShadowCacheInvalidationBehavior Control shadow invalidation behavior, in particular with respect to Virtual Shadow Maps and material effects like World Position Offset.
Public variable UProperty Category, EditAnywhere, Meta int32 SimpleCollisionMipLevel If set higher than the "Collision Mip Level", this specifies the Landscape LOD to use for "simple collision" tests, otherwise the "Collision Mip Level" is used for both simple and complex collision.
Protected variable UProperty TObjectPtr< ULandscapeSplinesComponent > SplineComponent  
Public variable UProperty Category, EditAnywhere, Meta int32 StaticLightingLOD LOD level to use when running lightmass (increase to 1 or 2 for large landscapes to stop lightmass crashing)
Public variable UProperty Category, EditAnywhere, Meta float StaticLightingResolution The resolution to cache lighting at, in texels/quad in one axis Total resolution would be changed by StaticLightingResolution*StaticLightingResolution Automatically calculate proper value for removing seams
Public variable UProperty Category, EditAnywhere, Meta float StreamingDistanceMultiplier Allows artists to adjust the distance where textures using UV 0 are streamed in/out.
Public variable UProperty Meta int32 SubsectionSizeQuads  
Public variable UProperty Meta nontransactional ELandscapeLayerDisplayMode TargetDisplayOrder Display Order mode for the targets
Public variable UProperty Meta nontransactional TArray< FName > TargetDisplayOrderList Display Order of the targets
Public variable int32 UpdateBakedTexturesCountdown  
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadOnly int32 VirtualTextureLodBias Bias to the LOD selected for rendering to runtime virtual textures.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadOnly int32 VirtualTextureNumLods Number of mesh levels to use when rendering landscape into runtime virtual texture.
Public variable UProperty Category, EditAnywhere, Meta blueprintsetter ERuntimeVirtualTextureMainPassType VirtualTextureRenderPassType Controls if this component draws in the main pass as well as in the virtual texture.
Public variable uint32 WeightmapFixupVersion  
Public variable TMap< UTexture2D *, FLandscapeEditLayerReadback * > WeightmapsCPUReadback  
Public variable UProperty Transient nontransactional TMap< TObjectPtr< UTexture2D >, TObjectPtr< ULandscapeWeightmapUsage > > WeightmapUsageMap Map of weightmap usage

Constructors

  Type Name Description
Public function  

ALandscapeProxy ( const FObjectInitializer& ObjectInitializer
)

  

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function Static void

AddExclusionBox ( FWeakObjectPtr Owner,
const FBox& BoxToRemove
)

 TODO [jonathan.bard] : Rename to "AddGrassExclusionBox" + no reason for any of this to be static.
Protected function bool

AddLayer ( const FGuid& InLayerGuid
)

 Add Layer if it doesn't exist yet.
Public function Static void

AddReferencedObjects ( UObject* InThis,
FReferenceCollector& Collector
)

  
Public function Const bool

AreNaniteComponentsValid ( const FGuid& InProxyContentId
)

  
Public function Const bool  
Public function Virtual void  
Public function void

BuildGIBakedTextures ( FScopedSlowTask* InSlowTask
)

  
Public function void

BuildGrassMaps ( FScopedSlowTask* InSlowTask
)

  
Public function void

BuildPhysicalMaterial ( FScopedSlowTask* InSlowTask
)

  
Public function Virtual Const bool

CanEditChange ( const FProperty* InProperty
)

  
Public function Const bool Will tell if the landscape proxy can have some content related to the layer system
Public function Virtual UFunction BlueprintCallable, Category, Meta void

ChangeComponentScreenSizeToUseSubSections ( float InComponentScreenSizeToUseSubSections
)

 Change ComponentScreenSizeToUseSubSections value on the render proxy.
Public function void Changed Physical Material.
Public function Virtual UFunction BlueprintCallable, Category, Meta void

ChangeLODDistanceFactor ( float InLODDistanceFactor
)

 Change the Level of Detail distance factor
Public function void

CheckGenerateMobilePlatformData ( bool bIsCooking,
const ITargetPlatform* TargetPlatform
)

  
Public function void  
Public function Static uint32

ComputeLandscapeKey ( const UWorld* World,
uint32 InLODGroupKey,
FGuid InLandscapeGuid
)

  
Public function Const uint32 Computes the rendering key for this landscape proxy
Public function void Copy properties from parent Landscape actor.
Public function Virtual Const TUniquePtr< class FWorldPartitionActorDesc >  
Public function ULandscapeInfo *

CreateLandscapeInfo ( bool bMapCheck,
bool bUpdateAllAddCollisions
)

 Creates the LandscapeInfo if necessary, then registers this proxy with it
Public function Const UTexture2D *

CreateLandscapeTexture ( int32 InSizeX,
int32 InSizeY,
TextureGroup InLODGroup,
ETextureSourceFormat InFormat,
UObject* OptionalOverrideOuter,
bool bCompress,
bool bMipChain
)

 Creates a Texture2D for use by this landscape proxy or one of it's components.
Public function UTexture2DArray *

CreateLandscapeTextureArray ( int32 InSizeX,
int32 InSizeY,
int32 Slices,
TextureGroup InLODGroup,
ETextureSourceFormat InFormat,
UObject* OptionalOverrideOuter
)

 Creates a Texture2DArray for use by this landscape proxy or one of it's components.
Public function Const UTexture2D *

CreateLandscapeToolTexture ( int32 InSizeX,
int32 InSizeY,
TextureGroup InLODGroup,
ETextureSourceFormat InFormat
)

 Creates a Texture2D for use by this landscape proxy or one of it's components for tools .
Public function ULandscapeLayerInfoObject *

CreateLayerInfo ( const TCHAR* InLayerName,
const ULandscapeLayerInfoObject* InTemplate
)

  
Public function Static ULandscapeLayerInfoObject *

CreateLayerInfo ( const TCHAR* InLayerName,
const ULevel* InLevel,
const ULandscapeLayerInfoObject* InTemplate
)

 Creates a new LandscapeLayerInfoObject
Public function Virtual void  
Public function Virtual void

CreateSplineComponent ( const FVector& Scale3D
)

  
Public function ULandscapeWeightmapUsage * Creates a LandscapeWeightMapUsage object outered to this proxy.
Public function Static void

DebugDrawExclusionBoxes ( const UWorld* World
)

  
Protected function void

DeleteLayer ( const FGuid& InLayerGuid
)

 Delete Layer.
Public function Virtual UFunction BlueprintCallable, Category void Delete all unused layers in components.
Public function Virtual void  
Public function Virtual void

EditorApplyMirror ( const FVector& MirrorScale,
const FVector& PivotLocation
)

  
Public function Virtual void

EditorApplyScale ( const FVector& DeltaScale,
const FVector* PivotLocation,
bool bAltDown,
bool bShiftDown,
bool bCtrlDown
)

  
Public function UFunction BlueprintCallable, Category void

EditorApplySpline ( USplineComponent* InSplineComponent,
float StartWidth,
float EndWidth,
float StartSideFalloff,
float EndSideFalloff,
float StartRoll,
float EndRoll,
int32 NumSubdivisions,
bool bRaiseHeights,
bool bLowerHeights,
ULandscapeLayerInfoObject* PaintLayer,
FName EditLayerName
)

 Deform landscape using a given spline
Public function Virtual Const bool

EditorCanAttachTo ( const AActor* InParent,
FText& OutReason
)

  
Public function UFunction blueprintsetter void

EditorSetLandscapeMaterial ( UMaterialInterface* NewLandscapeMaterial
)

 Setter for LandscapeMaterial. Has no effect outside the editor.
Public function void

EnableNaniteComponents ( bool bInNaniteActive
)

  
Public function Const bool

ExportToRawMesh ( const FRawMeshExportParams& InExportParams,
FMeshDescription& OutRawMesh
)

 Exports landscape geometry into a raw mesh according to the export params
Public function Const bool

ExportToRawMeshDataCopy ( const FRawMeshExportParams& InExportParams,
FMeshDescription& OutRawMesh,
const UE::Landscape::Nanite::FAsyncBuildData& AsyncData
)

  
Public function Virtual void  
Protected function Virtual void Fixup any internal representation for shared properties.
Public function void

FixupSharedData ( ALandscape* Landscape,
bool bMapCheck
)

 Assign only mismatching data and mark proxy package dirty.
Public function void Fix up component layers, weightmaps
Public function void

FlushGrassComponents ( const TSet< ULandscapeComponent* >* OnlyForComponents,
bool bFlushGrassMaps
)

 Flush the grass cache, removing grass instances on the given components (or all proxy components if the component set is not specified).
Public function FAsyncWorkMonitor &  
Public function Const FIntRect  
Public function Virtual Const uint32

GetDefaultGridSize ( UWorld* InWorld
)

  
Public function bool  
Public function Virtual Const FGuid  
Public function Const TOptional< float >

GetHeightAtLocation ( FVector Location,
EHeightfieldSource HeightFieldSource
)

  
Public function Const void

GetHeightValues ( int32& SizeX,
int32& SizeY,
TArray< float >& ArrayValue
)

 Fills an array with height values
Public function Virtual Const UFunction BlueprintCallable, Category const ALandscape *  
Public function Virtual UFunction BlueprintCallable, Category ALandscape *  
Public function Virtual Const UMaterialInterface * Get Hole Landscape Material assigned to this Landscape.
Public function Virtual Const UMaterialInterface *

GetLandscapeMaterial ( int8 InLODIndex
)

 Get Landscape Material assigned to this Landscape.
Public function Static const TArray< ALandscapeProxy * > &  
Public function Const const TArray< FName > &  
Public function Static const TArray< FName > &

GetLayersFromMaterial ( UMaterialInterface* Material
)

  
Public function Static ULandscapeMaterialInstanceConstant *

GetLayerThumbnailMIC ( UMaterialInterface* LandscapeMaterial,
FName LayerName,
UTexture2D* ThumbnailWeightmap,
UTexture2D* ThumbnailHeightmap,
ALandscapeProxy* Proxy
)

 Create a thumbnail material for a given layer
Public function Const TArray< float > Retrieve the screen size at which each LOD should be rendered.
Public function Const FGuid  
Public function Const FGuid  
Public function Virtual Const int32  
Public function Virtual Const float  
Public function Virtual Const int32  
Public function Const TSet< FPrimitiveComponentId >  
Public function Virtual Const float  
Public function Const const FGuid & Return the original landscape guid, before it was modified by instancing.
Public function Const int32  
Public function Virtual Const UE::Landscape::EOutdatedDataFlags  
Public function Const int32  
Public function Const int32  
Public function Const const TArray< FLandscapePerLODMaterialOverride > &  
Public function Const UPhysicalMaterial *

GetPhysicalMaterialAtLocation ( FVector Location,
EHeightfieldSource HeightFieldSOurce
)

  
Public function Virtual Const bool

GetReferencedContentObjects ( TArray< UObject* >& Objects
)

  
Public function Const FIntPoint Get landscape position in section space
Public function void Copy properties from parent Landscape actor
Public function Virtual Const bool Will tell if the landscape proxy as some content related to the layer system
Public function Const bool  
Public function void

Import ( const FGuid& InGuid,
int32 InMinX,
int32 InMinY,
int32 InMaxX,
int32 InMaxY,
int32 InNumSubsections,
int32 InSubsectionSizeQuads,
const TMap< FGuid, TArray< uint16 > >& InImportHeightData,
const TCHAR*const InHeightmapFileName,
const TMap< FGuid, TArray< FLandscapeImportLayerInfo > >& InImportMaterialLayerInfos,
ELandscapeImportAlphamapType InImportMaterialLayerType,
const TArray< struct FLandscapeLayer >* InImportLayers
)

 Import the given Height/Weight data into this landscape
Protected function void

InitializeLayerWithEmptyContent ( const FGuid& InLayerGuid
)

 Initialize Layer with empty content if it hasn't been initialized yet.
Public function void  
Public function void

InvalidateGeneratedComponentData ( bool bInvalidateLightingCache
)

 Invalidate the precomputed grass and baked texture data on all components
Public function Static void

InvalidateGeneratedComponentData ( const TArray< ULandscapeComponent* >& Components,
bool bInvalidateLightingCache
)

  
Public function Static void

InvalidateGeneratedComponentData ( const TSet< ULandscapeComponent* >& Components,
bool bInvalidateLightingCache
)

 Invalidate the precomputed grass and baked texture data for the specified components
Public function void  
Public function void

InvalidateNaniteRepresentation ( bool bInCheckContentId
)

 Invalidate and disable Nanite representation until a subsequent rebuild occurs
Public function void

InvalidateOrUpdateNaniteRepresentation ( bool bInCheckContentId,
const ITargetPlatform* InTargetPlatform
)

 Invalidate Nanite representation or rebuild it in case live update is active :
Public function void  
Public function bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Const bool Returns true if the Nanite representation is missing or outdated
Public function Virtual Const bool  
Public function Const bool

IsPropertyInherited ( const FProperty* InProperty
)

 Returns true if the property is inherited.
Public function Const bool

IsPropertyOverridable ( const FProperty* InProperty
)

 Returns true if the property is overridable.
Public function Virtual bool  
Public function Const bool

IsSharedProperty ( const FName& InPropertyName
)

 Returns true if the property is shared.
Public function Const bool

IsSharedProperty ( const FProperty* InProperty
)

 Returns true if the property is shared.
Public function Virtual Const bool

IsSharedPropertyOverridden ( const FName& InPropertyName
)

 Returns true if the shared property is overridden by the object.
Public function UFunction BlueprintCallable, Category, Meta bool

LandscapeExportHeightmapToRenderTarget ( UTextureRenderTarget2D* InRenderTarget,
bool InExportHeightIntoRGChannel,
bool InExportLandscapeProxies
)

 Output a landscape heightmap to a render target
Public function UFunction BlueprintCallable, Category, Meta bool

LandscapeExportWeightmapToRenderTarget ( UTextureRenderTarget2D* InRenderTarget,
FName InLayerName
)

 Output a landscape weightmap to a render target Only works in the editor
Public function UFunction BlueprintCallable, Category, Meta bool

LandscapeImportHeightmapFromRenderTarget ( UTextureRenderTarget2D* InRenderTarget,
bool InImportHeightFromRGChannel
)

 Overwrites a landscape heightmap with render target data
Public function UFunction BlueprintCallable, Category, Meta bool

LandscapeImportWeightmapFromRenderTarget ( UTextureRenderTarget2D* InRenderTarget,
FName InLayerName
)

 Overwrites a landscape weightmap with render target data Only works in the editor
Public function Const TSharedRef< UE::Landscape::Nanite::FAsyncBuildData >

MakeAsyncNaniteBuildData ( int32 InLODToExport,
const TArrayView< ULandscapeComponent* >& ComponentsToExport
)

  
Public function Const int32  
Public function void

OnFeatureLevelChanged ( ERHIFeatureLevel::Type NewFeatureLevel
)

 Editor notification when changing feature level
Public function FLandscapeMaterialChangedDelegate &  
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

PreSave ( FObjectPreSaveContext ObjectSaveContext
)

  
Public function void

ProcessAsyncGrassInstanceTasks ( bool bWaitAsyncTasks,
bool bForceSync,
const TSet< UHierarchicalInstancedStaticMeshComponent* >& StillUsed
)

  
Public function void Recreate all collision components based on render component
Public function void

RecreateComponentsRenderState ( TFunctionRef< void(ULandscapeComponent*)> Fn
)

 Recreate all component rendering states after applying a given function to each
Public function void Recreate all components rendering and collision states
Public function Static void Unregisters all existing exclusion boxes.
Public function Static void

RemoveExclusionBox ( FWeakObjectPtr Owner
)

 Unregisters a previously-registered exclusion box.
Public function Static void  
Public function void Remove Invalid weightmaps.
Public function void  
Protected function bool

RemoveObsoleteLayers ( const TSet< FGuid >& InExistingLayers
)

 Remove Layers not found in InExistingLayers
Public function void Remove an overlapping component. Called from MapCheck.
Public function void Remove all XYOffset values
Public function void

RenderGrassMaps ( const TArray< ULandscapeComponent* >& InLandscapeComponents,
const TArray< ULandscapeGrassType* >& InGrassTypes
)

 Render grass maps for the specified components
Public function void Repair invalid texture data that might have been introduced by a faulty version :
Public function void  
Public function Virtual void  
Public function Static TArray< FLinearColor >

SampleRTData ( UTextureRenderTarget2D* InRenderTarget,
FLinearColor InRect
)

 Samples an array of values from a Texture Render Target 2D. Only works in the editor
Public function Virtual void

Serialize ( FArchive& Ar
)

  
Public function void

SerializeStateHashes ( FArchive& Ar
)

 Serialize all hashes/guids that record the current state of this proxy
Public function void

SetAbsoluteSectionBase ( FIntPoint SectionOffset
)

 Set landscape absolute location in section space
Public function Static void

SetGrassUpdateInterval ( int32 Interval
)

  
Public function void

SetLandscapeGuid ( const FGuid& Guid,
bool bValidateGuid
)

  
Public function UFunction BlueprintCallable, Category, Meta void

SetLandscapeMaterialScalarParameterValue ( FName ParameterName,
float Value
)

 Set a MID scalar (float) parameter value for all landscape components.
Public function UFunction BlueprintCallable, Category void

SetLandscapeMaterialTextureParameterValue ( FName ParameterName,
UTexture* Value
)

 Set an MID texture parameter value for all landscape components.
Public function UFunction BlueprintCallable, Category, Meta void

SetLandscapeMaterialVectorParameterValue ( FName ParameterName,
FLinearColor Value
)

 Set an MID vector parameter value for all landscape components.
Public function void

SetLODGroupKeyInternal ( uint32 InLODGroupKey
)

  
Public function void  
Public function Virtual void

SetSharedPropertyOverride ( const FName& InPropertyName,
const bool bIsOverriden
)

 Modifies the override state of the property given as argument.
Public function void  
Public function UFunction blueprintsetter void

SetVirtualTextureRenderPassType ( ERuntimeVirtualTextureMainPassType InType
)

  
Public function Const bool Determine whether we should update dynamic grass instances this update tick
Public function Virtual Const bool  
Public function TArray< FName > Enforce property sharing and requirements related to the parent Landscape actor
Protected function Virtual TArray< FName > Synchronizes all shared properties that cannot be marked by regular meta tags.
Public function void

TickGrass ( const TArray< FVector >& Cameras,
int32& InOutNumCompsCreated
)

  
Public function Virtual void

UnregisterAllComponents ( bool bForReregister
)

  
Public function void

UpdateAllComponentMaterialInstances ( FMaterialUpdateContext& InOutMaterialContext,
TArray< class FComponentRecreateRenderStateContext >& InOutRecreateRenderStateContext,
bool bInInvalidateCombinationMaterials
)

  
Public function void

UpdateAllComponentMaterialInstances ( bool bInInvalidateCombinationMaterials
)

 Update the material instances for all the landscape components
Public function Virtual void

UpdateCachedHasLayersContent ( bool InCheckComponentDataIntegrity
)

  
Public function void

UpdateGrass ( const TArray< FVector >& Cameras,
int32& InOutNumComponentsCreated,
bool bForceSync
)

 Update Grass Builds grass instances given the camera locations
Public function void

UpdateGrass ( const TArray< FVector >& Cameras,
bool bForceSync
)

  
Public function void  
Public function void Ensure the Update the Materials on the Nanite Static Meshes from the source ULandscapeComponent
Public function void

UpdateNaniteRepresentation ( const ITargetPlatform* InTargetPlatform
)

 Update Nanite representation if it's missing or outdated
Public function FGraphEventRef

UpdateNaniteRepresentationAsync ( const ITargetPlatform* InTargetPlatform
)

 Update Nanite representation if it's missing or outdated Async
Public function void  
Public function void

UpdatePhysicalMaterialTasks ( bool bInShouldMarkDirty
)

 Update the landscape physical material render tasks
Public function Const void

UpdatePhysicalMaterialTasksStatus ( TSet< ULandscapeComponent* >* OutdatedComponents,
int32* OutdatedComponentsCount
)

  
Public function void  
Public function void  
Public function Virtual void

UpdateSharedProperties ( ULandscapeInfo* InLandscapeInfo
)

  
Public function void

UpgradeSharedProperties ( ALandscape* InParentLandscape
)

 Converts shared properties overridden before explicit override, asking the user how to proceed.
Public function Const void  

Overridden from ILandscapeSplineInterface

  Type Name Description
Public function Virtual Const FGuid Return the landscape guid, used to identify landscape proxies (and splines) that belong to the same landscape, even across world partitions.
Public function Virtual Const ULandscapeInfo *  
Public function Virtual Const ULandscapeSplinesComponent *  
Public function Virtual Const FTransform Get the LandcapeActor-to-world transform with respect to landscape section offset

Classes

  Type Name Description
Public struct FGrassTypeSummary Non-serialized runtime cache of values derived from the assigned grass types.  
Public class FLandscapeMaterialChangedDelegate    
Public struct FRawMeshExportParams    

Constants

Name Description
GrassUpdateInterval  
LandscapeInheritedTag  
LandscapeOverridableTag  
LandscapeProxies Maintain list of Proxies for faster iteration
NaniteComponentMaxSide  
NaniteMaxComponents  
VisibilityLayer  

Deprecated Variables

  Type Name Description
Public variable UProperty TArray< TObjectPtr< ULandscapeLayerInfoObject > > EditorCachedLayerInfos_DEPRECATED  
Public variable UProperty PRAGMA_DISABLE_DEPRECATION_WARNINGS TArray< FLandscapeProxyMaterialOverride > LandscapeMaterialsOverride_DEPRECATED  
Public variable UProperty float LODDistanceFactor_DEPRECATED  
Public variable UProperty TEnumAsByte< ELandscapeLODFalloff::Type > LODFalloff_DEPRECATED  
Public variable UProperty TObjectPtr< ULandscapeNaniteComponent > NaniteComponent_DEPRECATED  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page