godot-docs/classes/class_heightmapshape3d.rst

:github_url: hide

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

.. _class_HeightMapShape3D:

HeightMapShape3D
================

**Inherits:** :ref:`Shape3D<class_Shape3D>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`

Height map shape for 3D physics.

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

Height map shape resource, which can be added to a :ref:`PhysicsBody3D<class_PhysicsBody3D>` or :ref:`Area3D<class_Area3D>`.

Properties
----------

+-----------------------------------------------------+-------------------------------------------------------------+------------------------------------+
| :ref:`PackedFloat32Array<class_PackedFloat32Array>` | :ref:`map_data<class_HeightMapShape3D_property_map_data>`   | ``PackedFloat32Array(0, 0, 0, 0)`` |
+-----------------------------------------------------+-------------------------------------------------------------+------------------------------------+
| :ref:`int<class_int>`                               | :ref:`map_depth<class_HeightMapShape3D_property_map_depth>` | ``2``                              |
+-----------------------------------------------------+-------------------------------------------------------------+------------------------------------+
| :ref:`int<class_int>`                               | :ref:`map_width<class_HeightMapShape3D_property_map_width>` | ``2``                              |
+-----------------------------------------------------+-------------------------------------------------------------+------------------------------------+

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

.. _class_HeightMapShape3D_property_map_data:

- :ref:`PackedFloat32Array<class_PackedFloat32Array>` **map_data**

+-----------+------------------------------------+
| *Default* | ``PackedFloat32Array(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_HeightMapShape3D_property_map_width>` \* :ref:`map_depth<class_HeightMapShape3D_property_map_depth>` size.

----

.. _class_HeightMapShape3D_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_HeightMapShape3D_property_map_data>`.

----

.. _class_HeightMapShape3D_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_HeightMapShape3D_property_map_data>`.

.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`