class_shapecast2d.rst 23 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492
  1. :github_url: hide
  2. .. DO NOT EDIT THIS FILE!!!
  3. .. Generated automatically from Godot engine sources.
  4. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ShapeCast2D.xml.
  6. .. _class_ShapeCast2D:
  7. ShapeCast2D
  8. ===========
  9. **Inherits:** :ref:`Node2D<class_Node2D>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
  10. A 2D shape that sweeps a region of space to detect :ref:`CollisionObject2D<class_CollisionObject2D>`\ s.
  11. .. rst-class:: classref-introduction-group
  12. Description
  13. -----------
  14. Shape casting allows to detect collision objects by sweeping its :ref:`shape<class_ShapeCast2D_property_shape>` along the cast direction determined by :ref:`target_position<class_ShapeCast2D_property_target_position>`. This is similar to :ref:`RayCast2D<class_RayCast2D>`, but it allows for sweeping a region of space, rather than just a straight line. **ShapeCast2D** can detect multiple collision objects. It is useful for things like wide laser beams or snapping a simple shape to a floor.
  15. Immediate collision overlaps can be done with the :ref:`target_position<class_ShapeCast2D_property_target_position>` set to ``Vector2(0, 0)`` and by calling :ref:`force_shapecast_update<class_ShapeCast2D_method_force_shapecast_update>` within the same physics frame. This helps to overcome some limitations of :ref:`Area2D<class_Area2D>` when used as an instantaneous detection area, as collision information isn't immediately available to it.
  16. \ **Note:** Shape casting is more computationally expensive than ray casting.
  17. .. rst-class:: classref-reftable-group
  18. Properties
  19. ----------
  20. .. table::
  21. :widths: auto
  22. +-------------------------------+----------------------------------------------------------------------------+--------------------+
  23. | :ref:`bool<class_bool>` | :ref:`collide_with_areas<class_ShapeCast2D_property_collide_with_areas>` | ``false`` |
  24. +-------------------------------+----------------------------------------------------------------------------+--------------------+
  25. | :ref:`bool<class_bool>` | :ref:`collide_with_bodies<class_ShapeCast2D_property_collide_with_bodies>` | ``true`` |
  26. +-------------------------------+----------------------------------------------------------------------------+--------------------+
  27. | :ref:`int<class_int>` | :ref:`collision_mask<class_ShapeCast2D_property_collision_mask>` | ``1`` |
  28. +-------------------------------+----------------------------------------------------------------------------+--------------------+
  29. | :ref:`Array<class_Array>` | :ref:`collision_result<class_ShapeCast2D_property_collision_result>` | ``[]`` |
  30. +-------------------------------+----------------------------------------------------------------------------+--------------------+
  31. | :ref:`bool<class_bool>` | :ref:`enabled<class_ShapeCast2D_property_enabled>` | ``true`` |
  32. +-------------------------------+----------------------------------------------------------------------------+--------------------+
  33. | :ref:`bool<class_bool>` | :ref:`exclude_parent<class_ShapeCast2D_property_exclude_parent>` | ``true`` |
  34. +-------------------------------+----------------------------------------------------------------------------+--------------------+
  35. | :ref:`float<class_float>` | :ref:`margin<class_ShapeCast2D_property_margin>` | ``0.0`` |
  36. +-------------------------------+----------------------------------------------------------------------------+--------------------+
  37. | :ref:`int<class_int>` | :ref:`max_results<class_ShapeCast2D_property_max_results>` | ``32`` |
  38. +-------------------------------+----------------------------------------------------------------------------+--------------------+
  39. | :ref:`Shape2D<class_Shape2D>` | :ref:`shape<class_ShapeCast2D_property_shape>` | |
  40. +-------------------------------+----------------------------------------------------------------------------+--------------------+
  41. | :ref:`Vector2<class_Vector2>` | :ref:`target_position<class_ShapeCast2D_property_target_position>` | ``Vector2(0, 50)`` |
  42. +-------------------------------+----------------------------------------------------------------------------+--------------------+
  43. .. rst-class:: classref-reftable-group
  44. Methods
  45. -------
  46. .. table::
  47. :widths: auto
  48. +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  49. | void | :ref:`add_exception<class_ShapeCast2D_method_add_exception>` **(** :ref:`CollisionObject2D<class_CollisionObject2D>` node **)** |
  50. +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  51. | void | :ref:`add_exception_rid<class_ShapeCast2D_method_add_exception_rid>` **(** :ref:`RID<class_RID>` rid **)** |
  52. +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  53. | void | :ref:`clear_exceptions<class_ShapeCast2D_method_clear_exceptions>` **(** **)** |
  54. +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  55. | void | :ref:`force_shapecast_update<class_ShapeCast2D_method_force_shapecast_update>` **(** **)** |
  56. +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  57. | :ref:`float<class_float>` | :ref:`get_closest_collision_safe_fraction<class_ShapeCast2D_method_get_closest_collision_safe_fraction>` **(** **)** |const| |
  58. +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  59. | :ref:`float<class_float>` | :ref:`get_closest_collision_unsafe_fraction<class_ShapeCast2D_method_get_closest_collision_unsafe_fraction>` **(** **)** |const| |
  60. +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  61. | :ref:`Object<class_Object>` | :ref:`get_collider<class_ShapeCast2D_method_get_collider>` **(** :ref:`int<class_int>` index **)** |const| |
  62. +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  63. | :ref:`RID<class_RID>` | :ref:`get_collider_rid<class_ShapeCast2D_method_get_collider_rid>` **(** :ref:`int<class_int>` index **)** |const| |
  64. +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  65. | :ref:`int<class_int>` | :ref:`get_collider_shape<class_ShapeCast2D_method_get_collider_shape>` **(** :ref:`int<class_int>` index **)** |const| |
  66. +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  67. | :ref:`int<class_int>` | :ref:`get_collision_count<class_ShapeCast2D_method_get_collision_count>` **(** **)** |const| |
  68. +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  69. | :ref:`bool<class_bool>` | :ref:`get_collision_mask_value<class_ShapeCast2D_method_get_collision_mask_value>` **(** :ref:`int<class_int>` layer_number **)** |const| |
  70. +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  71. | :ref:`Vector2<class_Vector2>` | :ref:`get_collision_normal<class_ShapeCast2D_method_get_collision_normal>` **(** :ref:`int<class_int>` index **)** |const| |
  72. +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  73. | :ref:`Vector2<class_Vector2>` | :ref:`get_collision_point<class_ShapeCast2D_method_get_collision_point>` **(** :ref:`int<class_int>` index **)** |const| |
  74. +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  75. | :ref:`bool<class_bool>` | :ref:`is_colliding<class_ShapeCast2D_method_is_colliding>` **(** **)** |const| |
  76. +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  77. | void | :ref:`remove_exception<class_ShapeCast2D_method_remove_exception>` **(** :ref:`CollisionObject2D<class_CollisionObject2D>` node **)** |
  78. +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  79. | void | :ref:`remove_exception_rid<class_ShapeCast2D_method_remove_exception_rid>` **(** :ref:`RID<class_RID>` rid **)** |
  80. +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  81. | void | :ref:`set_collision_mask_value<class_ShapeCast2D_method_set_collision_mask_value>` **(** :ref:`int<class_int>` layer_number, :ref:`bool<class_bool>` value **)** |
  82. +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  83. .. rst-class:: classref-section-separator
  84. ----
  85. .. rst-class:: classref-descriptions-group
  86. Property Descriptions
  87. ---------------------
  88. .. _class_ShapeCast2D_property_collide_with_areas:
  89. .. rst-class:: classref-property
  90. :ref:`bool<class_bool>` **collide_with_areas** = ``false``
  91. .. rst-class:: classref-property-setget
  92. - void **set_collide_with_areas** **(** :ref:`bool<class_bool>` value **)**
  93. - :ref:`bool<class_bool>` **is_collide_with_areas_enabled** **(** **)**
  94. If ``true``, collisions with :ref:`Area2D<class_Area2D>`\ s will be reported.
  95. .. rst-class:: classref-item-separator
  96. ----
  97. .. _class_ShapeCast2D_property_collide_with_bodies:
  98. .. rst-class:: classref-property
  99. :ref:`bool<class_bool>` **collide_with_bodies** = ``true``
  100. .. rst-class:: classref-property-setget
  101. - void **set_collide_with_bodies** **(** :ref:`bool<class_bool>` value **)**
  102. - :ref:`bool<class_bool>` **is_collide_with_bodies_enabled** **(** **)**
  103. If ``true``, collisions with :ref:`PhysicsBody2D<class_PhysicsBody2D>`\ s will be reported.
  104. .. rst-class:: classref-item-separator
  105. ----
  106. .. _class_ShapeCast2D_property_collision_mask:
  107. .. rst-class:: classref-property
  108. :ref:`int<class_int>` **collision_mask** = ``1``
  109. .. rst-class:: classref-property-setget
  110. - void **set_collision_mask** **(** :ref:`int<class_int>` value **)**
  111. - :ref:`int<class_int>` **get_collision_mask** **(** **)**
  112. The shape's collision mask. Only objects in at least one collision layer enabled in the mask will be detected.
  113. .. rst-class:: classref-item-separator
  114. ----
  115. .. _class_ShapeCast2D_property_collision_result:
  116. .. rst-class:: classref-property
  117. :ref:`Array<class_Array>` **collision_result** = ``[]``
  118. Returns the complete collision information from the collision sweep. The data returned is the same as in the :ref:`PhysicsDirectSpaceState2D.get_rest_info<class_PhysicsDirectSpaceState2D_method_get_rest_info>` method.
  119. .. rst-class:: classref-item-separator
  120. ----
  121. .. _class_ShapeCast2D_property_enabled:
  122. .. rst-class:: classref-property
  123. :ref:`bool<class_bool>` **enabled** = ``true``
  124. .. rst-class:: classref-property-setget
  125. - void **set_enabled** **(** :ref:`bool<class_bool>` value **)**
  126. - :ref:`bool<class_bool>` **is_enabled** **(** **)**
  127. If ``true``, collisions will be reported.
  128. .. rst-class:: classref-item-separator
  129. ----
  130. .. _class_ShapeCast2D_property_exclude_parent:
  131. .. rst-class:: classref-property
  132. :ref:`bool<class_bool>` **exclude_parent** = ``true``
  133. .. rst-class:: classref-property-setget
  134. - void **set_exclude_parent_body** **(** :ref:`bool<class_bool>` value **)**
  135. - :ref:`bool<class_bool>` **get_exclude_parent_body** **(** **)**
  136. If ``true``, the parent node will be excluded from collision detection.
  137. .. rst-class:: classref-item-separator
  138. ----
  139. .. _class_ShapeCast2D_property_margin:
  140. .. rst-class:: classref-property
  141. :ref:`float<class_float>` **margin** = ``0.0``
  142. .. rst-class:: classref-property-setget
  143. - void **set_margin** **(** :ref:`float<class_float>` value **)**
  144. - :ref:`float<class_float>` **get_margin** **(** **)**
  145. The collision margin for the shape. A larger margin helps detecting collisions more consistently, at the cost of precision.
  146. .. rst-class:: classref-item-separator
  147. ----
  148. .. _class_ShapeCast2D_property_max_results:
  149. .. rst-class:: classref-property
  150. :ref:`int<class_int>` **max_results** = ``32``
  151. .. rst-class:: classref-property-setget
  152. - void **set_max_results** **(** :ref:`int<class_int>` value **)**
  153. - :ref:`int<class_int>` **get_max_results** **(** **)**
  154. The number of intersections can be limited with this parameter, to reduce the processing time.
  155. .. rst-class:: classref-item-separator
  156. ----
  157. .. _class_ShapeCast2D_property_shape:
  158. .. rst-class:: classref-property
  159. :ref:`Shape2D<class_Shape2D>` **shape**
  160. .. rst-class:: classref-property-setget
  161. - void **set_shape** **(** :ref:`Shape2D<class_Shape2D>` value **)**
  162. - :ref:`Shape2D<class_Shape2D>` **get_shape** **(** **)**
  163. The :ref:`Shape2D<class_Shape2D>`-derived shape to be used for collision queries.
  164. .. rst-class:: classref-item-separator
  165. ----
  166. .. _class_ShapeCast2D_property_target_position:
  167. .. rst-class:: classref-property
  168. :ref:`Vector2<class_Vector2>` **target_position** = ``Vector2(0, 50)``
  169. .. rst-class:: classref-property-setget
  170. - void **set_target_position** **(** :ref:`Vector2<class_Vector2>` value **)**
  171. - :ref:`Vector2<class_Vector2>` **get_target_position** **(** **)**
  172. The shape's destination point, relative to this node's ``position``.
  173. .. rst-class:: classref-section-separator
  174. ----
  175. .. rst-class:: classref-descriptions-group
  176. Method Descriptions
  177. -------------------
  178. .. _class_ShapeCast2D_method_add_exception:
  179. .. rst-class:: classref-method
  180. void **add_exception** **(** :ref:`CollisionObject2D<class_CollisionObject2D>` node **)**
  181. Adds a collision exception so the shape does not report collisions with the specified :ref:`CollisionObject2D<class_CollisionObject2D>` node.
  182. .. rst-class:: classref-item-separator
  183. ----
  184. .. _class_ShapeCast2D_method_add_exception_rid:
  185. .. rst-class:: classref-method
  186. void **add_exception_rid** **(** :ref:`RID<class_RID>` rid **)**
  187. Adds a collision exception so the shape does not report collisions with the specified :ref:`RID<class_RID>`.
  188. .. rst-class:: classref-item-separator
  189. ----
  190. .. _class_ShapeCast2D_method_clear_exceptions:
  191. .. rst-class:: classref-method
  192. void **clear_exceptions** **(** **)**
  193. Removes all collision exceptions for this shape.
  194. .. rst-class:: classref-item-separator
  195. ----
  196. .. _class_ShapeCast2D_method_force_shapecast_update:
  197. .. rst-class:: classref-method
  198. void **force_shapecast_update** **(** **)**
  199. Updates the collision information for the shape immediately, without waiting for the next ``_physics_process`` call. Use this method, for example, when the shape or its parent has changed state.
  200. \ **Note:** ``enabled == true`` is not required for this to work.
  201. .. rst-class:: classref-item-separator
  202. ----
  203. .. _class_ShapeCast2D_method_get_closest_collision_safe_fraction:
  204. .. rst-class:: classref-method
  205. :ref:`float<class_float>` **get_closest_collision_safe_fraction** **(** **)** |const|
  206. The fraction from the **ShapeCast2D**'s origin to its :ref:`target_position<class_ShapeCast2D_property_target_position>` (between 0 and 1) of how far the shape can move without triggering a collision.
  207. .. rst-class:: classref-item-separator
  208. ----
  209. .. _class_ShapeCast2D_method_get_closest_collision_unsafe_fraction:
  210. .. rst-class:: classref-method
  211. :ref:`float<class_float>` **get_closest_collision_unsafe_fraction** **(** **)** |const|
  212. The fraction from the **ShapeCast2D**'s origin to its :ref:`target_position<class_ShapeCast2D_property_target_position>` (between 0 and 1) of how far the shape must move to trigger a collision.
  213. .. rst-class:: classref-item-separator
  214. ----
  215. .. _class_ShapeCast2D_method_get_collider:
  216. .. rst-class:: classref-method
  217. :ref:`Object<class_Object>` **get_collider** **(** :ref:`int<class_int>` index **)** |const|
  218. Returns the collided :ref:`Object<class_Object>` of one of the multiple collisions at ``index``, or ``null`` if no object is intersecting the shape (i.e. :ref:`is_colliding<class_ShapeCast2D_method_is_colliding>` returns ``false``).
  219. .. rst-class:: classref-item-separator
  220. ----
  221. .. _class_ShapeCast2D_method_get_collider_rid:
  222. .. rst-class:: classref-method
  223. :ref:`RID<class_RID>` **get_collider_rid** **(** :ref:`int<class_int>` index **)** |const|
  224. Returns the :ref:`RID<class_RID>` of the collided object of one of the multiple collisions at ``index``.
  225. .. rst-class:: classref-item-separator
  226. ----
  227. .. _class_ShapeCast2D_method_get_collider_shape:
  228. .. rst-class:: classref-method
  229. :ref:`int<class_int>` **get_collider_shape** **(** :ref:`int<class_int>` index **)** |const|
  230. Returns the shape ID of the colliding shape of one of the multiple collisions at ``index``, or ``0`` if no object is intersecting the shape (i.e. :ref:`is_colliding<class_ShapeCast2D_method_is_colliding>` returns ``false``).
  231. .. rst-class:: classref-item-separator
  232. ----
  233. .. _class_ShapeCast2D_method_get_collision_count:
  234. .. rst-class:: classref-method
  235. :ref:`int<class_int>` **get_collision_count** **(** **)** |const|
  236. The number of collisions detected at the point of impact. Use this to iterate over multiple collisions as provided by :ref:`get_collider<class_ShapeCast2D_method_get_collider>`, :ref:`get_collider_shape<class_ShapeCast2D_method_get_collider_shape>`, :ref:`get_collision_point<class_ShapeCast2D_method_get_collision_point>`, and :ref:`get_collision_normal<class_ShapeCast2D_method_get_collision_normal>` methods.
  237. .. rst-class:: classref-item-separator
  238. ----
  239. .. _class_ShapeCast2D_method_get_collision_mask_value:
  240. .. rst-class:: classref-method
  241. :ref:`bool<class_bool>` **get_collision_mask_value** **(** :ref:`int<class_int>` layer_number **)** |const|
  242. Returns whether or not the specified layer of the :ref:`collision_mask<class_ShapeCast2D_property_collision_mask>` is enabled, given a ``layer_number`` between 1 and 32.
  243. .. rst-class:: classref-item-separator
  244. ----
  245. .. _class_ShapeCast2D_method_get_collision_normal:
  246. .. rst-class:: classref-method
  247. :ref:`Vector2<class_Vector2>` **get_collision_normal** **(** :ref:`int<class_int>` index **)** |const|
  248. Returns the normal of one of the multiple collisions at ``index`` of the intersecting object.
  249. .. rst-class:: classref-item-separator
  250. ----
  251. .. _class_ShapeCast2D_method_get_collision_point:
  252. .. rst-class:: classref-method
  253. :ref:`Vector2<class_Vector2>` **get_collision_point** **(** :ref:`int<class_int>` index **)** |const|
  254. Returns the collision point of one of the multiple collisions at ``index`` where the shape intersects the colliding object.
  255. \ **Note:** this point is in the **global** coordinate system.
  256. .. rst-class:: classref-item-separator
  257. ----
  258. .. _class_ShapeCast2D_method_is_colliding:
  259. .. rst-class:: classref-method
  260. :ref:`bool<class_bool>` **is_colliding** **(** **)** |const|
  261. Returns whether any object is intersecting with the shape's vector (considering the vector length).
  262. .. rst-class:: classref-item-separator
  263. ----
  264. .. _class_ShapeCast2D_method_remove_exception:
  265. .. rst-class:: classref-method
  266. void **remove_exception** **(** :ref:`CollisionObject2D<class_CollisionObject2D>` node **)**
  267. Removes a collision exception so the shape does report collisions with the specified :ref:`CollisionObject2D<class_CollisionObject2D>` node.
  268. .. rst-class:: classref-item-separator
  269. ----
  270. .. _class_ShapeCast2D_method_remove_exception_rid:
  271. .. rst-class:: classref-method
  272. void **remove_exception_rid** **(** :ref:`RID<class_RID>` rid **)**
  273. Removes a collision exception so the shape does report collisions with the specified :ref:`RID<class_RID>`.
  274. .. rst-class:: classref-item-separator
  275. ----
  276. .. _class_ShapeCast2D_method_set_collision_mask_value:
  277. .. rst-class:: classref-method
  278. void **set_collision_mask_value** **(** :ref:`int<class_int>` layer_number, :ref:`bool<class_bool>` value **)**
  279. Based on ``value``, enables or disables the specified layer in the :ref:`collision_mask<class_ShapeCast2D_property_collision_mask>`, given a ``layer_number`` between 1 and 32.
  280. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  281. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  282. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  283. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  284. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  285. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
  286. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`