Attention: Here be dragons
This is the latest
(unstable) version of this documentation, which may document features
not available in or compatible with released stable versions of Godot.
Checking the stable version of the documentation...
HeightMapShape3D¶
Inherits: Shape3D < Resource < RefCounted < Object
A 3D height map shape used for physics collision.
Description¶
A 3D heightmap shape, intended for use in physics. Usually used to provide a shape for a CollisionShape3D. This is useful for terrain, but it is limited as overhangs (such as caves) cannot be stored. Holes in a HeightMapShape3D are created by assigning very low values to points in the desired area.
Performance: HeightMapShape3D is faster to check collisions against than ConcavePolygonShape3D, but it is significantly slower than primitive shapes like BoxShape3D.
Properties¶
|
||
|
||
|
Methods¶
get_max_height() const |
|
get_min_height() const |
Property Descriptions¶
PackedFloat32Array map_data = PackedFloat32Array(0, 0, 0, 0)
void set_map_data(value: PackedFloat32Array)
PackedFloat32Array get_map_data()
Height map data. The array's size must be equal to map_width multiplied by map_depth.
int map_depth = 2
Number of vertices in the depth of the height map. Changing this will resize the map_data.
int map_width = 2
Number of vertices in the width of the height map. Changing this will resize the map_data.
Method Descriptions¶
float get_max_height() const
Returns the largest height value found in map_data. Recalculates only when map_data changes.
float get_min_height() const
Returns the smallest height value found in map_data. Recalculates only when map_data changes.