class_heightmapshape.rst 2.6 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the HeightMapShape.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_HeightMapShape:
  5. HeightMapShape
  6. ==============
  7. **Inherits:** :ref:`Shape<class_Shape>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  8. **Category:** Core
  9. Brief Description
  10. -----------------
  11. Height map shape for 3D physics (Bullet only).
  12. Properties
  13. ----------
  14. +-------------------------------------------+-----------------------------------------------------------+
  15. | :ref:`PoolRealArray<class_PoolRealArray>` | :ref:`map_data<class_HeightMapShape_property_map_data>` |
  16. +-------------------------------------------+-----------------------------------------------------------+
  17. | :ref:`int<class_int>` | :ref:`map_depth<class_HeightMapShape_property_map_depth>` |
  18. +-------------------------------------------+-----------------------------------------------------------+
  19. | :ref:`int<class_int>` | :ref:`map_width<class_HeightMapShape_property_map_width>` |
  20. +-------------------------------------------+-----------------------------------------------------------+
  21. Description
  22. -----------
  23. Height map shape resource, which can be added to a :ref:`PhysicsBody<class_PhysicsBody>` or :ref:`Area<class_Area>`.
  24. Property Descriptions
  25. ---------------------
  26. .. _class_HeightMapShape_property_map_data:
  27. - :ref:`PoolRealArray<class_PoolRealArray>` **map_data**
  28. +----------+---------------------+
  29. | *Setter* | set_map_data(value) |
  30. +----------+---------------------+
  31. | *Getter* | get_map_data() |
  32. +----------+---------------------+
  33. 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.
  34. .. _class_HeightMapShape_property_map_depth:
  35. - :ref:`int<class_int>` **map_depth**
  36. +----------+----------------------+
  37. | *Setter* | set_map_depth(value) |
  38. +----------+----------------------+
  39. | *Getter* | get_map_depth() |
  40. +----------+----------------------+
  41. Depth of the height map data. Changing this will resize the :ref:`map_data<class_HeightMapShape_property_map_data>`.
  42. .. _class_HeightMapShape_property_map_width:
  43. - :ref:`int<class_int>` **map_width**
  44. +----------+----------------------+
  45. | *Setter* | set_map_width(value) |
  46. +----------+----------------------+
  47. | *Getter* | get_map_width() |
  48. +----------+----------------------+
  49. Width of the height map data. Changing this will resize the :ref:`map_data<class_HeightMapShape_property_map_data>`.