class_concavepolygonshape2d.rst 2.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
  3. .. DO NOT EDIT THIS FILE, but the ConcavePolygonShape2D.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_ConcavePolygonShape2D:
  6. ConcavePolygonShape2D
  7. =====================
  8. **Inherits:** :ref:`Shape2D<class_Shape2D>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  9. Concave polygon 2D shape resource for physics.
  10. Description
  11. -----------
  12. Concave polygon 2D shape resource for physics. It is made out of segments and is optimal for complex polygonal concave collisions. However, it is not advised to use for :ref:`RigidBody2D<class_RigidBody2D>` nodes. A CollisionPolygon2D in convex decomposition mode (solids) or several convex objects are advised for that instead. Otherwise, a concave polygon 2D shape is better for static collisions.
  13. The main difference between a :ref:`ConvexPolygonShape2D<class_ConvexPolygonShape2D>` and a ``ConcavePolygonShape2D`` is that a concave polygon assumes it is concave and uses a more complex method of collision detection, and a convex one forces itself to be convex in order to speed up collision detection.
  14. Properties
  15. ----------
  16. +-------------------------------------------------+----------------------------------------------------------------+--------------------------+
  17. | :ref:`PoolVector2Array<class_PoolVector2Array>` | :ref:`segments<class_ConcavePolygonShape2D_property_segments>` | ``PoolVector2Array( )`` |
  18. +-------------------------------------------------+----------------------------------------------------------------+--------------------------+
  19. Property Descriptions
  20. ---------------------
  21. .. _class_ConcavePolygonShape2D_property_segments:
  22. - :ref:`PoolVector2Array<class_PoolVector2Array>` **segments**
  23. +-----------+--------------------------+
  24. | *Default* | ``PoolVector2Array( )`` |
  25. +-----------+--------------------------+
  26. | *Setter* | set_segments(value) |
  27. +-----------+--------------------------+
  28. | *Getter* | get_segments() |
  29. +-----------+--------------------------+
  30. The array of points that make up the ``ConcavePolygonShape2D``'s line segments.
  31. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  32. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  33. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`