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

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 uint8: 1 bAffectDistanceFieldLighting Controls whether the primitive should affect dynamic distance field lighting methods.
Public variable uint32: 1 bBakeMaterialPositionOffsetIntoCollision Whether to bake the landscape material's vertical world position offset into the collision heightfield.
Public variable uint8: 1 bCastContactShadow Whether the object should cast contact shadows. This flag is only used if CastShadow is true.
Public variable uint8: 1 bCastDynamicShadow Controls whether the primitive should cast shadows in the case of non precomputed shadowing.
Public variable uint32: 1 bCastFarShadow When enabled, the component will be rendering into the far shadow cascades(only for directional lights).
Public variable uint8: 1 bCastHiddenShadow If true, the primitive will cast shadows even if bHidden is true.
Public variable uint32: 1 bCastShadowAsTwoSided Whether this primitive should cast dynamic shadows as if it were a two sided material.
Public variable uint8: 1 bCastStaticShadow Whether the object should cast a static shadow from shadow casting lights.
Protected variable bool bEnableNanite Use Nanite to render landscape as a mesh on supported platforms.
Public variable uint32: 1 bFillCollisionUnderLandscapeForNavmesh Set to true to prevent navmesh generation under the terrain geometry
Public variable uint32: 1 bGenerateOverlapEvents If true, Landscape will generate overlap events when other components are overlapping it (eg Begin Overlap).
Public variable bool bHasLandscapeGrass Only used outside of the editor (e.g. in cooked builds) Disables landscape grass processing entirely if no landscape components have landscape grass configured
Public variable bool bHasLayersContent Flag that tell if we have some layers content
Public variable bool bIsPerformingInteractiveActionOnLandscapeMaterialOverride  
Public variable bool bIsRegisteredWithLandscapeInfo True when this Proxy is registered with the LandscapeInfo
Protected variable 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 FBodyInstance BodyInstance Collision profile settings for this landscape
Public variable uint32: 1 bRenderCustomDepth If true, the Landscape will be rendered in the CustomDepth pass (usually used for outlines)
Public variable bool bSetCreateRuntimeVirtualTextureVolumes Placeholder for details customization button.
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 bool bUseCompressedHeightmapStorage Enable compressed heightmap texture storage.
Public variable uint32: 1 bUsedForNavigation Hints navigation system whether this landscape will ever be navigated on.
Public variable bool bUseDynamicMaterialInstance When set to true it will generate MaterialInstanceDynamic for each components, so material can be changed at runtime
Public variable bool bUseLandscapeForCullingInvisibleHLODVertices Flag whether or not this Landscape's surface can be used for culling hidden triangles
Public variable uint32: 1 bUseMaterialPositionOffsetInStaticLighting Whether to use the landscape material's vertical world position offset when calculating static lighting.
Public variable bool bVirtualTextureRenderWithQuad Use a single quad to render this landscape to runtime virtual texture pages.
Public variable bool bVirtualTextureRenderWithQuadHQ Use highest quality heightmap interpolation when using a single quad to render this landscape to runtime virtual texture pages.
Public variable uint8: 1 CastShadow Controls whether the primitive component should cast a shadow or not.
Public variable TArray< TObjectPtr< ULandscapeHeightfieldCollisionComponent > > CollisionComponents Array of LandscapeHeightfieldCollisionComponent
Public variable int32 CollisionMipLevel Landscape LOD to use for collision tests. Higher numbers use less memory and process faster, but are much less accurate.
Public variable float ComponentScreenSizeToUseSubSections Component screen size (0.0 - 1.0) at which we should keep sub sections.
Public variable 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 int32 CustomDepthStencilValue Optionally write this 0-255 value to the stencil buffer in CustomDepth pass (Requires project setting or r.CustomDepth == 3)
Public variable ERendererStencilMask CustomDepthStencilWriteMask Mask used for stencil buffer writes.
Public variable TObjectPtr< UPhysicalMaterial > DefaultPhysMaterial Default physical material, used when no per-layer values physical materials
Public variable TArray< FLandscapeEditorLayerSettings > EditorLayerSettings  
Public variable 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 TArray< TObjectPtr< UHierarchicalInstancedStaticMeshComponent > > FoliageComponents  
Public variable uint32 FrameOffsetForTickInterval Frame offset for tick interval
Public variable TMap< UTexture2D *, FLandscapeEditLayerReadback * > HeightmapsCPUReadback  
Public variable TArray< TObjectPtr< ULandscapeComponent > > LandscapeComponents The array of LandscapeComponent that are used by the landscape
Protected variable 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 TObjectPtr< UMaterialInterface > LandscapeHoleMaterial Material used to render landscape components with holes.
Public variable TObjectPtr< UMaterialInterface > LandscapeMaterial Combined material used to render the landscape
Protected variable FLandscapeMaterialChangedDelegate LandscapeMaterialChangedDelegate  
Public variable FIntPoint LandscapeSectionOffset Offset in quads from global components grid origin (in quads)
Public variable float LDMaxDrawDistance Max draw distance exposed to LDs.
Public variable FLightingChannels LightingChannels Channels that this Landscape should be in.
Public variable FLightmassPrimitiveSettings LightmassSettings The Lightmass settings for this object.
Public variable float LOD0DistributionSetting The distribution setting used to change the LOD 0 generation, 1.75 is the normal distribution, numbers influence directly the LOD0 proportion on screen.
Public variable float LOD0ScreenSize This is the starting screen size used to calculate the distribution.
Public variable float LODDistributionSetting The distribution setting used to change the LOD generation, 2 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 uint32 LODGroupKey  
Public variable TMap< FString, TObjectPtr< UMaterialInstanceConstant > > MaterialInstanceConstantMap Map of material instance constants used to for the components.
Public variable int32 MaxLODLevel Max LOD level to use when rendering, -1 means the max available
Public variable int32 MaxPaintedLayersPerComponent  
Public variable TArray< TObjectPtr< ULandscapeNaniteComponent > > NaniteComponents  
Protected variable int32 NaniteLODIndex LOD level of the landscape when generating the Nanite mesh.
Protected variable float NaniteSkirtDepth  
Public variable ENavDataGatheringMode NavigationGeometryGatheringMode  
Public variable float NegativeZBoundsExtension Allows overriding the landscape bounds.
Public variable int32 NumComponentsNeedingGrassMapRender For the grassmap rendering notification
Public variable int32 NumSubsections  
Public variable int32 NumTexturesToStreamForVisibleGrassMapRender To throttle texture streaming when we're trying to render a grassmap
Public variable FOnLandscapeProxyComponentDataChanged OnComponentDataChanged  
Protected variable FGuid OriginalLandscapeGuid The original unmutated LandscapeGuid on the source asset, before instancing modfications.
Protected variable TArray< FLandscapePerLODMaterialOverride > PerLODOverrideMaterials  
Public variable float PositiveZBoundsExtension Allows overriding the landscape bounds.
Public variable TObjectPtr< UMaterialInterface > PreEditLandscapeHoleMaterial  
Public variable TObjectPtr< UMaterialInterface > PreEditLandscapeMaterial  
Protected variable TArray< FLandscapePerLODMaterialOverride > PreEditPerLODOverrideMaterials  
Public variable FGuid ReimportDestinationLayerGuid Height and weightmap import destination layer guid
Public variable FString ReimportHeightmapFilePath  
Public variable FRenderCommandFence ReleaseResourceFence  
Public variable TArray< TObjectPtr< URuntimeVirtualTexture > > RuntimeVirtualTextures Array of runtime virtual textures into which we draw this landscape.
Public variable EShadowCacheInvalidationBehavior ShadowCacheInvalidationBehavior Control shadow invalidation behavior, in particular with respect to Virtual Shadow Maps and material effects like World Position Offset.
Public variable 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 TObjectPtr< ULandscapeSplinesComponent > SplineComponent  
Public variable int32 StaticLightingLOD LOD level to use when running lightmass (increase to 1 or 2 for large landscapes to stop lightmass crashing)
Public variable 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 float StreamingDistanceMultiplier Allows artists to adjust the distance where textures using UV 0 are streamed in/out.
Public variable int32 SubsectionSizeQuads  
Public variable ELandscapeLayerDisplayMode TargetDisplayOrder Display Order mode for the targets
Public variable TArray< FName > TargetDisplayOrderList Display Order of the targets
Public variable int32 VirtualTextureLodBias Bias to the LOD selected for rendering to runtime virtual textures.
Public variable int32 VirtualTextureNumLods Number of mesh levels to use when rendering landscape into runtime virtual texture.
Public variable 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 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  
Public function Const bool

