class_heightmapshape.rst 2.7 KB

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