Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


CreateFromPlacement

Creates a TerrainMap from the positions of all active Terrains.
Read time 1 minuteLast updated 6 days ago

Definition

CreateFromPlacement(Terrain, Predicate<Terrain>, bool)

Creates a TerrainMap from the positions of all active Terrains.
public static TerrainMap CreateFromPlacement(Terrain originTerrain, Predicate<Terrain> filter = null, bool fullValidation = true)

Parameters

originTerrain

Defines the grid origin and size, as well as group id if no filter is specified.

Filter to be applied when populating the map. If null, the filter will fall back to matching terrains in the same group as the origin.

fullValidation

Validate the Terrain map. Default is true.

Returns

Type

Description

TerrainMapThe resulting Terrain map. Can return null when no Terrain objects pass the filter.

Remarks

Creates a TerrainMap of all the loaded Terrain objects that pass the filter validation.

CreateFromPlacement(Vector2, Vector2, Predicate<Terrain>, bool)

Creates a TerrainMap from the positions of all active Terrains.
public static TerrainMap CreateFromPlacement(Vector2 gridOrigin, Vector2 gridSize, Predicate<Terrain> filter = null, bool fullValidation = true)

Parameters

gridOrigin

Origin of the grid.

gridSize

Size of the grid. Typically takes the terrain size.x and size.z.

Filter to be applied when populating the map. If null, the filter will fall back to matching terrains in the same group as the origin.

fullValidation

Validate the Terrain map. Default is true.

Returns

Type

Description

TerrainMapThe resulting Terrain map. Can return null when no Terrain objects pass the filter.

Remarks

Creates a TerrainMap of all the loaded Terrain objects that pass the filter validation.