AreNaniteComponentsValid ( const FGuid& InProxyContentId
)

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

ChangeComponentScreenSizeToUseSubSections ( float InComponentScreenSizeToUseSubSections
)

 Change ComponentScreenSizeToUseSubSections value on the render proxy.
Public function void Changed Physical Material.
Public function Virtual void

ChangeLODDistanceFactor ( float InLODDistanceFactor
)

 Change the Level of Detail distance factor
Public function void

CheckGenerateMobilePlatformData ( bool bIsCooking,
const ITargetPlatform* TargetPlatform
)

 Generate mobile platform data if it's missing or outdated
Public function void  
Public function void Copy properties from parent Landscape actor.
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 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 Static ULandscapeLayerInfoObject *

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

 Creates a new LandscapeLayerInfoObject
Public function ULandscapeLayerInfoObject *

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

  
Public function Virtual void

CreateSplineComponent ( const FVector& Scale3D
)

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

DeleteLayer ( const FGuid& InLayerGuid
)

 Delete Layer.
Public function 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 void 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  
Public function Const bool  
Public function Const bool  
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
Public function FAsyncWorkMonitor &  
Public function Const FIntRect  
Public function Static void

GetGrassTypes ( const UWorld* World,
UMaterialInterface* LandscapeMat,
TArray< ULandscapeGrassType* >& GrassTypesOut,
float& OutMaxDiscardDistance
)

 Get the list of grass types on this landscape
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 const ALandscape *  
Public function Virtual 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 > &  
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 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 const TArray< FLandscapePerLODMaterialOverride > &  
Public function Const FIntPoint Get landscape position in section space
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
)

 Invalidate the precomputed grass and baked texture data for the specified components
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

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 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 Const bool

