Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

SetHoles(int, int, bool[,])

Sets an array of Terrain holes samples.
Read time 1 minuteLast updated 6 days ago

Definition

  • Type: Method
  • Namespace: UnityEngine
  • Assembly: UnityEngine.TerrainModule

SetHoles(int, int, Boolean[0:,0:])

public void SetHoles(int xBase, int yBase, bool[,] holes)

Parameters

xBase

int
First x index of Terrain holes samples to set.

yBase

int
First y index of Terrain holes samples to set.

holes

bool[,]
Array of Terrain holes samples to set (array indexed as [y,x]).

Remarks

Sets Terrain holes data using a two-dimensional array of Terrain holes samples. The samples are represented as bool values: 
true
for surface and 
false
for hole. The array dimensions define the area affected, which starts at 
xBase
and 
yBase
. The Terrain holes array is indexed as [y,x].
This method recomputes all LOD and vegetation information for the Terrain on each call, which can be computationally expensive. In interactive editing scenarios, it might be better to call TerrainData.SetHolesDelayLOD instead, followed by TerrainData.SyncTexture when the user completes an editing action.