godot-docs/classes/class_heightmapshape.rst

:github_url: hide

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the HeightMapShape.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _class_HeightMapShape:

HeightMapShape
==============

**Inherits:** :ref:`Shape<class_Shape>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`

**Category:** Core

Brief Description
-----------------

Height map shape for 3D physics (Bullet only).

Properties
----------

+-------------------------------------------+-----------------------------------------------------------+-----------------------------+
| :ref:`PoolRealArray<class_PoolRealArray>` | :ref:`map_data<class_HeightMapShape_property_map_data>`   | PoolRealArray( 0, 0, 0, 0 ) |
+-------------------------------------------+-----------------------------------------------------------+-----------------------------+
| :ref:`int<class_int>`                     | :ref:`map_depth<class_HeightMapShape_property_map_depth>` | 2                           |
+-------------------------------------------+-----------------------------------------------------------+-----------------------------+
| :ref:`int<class_int>`                     | :ref:`map_width<class_HeightMapShape_property_map_width>` | 2                           |
+-------------------------------------------+-----------------------------------------------------------+-----------------------------+

Description
-----------

Height map shape resource, which can be added to a :ref:`PhysicsBody<class_PhysicsBody>` or :ref:`Area<class_Area>`.

Property Descriptions
---------------------

.. _class_HeightMapShape_property_map_data:

- :ref:`PoolRealArray<class_PoolRealArray>` **map_data**

+-----------+-----------------------------+
| *Default* | PoolRealArray( 0, 0, 0, 0 ) |
+-----------+-----------------------------+
| *Setter*  | set_map_data(value)         |
+-----------+-----------------------------+
| *Getter*  | get_map_data()              |
+-----------+-----------------------------+

Height map data, pool array must be of :ref:`map_width<class_HeightMapShape_property_map_width>` \* :ref:`map_depth<class_HeightMapShape_property_map_depth>` size.

.. _class_HeightMapShape_property_map_depth:

- :ref:`int<class_int>` **map_depth**

+-----------+----------------------+
| *Default* | 2                    |
+-----------+----------------------+
| *Setter*  | set_map_depth(value) |
+-----------+----------------------+
| *Getter*  | get_map_depth()      |
+-----------+----------------------+

Depth of the height map data. Changing this will resize the :ref:`map_data<class_HeightMapShape_property_map_data>`.

.. _class_HeightMapShape_property_map_width:

- :ref:`int<class_int>` **map_width**

+-----------+----------------------+
| *Default* | 2                    |
+-----------+----------------------+
| *Setter*  | set_map_width(value) |
+-----------+----------------------+
| *Getter*  | get_map_width()      |
+-----------+----------------------+

Width of the height map data. Changing this will resize the :ref:`map_data<class_HeightMapShape_property_map_data>`.