IsSharedProperty ( const FProperty* InProperty
)

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

IsSharedProperty ( const FName& InPropertyName
)

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

IsSharedPropertyOverridden ( const FString& InPropertyName
)

 Returns true if the shared property is overridden by the object.
Public function bool

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

 Output a landscape heightmap to a render target
Public function bool Output a landscape weightmap to a render target Only works in the editor
Public function bool

LandscapeImportHeightmapFromRenderTarget ( UTextureRenderTarget2D* InRenderTarget,
bool InImportHeightFromRGChannel
)

 Overwrites a landscape heightmap with render target data
Public function bool 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 Editor notification when changing feature level
Public function FLandscapeMaterialChangedDelegate &  
Public function void Recreate all collision components based on render component
Public function void 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 Unregisters a previously-registered exclusion box.
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* >& LandscapeComponents,
const TArray< ULandscapeGrassType* >& GrassTypes
)

 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 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 void 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 void

SetLandscapeMaterialScalarParameterValue ( FName ParameterName,
float Value
)

 Set a MID scalar (float) parameter value for all landscape components.
Public function void Set an MID texture parameter value for all landscape components.
Public function void 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 FString& InPropertyName,
const bool bIsOverriden
)

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

SetVirtualTextureRenderPassType ( ERuntimeVirtualTextureMainPassType InType
)

  
Public function Const bool Per-frame call to update dynamic grass placement and render grassmaps
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 void

UpdateAllComponentMaterialInstances ( bool bInInvalidateCombinationMaterials
)

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

UpdateAllComponentMaterialInstances ( FMaterialUpdateContext& InOutMaterialContext,
TArray< class FComponentRecreateRenderStateContext >& InOutRecreateRenderStateContext,
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,
bool bForceSync
)

 Update Grass
Public function void

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

 Update Grass
Public function void

UpdateGrassData ( bool bInShouldMarkDirty,
FScopedSlowTask* InSlowTask
)

 Update Grass maps
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
)

 Update the landscape physical material render tasks
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 APartitionActor

  Type Name Description
Public function Virtual Const uint32

GetDefaultGridSize ( UWorld* InWorld
)

  
Public function Virtual Const FGuid  

Overridden from AActor

  Type Name Description
Public function Virtual Const TUniquePtr< class FWorldPartitionActorDesc > Creates an uninitialized actor descriptor from this actor. Meant to be called on the class CDO.
Public function Virtual void Called when this actor is explicitly being destroyed during gameplay or in the editor, not called during level streaming or gameplay ending
Public function Virtual void

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

 Called by MirrorActors to perform a mirroring operation on the actor
Public function Virtual void

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

 Called by ApplyDeltaToActor to perform an actor class-specific operation based on widget manipulation.
Public function Virtual Const bool

EditorCanAttachTo ( const AActor* InParent,
FText& OutReason
)

 Returns true if this actor is allowed to be attached to the given actor
