lovr.physics.newTerrainShape

Edit

Creates a new TerrainShape.




Create a flat floor collider.

Arguments

NameTypeDescription
scalenumber The width and depth of the terrain, in meters.

Returns

NameTypeDescription
terrainTerrainShape The new TerrainShape.

Create terrain from a heightmap image.

Arguments

NameTypeDefaultDescription
scalenumber The width and depth of the terrain, in meters.
heightmapImage A heightmap image describing the terrain elevation at different points. The red channel brightness of each pixel determines the elevation at corresponding coordinates.
stretchnumber1.0 A vertical multiplier for height values to obtain terrain height. When the image format has pixel values only in the 0 to 1 range, this can be used to scale the height to meters.

Returns

NameTypeDescription
terrainTerrainShape The new TerrainShape.

Create terrain defined with a callback function.

Arguments

NameTypeDefaultDescription
scalenumber The width and depth of the terrain, in meters.
callbackfunction A function that computes terrain height from x and z coordinates. The x and z inputs will range from -scale / 2 to scale / 2.
samplesnumber100 The number of samples taken across the x and z dimensions. More samples will result in higher terrain fidelity, but use more CPU and memory.

Returns

NameTypeDescription
terrainTerrainShape The new TerrainShape.

Notes

A Shape can be attached to a Collider using Collider:addShape. For immobile terrain use the Collider:setKinematic.

See also