class_collisionpolygon.rst 1.3 KB

123456789101112131415161718192021222324252627282930313233343536373839
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the CollisionPolygon.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_CollisionPolygon:
  5. CollisionPolygon
  6. ================
  7. **Inherits:** :ref:`Spatial<class_spatial>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
  8. **Category:** Core
  9. Brief Description
  10. -----------------
  11. Editor-only class for defining a collision polygon in 3D space.
  12. Member Variables
  13. ----------------
  14. .. _class_CollisionPolygon_depth:
  15. - :ref:`float<class_float>` **depth** - Length that the resulting collision extends in either direction perpendicular to its polygon.
  16. .. _class_CollisionPolygon_disabled:
  17. - :ref:`bool<class_bool>` **disabled** - If true, no collision will be produced.
  18. .. _class_CollisionPolygon_polygon:
  19. - :ref:`PoolVector2Array<class_poolvector2array>` **polygon** - Array of vertices which define the polygon.
  20. Description
  21. -----------
  22. Allows editing a collision polygon's vertices on a selected plane. Can also set a depth perpendicular to that plane. This class is only available in the editor. It will not appear in the scene tree at runtime. Creates a :ref:`Shape<class_shape>` for gameplay. Properties modified during gameplay will have no effect.