Public function Virtual Const bool Used by the "Sync to Content Browser" right-click menu option in the editor.
Public function Virtual Const bool Indicates whether this actor should participate in level bounds calculations
Public function Virtual void

PostEditMove ( bool bFinished
)

 Called after an actor has been moved in the editor
Public function Virtual void Called after all the components in the Components array are registered, called both in editor and during gameplay.
Public function Virtual void Rerun construction scripts, destroying all autogenerated components; will attempt to preserve the root component location.
Public function Virtual void

UnregisterAllComponents ( bool bForReregister
)

 Unregister all currently registered components

Overridden from UObject

  Type Name Description
Public function Virtual void Called before destroying the object.
Public function Virtual Const bool

CanEditChange ( const FProperty* InProperty
)

 Called by the editor to query whether a property of this object is allowed to be modified.
Public function Virtual void Called to finish destroying the object.
Public function Virtual bool Called to check if the object is ready for FinishDestroy.
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void Called after importing property values for this object (paste, duplicate or .t3d import) Allow the object to perform any cleanup for properties which shouldn't be duplicated or are unsupported by the script serialization
Public function Virtual void Called after applying a transaction to the object.
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.
Public function Virtual void

PreSave ( FObjectPreSaveContext SaveContext
)

 Presave function.
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

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 class FLandscapeMaterialChangedDelegate    
Public struct FRawMeshExportParams    

Constants

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

Deprecated Variables

  Type Name Description
Public variable float CollisionThickness CollisionThickness is not supported by Chaos Physics and therefore deprecated. Please remove any usage of this property
Public variable TArray< ULandscapeComponent * > Components FGIBakedTextureState is officially deprecated now and nothing updates it anymore
Public variable TArray< TObjectPtr< ULandscapeLayerInfoObject > > EditorCachedLayerInfos_DEPRECATED  
Public variable PRAGMA_DISABLE_DEPRECATION_WARNINGSTArray< FLandscapeProxyMaterialOverride > LandscapeMaterialsOverride_DEPRECATED LandscapeComponentMaterialOverride has been deprecated, use PerLODOverrideMaterials instead.
Public variable float LODDistanceFactor_DEPRECATED  
Public variable TEnumAsByte< ELandscapeLODFalloff::Type > LODFalloff_DEPRECATED  
Public variable TObjectPtr< ULandscapeNaniteComponent > NaniteComponent_DEPRECATED NaniteComponent has been deprecated, use NaniteComponents instead.
Public variable int32 NumComponentsNeedingTextureBaking NumComponentsNeedingTextureBaking is officially deprecated now and nothing updates it anymore
Public variable int32 UpdateBakedTexturesCountdown UpdateBakedTexturesCountdown is officially deprecated now and nothing updates it anymore

Deprecated Functions

  Type Name Description
Public function void BuildGIBakedTextures is officially deprecated now
Public function void

CheckGenerateLandscapePlatformData ( bool bIsCooking,
const ITargetPlatform* TargetPlatform
)

 CheckGenerateLandscapePlatformData has been deprecated, please use CheckGenerateMobilePlatformData instead.
Public function Const bool

ExportToRawMesh ( const TArrayView< ULandscapeComponent* >& InComponents,
int32 InExportLOD,
FMeshDescription& OutRawMesh,
const FBoxSphereBounds& InBounds,
bool bIgnoreBounds,
bool bGenerateOnePolygonGroupPerComponent
)

 Use the version of this function taking a FRawMeshExportParams as a parameter
Public function Const bool

ExportToRawMesh ( int32 InExportLOD,
FMeshDescription& OutRawMesh,
const FBoxSphereBounds& InBounds,
bool bIgnoreBounds
)

 Use the version of this function taking a FRawMeshExportParams as a parameter
Public function Const bool

ExportToRawMesh ( int32 InExportLOD,
FMeshDescription& OutRawMesh
)

 Use the version of this function taking a FRawMeshExportParams as a parameter
Public function Const int32 GetOutdatedGIBakedTextureComponentsCount is officially deprecated now returns 0
Public function void GetSharedProperties is being deprecated, please use CopySharedProperties or SynchronizeSharedProperties instead.
Public function Virtual PRAGMA_DISABLE_DEPRECATION_WARNINGSvoid

PreSave ( const ITargetPlatform* TargetPlatform
)

 Use version that takes FObjectPreSaveContext instead.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page