Version: Unity 6.1 Alpha (6000.1)
LanguageEnglish
  • C#

Terrain.SampleHeight

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

Declaration

public float SampleHeight(Vector3 worldPosition);

Description

Samples the height at the given position defined in world space, relative to the Terrain space.

This method automatically clamps the world position to the Terrain boundaries.

using UnityEngine;

public class ExampleScript : MonoBehaviour { void LateUpdate() { Vector3 pos = transform.position; pos.y = Terrain.activeTerrain.SampleHeight(transform.position); transform.position = pos; } }