World:newTerrainCollider
EditAdds a Collider to the world and attaches a TerrainShape.
Colliders with terrain shapes are immobile and can only be used for static environment objects. The collider will be kinematic and forces/velocities will not move it. Also, these colliders will not detect collisions with other kinematic objects.
TerrainShapes are not treated as solid objects, but instead a collection of triangles. They do not have mass or volume, and there is no concept of being "inside" the terrain.
Create a flat floor collider.
Arguments
| Name | Type | Description |
| scale | number | The width and depth of the terrain, in meters. |
Returns
| Name | Type | Description |
| collider | Collider | The new Collider. |
Create terrain from a heightmap image.
Arguments
| Name | Type | Default | Description |
| scale | number | The width and depth of the terrain, in meters. | |
| heightmap | Image |
A heightmap image describing the terrain elevation at different points. The red channel brightness of each pixel determines the elevation at corresponding coordinates. The image must be square and must have one of the formats supported by Image:getPixel.
| |
| stretch | number | 1.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
| Name | Type | Description |
| collider | Collider | The new Collider. |
Create terrain defined with a callback function.
Arguments
| Name | Type | Default | Description |
| scale | number | The width and depth of the terrain, in meters. | |
| callback | function |
A function that returns terrain height from x and z coordinates. The x and z inputs will range from -scale / 2 to scale / 2.
| |
| samples | number | 100 | 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
| Name | Type | Description |
| collider | Collider | The new Collider. |