Legacy Documentation: Version 5.6 (Go to current version)
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

TerrainData.GetHeights

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

public function GetHeights(xBase: int, yBase: int, width: int, height: int): float[,];
public float[,] GetHeights(int xBase, int yBase, int width, int height);

Parameters

xBase First x index of heightmap samples to retrieve.
yBase First y index of heightmap samples to retrieve.
width Number of samples to retrieve along the heightmap's x axis.
height Number of samples to retrieve along the heightmap's y axis.

Description

Get an array of heightmap samples.

Returns a two dimensional array of heightmap samples. The samples are represented as float values ranging from 0 to 1. The array has the dimensions [height,width] and is indexed as [y,x].