Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

SetHeights(int, int, float[,])

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

Definition

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

SetHeights(int, int, Single[0:,0:])

public void SetHeights(int xBase, int yBase, float[,] heights)

Parameters

xBase

int
First x index of heightmap samples to set.

yBase

int
First y index of heightmap samples to set.

heights

float[,]
Array of heightmap samples to set (values range from 0 to 1, array indexed as [y,x]).

Remarks

Sets heightmap data using a two dimensional array of heightmap samples. The samples are represented as float values ranging from 0 to 1. The area affected is defined by the array dimensions and starts at xBase and yBase. The heights array is indexed as [y,x].
This method recomputes all the LOD and vegetation information for the terrain on each call, which can be computationally expensive. In interactive editing scenarios, it may be better to call TerrainData.SetHeightsDelayLOD instead, followed by TerrainData.SyncHeightmap when the user completes an editing action.