Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Landscape > ULandscapeInfo

Light Theme

Dark Theme

ULandscapeInfo

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

ULandscapeInfo

References

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

Syntax

class ULandscapeInfo : public UObject

Variables

	Name	Description
int32	ComponentNumSubsections
int32	ComponentSizeQuads
FVector	DrawScale
TLazyObjectPtr<...	LandscapeActor
FGuid	LandscapeGuid
TArray< FLandsc...	Layers
TArray< ALandsc...	Proxies
TMap< FIntPoint...	SelectedRegion
int32	SubsectionSizeQuads
TMap< FIntPoint...	XYtoAddCollisionMap	Lookup map used by the "add component" tool.
TMap< FIntPoint...	XYtoCollisionComponentMap	Map of the offsets (in component space) to the collision components. Should always be valid.
TMap< FIntPoint...	XYtoComponentMap	Map of the offsets (in component space) to the component. Valid in editor only.

Constructors

	Name	Description
	ULandscapeInfo ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
bool	ApplySplines ( bool bOnlySelected, TSet< ULandscapeComponent* >&..., bool bMarkPackageDirty )
bool	AreAllComponentsRegistered()
bool	CanHaveLayersContent()	Will tell if the landscape actor can have some content related to the layer system
void	ClearDirtyData()	Will clear all component dirty data
void	ClearSelectedRegion ( bool bIsComponentwise )
void	CreateLayerEditorSettingsFor ( ULandscapeLayerInfoObject* Lay... )
void	DeleteLayer ( ULandscapeLayerInfoObject* Lay..., const FName& LayerName )
void	ExportHeightmap ( const FString& Filename )
void	ExportLayer ( ULandscapeLayerInfoObject* Lay..., const FString& Filename )
void	FixupProxiesTransform()	Fixes up proxies relative position to landscape actor basically makes sure that each LandscapeProxy RootComponent transform reflects LandscapeSectionOffset value requires LandscapeActor to be loaded Does not work in World composition mode!
void	ForAllLandscapeComponents ( TFunctionRef< void... )
void	ForAllLandscapeProxies ( TFunctionRef< void ... )	Runs the given function on the root landscape actor and all streaming proxies Most easily used with a lambda as follows: ForAllLandscapeProxies([](ALandscapeProxy* Proxy) { Code });
void	GetComponentsInRegion ( int32 X1, int32 Y1, int32 X2, int32 Y2, TSet< ULandscapeComponent* >&..., bool bOverlap )
ALandscapePr...	GetCurrentLevelLandscapeProxy ( bool bRegistered )	Returns landscape which is spawned in the current level that was previously added to this landscape info object
FVector	GetLandscapeCenterPos ( float& LengthZ, int32 MinX, int32 MinY, int32 MaxX, int32 MaxY )
bool	GetLandscapeExtent ( int32& MinX, int32& MinY, int32& MaxX, int32& MaxY )
ALandscapePr...	GetLandscapeProxy()	Returns shared landscape or landscape proxy, mostly for transformations
ALandscapePr...	GetLandscapeProxyForLevel ( ULevel* Level )	Returns the landscape proxy of this landscape info in the given level (if it exists)
FLandscapeEd...	GetLayerEditorSettings ( ULandscapeLayerInfoObject* Lay... )
ULandscapeLa...	GetLayerInfoByName ( FName LayerName, ALandscapeProxy* Owner )
int32	GetLayerInfoIndex ( FName LayerName, ALandscapeProxy* Owner )
int32	GetLayerInfoIndex ( ULandscapeLayerInfoObject* Lay..., ALandscapeProxy* Owner )
TSet< ULands...	GetSelectedComponents()
bool	GetSelectedExtent ( int32& MinX, int32& MinY, int32& MaxX, int32& MaxY )
TSet< ULands...	GetSelectedRegionComponents()
void	GetUsedPaintLayers ( const FGuid& InLayerGuid, TArray< ULandscapeLayerInfoObject&... )
bool	IsValidPosition ( int32 X, int32 Y )
ALandscapePr...	MoveComponentsToLevel ( const TArray< ULandscapeComponent&..., ULevel* TargetLevel, FName NewProxyName )	Moves Components to target level.
void	MoveSplinesToLevel ( ULandscapeSplinesComponent* In..., ULevel* TargetLevel )	Moves all Splines to target level. Creates ULandscapeSplineComponent if needed.
void	MoveSplineToLevel ( ULandscapeSplineControlPoint* ..., ULevel* TargetLevel )	Moves Splines connected to this control point to target level.
void	PostponeTextureBaking()	Postpones landscape textures baking, usually used during landscape painting to avoid hitches
void	RecreateCollisionComponents()
void	RecreateLandscapeInfo ( UWorld* InWorld, bool bMapCheck )	Recreate all LandscapeInfo objects in given world
void	RegisterActor ( ALandscapeProxy* Proxy, bool bMapCheck )	Associates passed actor with this info object
void	RegisterActorComponent ( ULandscapeComponent* Component, bool bMapCheck )	Associates passed landscape component with this info object
void	RegisterCollisionComponent ( ULandscapeHeightfieldCollisionCompo... )	Server doesn't have ULandscapeComponent use CollisionComponents instead to get height on landscape
void	RemoveXYOffsets()
void	ReplaceLayer ( ULandscapeLayerInfoObject* Fro..., ULandscapeLayerInfoObject* ToL... )
void	Reset()	Resets all actors, proxies, components registrations
void	UnregisterActor ( ALandscapeProxy* Proxy )	Deassociates passed actor with this info object
void	UnregisterActorComponent ( ULandscapeComponent* Component )	Deassociates passed landscape component with this info object
void	UnregisterCollisionComponent ( ULandscapeHeightfieldCollisionCompo... )
void	UpdateAddCollision ( FIntPoint LandscapeKey )
void	UpdateAllAddCollisions()	Only for use by the "add component" tool. Todo - move into the tool?
void	UpdateAllComponentMaterialInstances()	Will call UpdateAllComponentMaterialInstances on all LandscapeProxies
void	UpdateComponentLayerWhitelist()	Update per-component layer whitelists to include the currently painted layers.
void	UpdateDebugColorMaterial()
bool	UpdateLayerInfoMap ( ALandscapeProxy* Proxy, bool bInvalidate )
void	UpdateSelectedComponents ( TSet< ULandscapeComponent* >&..., bool bIsComponentwise )

Overridden from UObject

		Name	Description
	void	Serialize ( FArchive& Ar )	Handles reading, writing, and reference collecting using FArchive.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss