Home Explore Help
Sign In
Godot
/
godot-docs
mirror of https://github.com/godotengine/godot-docs.git
2
0
Fork 0
Files Issues 0 Wiki
Tree: a9ccac82ea
Branches Tags
godot-docs
/
classes
/
class_concavepolygonshape2d.rst

class_concavepolygonshape2d.rst 2.0 KB
History Raw

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647 
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
    2. 

  2. .. DO NOT EDIT THIS FILE, but the ConcavePolygonShape2D.xml source instead.
    3. 

  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
    4. 

  4. 

  5. .. _class_ConcavePolygonShape2D:
    6. 

  6. 

  7. ConcavePolygonShape2D
    8. 

  8. =====================
    9. 

  9. 

  10. **Inherits:** :ref:`Shape2D<class_Shape2D>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
    11. 

  11. 

  12. **Category:** Core
    13. 

  13. 

  14. Brief Description
    15. 

  15. -----------------
    16. 

  16. 

  17. Concave polygon 2D shape resource for physics.
    18. 

  18. 

  19. Properties
    20. 

  20. ----------
    21. 

  21. 

  22. +-------------------------------------------------+----------------------------------------------------------------+
    23. 

  23. | :ref:`PoolVector2Array<class_PoolVector2Array>` | :ref:`segments<class_ConcavePolygonShape2D_property_segments>` |
    24. 

  24. +-------------------------------------------------+----------------------------------------------------------------+
    25. 

  25. 

  26. Description
    27. 

  27. -----------
    28. 

  28. 

  29. Concave polygon 2D shape resource for physics. It is made out of segments and is very optimal for complex polygonal concave collisions. It is really 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.
    30. 

  30. 

  31. 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.
    32. 

  32. 

  33. Property Descriptions
    34. 

  34. ---------------------
    35. 

  35. 

  36. .. _class_ConcavePolygonShape2D_property_segments:
    37. 

  37. 

  38. - :ref:`PoolVector2Array<class_PoolVector2Array>` **segments**
    39. 

  39. 

  40. +----------+---------------------+
    41. 

  41. | *Setter* | set_segments(value) |
    42. 

  42. +----------+---------------------+
    43. 

  43. | *Getter* | get_segments()      |
    44. 

  44. +----------+---------------------+
    45. 

  45. 

  46. The array of points that make up the ``ConcavePolygonShape2D``'s line segments.
    47. 

  47.