This page is not the current release of O3DE documentation. Click here to switch to the latest release, or select a version from the dropdown.

Version:

Terrain Height Gradient List Component

The Terrain Height Gradient List provides height data for the terrain system from a list of one or more gradients. The range of heights is adjusted by scaling the height of the Axis Aligned Box Shape component on the same entity.

Provider

Terrain Gem

Dependencies

Axis Aligned Box Shape

Terrain Height Gradient List properties

Terrain Height Gradient List component properties

PropertyDescriptionValuesDefault
Gradient EntitiesAn array of entities with a Gradient component.Array: EntityIdNone

TerrainAreaHeightRequestBus

Use the following request functions with the TerrainAreaHeightRequestBus EBus interface to communicate with Terrain Height Gradient List components of your game.

Request NameDescriptionParameterReturnScriptable
GetHeightReturns a Vector3 of the Query Position with the Z-value updated to the terrain’s height at the query position. Also returns a boolean value indicating if terrain exists at the Query Position.Query Position: Vector3Terrain Height: Vector3, Terrain Exists: BooleanNo