Home Explore Help
Sign In
godotengine
/
godot-docs
mirror of https://github.com/godotengine/godot-docs
Watch 1
Star 1
Fork 0
Files
Tree: 7a86ac6a30
Branches Tags
godot-docs
/
classes
/
class_physics2ddirectspacestate.rst

class_physics2ddirectspacestate.rst 17 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191 
  1. :github_url: hide
    2. 

  2. 

  3. .. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
    4. 

  4. .. DO NOT EDIT THIS FILE, but the Physics2DDirectSpaceState.xml source instead.
    5. 

  5. .. The source is found in doc/classes or modules/<name>/doc_classes.
    6. 

  6. 

  7. .. _class_Physics2DDirectSpaceState:
    8. 

  8. 

  9. Physics2DDirectSpaceState
    10. 

  10. =========================
    11. 

  11. 

  12. **Inherits:** :ref:`Object<class_Object>`
    13. 

  13. 

  14. Direct access object to a space in the :ref:`Physics2DServer<class_Physics2DServer>`.
    15. 

  15. 

  16. Description
    17. 

  17. -----------
    18. 

  18. 

  19. Direct access object to a space in the :ref:`Physics2DServer<class_Physics2DServer>`. It's used mainly to do queries against objects and areas residing in a given space.
    20. 

  20. 

  21. Tutorials
    22. 

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

  23. 

  24. - :doc:`../tutorials/physics/physics_introduction`
    25. 

  25. 

  26. - :doc:`../tutorials/physics/ray-casting`
    27. 

  27. 

  28. Methods
    29. 

  29. -------
    30. 

  30. 

  31. +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    32. 

  32. | :ref:`Array<class_Array>`           | :ref:`cast_motion<class_Physics2DDirectSpaceState_method_cast_motion>` **(** :ref:`Physics2DShapeQueryParameters<class_Physics2DShapeQueryParameters>` shape **)**                                                                                                                                                                                                                                                               |
    33. 

  33. +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    34. 

  34. | :ref:`Array<class_Array>`           | :ref:`collide_shape<class_Physics2DDirectSpaceState_method_collide_shape>` **(** :ref:`Physics2DShapeQueryParameters<class_Physics2DShapeQueryParameters>` shape, :ref:`int<class_int>` max_results=32 **)**                                                                                                                                                                                                                     |
    35. 

  35. +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    36. 

  36. | :ref:`Dictionary<class_Dictionary>` | :ref:`get_rest_info<class_Physics2DDirectSpaceState_method_get_rest_info>` **(** :ref:`Physics2DShapeQueryParameters<class_Physics2DShapeQueryParameters>` shape **)**                                                                                                                                                                                                                                                           |
    37. 

  37. +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    38. 

  38. | :ref:`Array<class_Array>`           | :ref:`intersect_point<class_Physics2DDirectSpaceState_method_intersect_point>` **(** :ref:`Vector2<class_Vector2>` point, :ref:`int<class_int>` max_results=32, :ref:`Array<class_Array>` exclude=[  ], :ref:`int<class_int>` collision_layer=2147483647, :ref:`bool<class_bool>` collide_with_bodies=true, :ref:`bool<class_bool>` collide_with_areas=false **)**                                                               |
    39. 

  39. +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    40. 

  40. | :ref:`Array<class_Array>`           | :ref:`intersect_point_on_canvas<class_Physics2DDirectSpaceState_method_intersect_point_on_canvas>` **(** :ref:`Vector2<class_Vector2>` point, :ref:`int<class_int>` canvas_instance_id, :ref:`int<class_int>` max_results=32, :ref:`Array<class_Array>` exclude=[  ], :ref:`int<class_int>` collision_layer=2147483647, :ref:`bool<class_bool>` collide_with_bodies=true, :ref:`bool<class_bool>` collide_with_areas=false **)** |
    41. 

  41. +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    42. 

  42. | :ref:`Dictionary<class_Dictionary>` | :ref:`intersect_ray<class_Physics2DDirectSpaceState_method_intersect_ray>` **(** :ref:`Vector2<class_Vector2>` from, :ref:`Vector2<class_Vector2>` to, :ref:`Array<class_Array>` exclude=[  ], :ref:`int<class_int>` collision_layer=2147483647, :ref:`bool<class_bool>` collide_with_bodies=true, :ref:`bool<class_bool>` collide_with_areas=false **)**                                                                        |
    43. 

  43. +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    44. 

  44. | :ref:`Array<class_Array>`           | :ref:`intersect_shape<class_Physics2DDirectSpaceState_method_intersect_shape>` **(** :ref:`Physics2DShapeQueryParameters<class_Physics2DShapeQueryParameters>` shape, :ref:`int<class_int>` max_results=32 **)**                                                                                                                                                                                                                 |
    45. 

  45. +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    46. 

  46. 

  47. Method Descriptions
    48. 

  48. -------------------
    49. 

  49. 

  50. .. _class_Physics2DDirectSpaceState_method_cast_motion:
    51. 

  51. 

  52. - :ref:`Array<class_Array>` **cast_motion** **(** :ref:`Physics2DShapeQueryParameters<class_Physics2DShapeQueryParameters>` shape **)**
    53. 

  53. 

  54. Checks how far a :ref:`Shape2D<class_Shape2D>` can move without colliding. All the parameters for the query, including the shape and the motion, are supplied through a :ref:`Physics2DShapeQueryParameters<class_Physics2DShapeQueryParameters>` object.
    55. 

  55. 

  56. Returns an array with the safe and unsafe proportions (between 0 and 1) of the motion. The safe proportion is the maximum fraction of the motion that can be made without a collision. The unsafe proportion is the minimum fraction of the distance that must be moved for a collision. If no collision is detected a result of ``[1.0, 1.0]`` will be returned.
    57. 

  57. 

  58. **Note:** Any :ref:`Shape2D<class_Shape2D>`\ s that the shape is already colliding with e.g. inside of, will be ignored. Use :ref:`collide_shape<class_Physics2DDirectSpaceState_method_collide_shape>` to determine the :ref:`Shape2D<class_Shape2D>`\ s that the shape is already colliding with.
    59. 

  59. 

  60. ----
    61. 

  61. 

  62. .. _class_Physics2DDirectSpaceState_method_collide_shape:
    63. 

  63. 

  64. - :ref:`Array<class_Array>` **collide_shape** **(** :ref:`Physics2DShapeQueryParameters<class_Physics2DShapeQueryParameters>` shape, :ref:`int<class_int>` max_results=32 **)**
    65. 

  65. 

  66. Checks the intersections of a shape, given through a :ref:`Physics2DShapeQueryParameters<class_Physics2DShapeQueryParameters>` object, against the space. The resulting array contains a list of points where the shape intersects another. Like with :ref:`intersect_shape<class_Physics2DDirectSpaceState_method_intersect_shape>`, the number of returned results can be limited to save processing time.
    67. 

  67. 

  68. ----
    69. 

  69. 

  70. .. _class_Physics2DDirectSpaceState_method_get_rest_info:
    71. 

  71. 

  72. - :ref:`Dictionary<class_Dictionary>` **get_rest_info** **(** :ref:`Physics2DShapeQueryParameters<class_Physics2DShapeQueryParameters>` shape **)**
    73. 

  73. 

  74. Checks the intersections of a shape, given through a :ref:`Physics2DShapeQueryParameters<class_Physics2DShapeQueryParameters>` object, against the space. If it collides with more than one shape, the nearest one is selected. If the shape did not intersect anything, then an empty dictionary is returned instead.
    75. 

  75. 

  76. **Note:** This method does not take into account the ``motion`` property of the object. The returned object is a dictionary containing the following fields:
    77. 

  77. 

  78. ``collider_id``: The colliding object's ID.
    79. 

  79. 

  80. ``linear_velocity``: The colliding object's velocity :ref:`Vector2<class_Vector2>`. If the object is an :ref:`Area2D<class_Area2D>`, the result is ``(0, 0)``.
    81. 

  81. 

  82. ``metadata``: The intersecting shape's metadata. This metadata is different from :ref:`Object.get_meta<class_Object_method_get_meta>`, and is set with :ref:`Physics2DServer.shape_set_data<class_Physics2DServer_method_shape_set_data>`.
    83. 

  83. 

  84. ``normal``: The object's surface normal at the intersection point.
    85. 

  85. 

  86. ``point``: The intersection point.
    87. 

  87. 

  88. ``rid``: The intersecting object's :ref:`RID<class_RID>`.
    89. 

  89. 

  90. ``shape``: The shape index of the colliding shape.
    91. 

  91. 

  92. ----
    93. 

  93. 

  94. .. _class_Physics2DDirectSpaceState_method_intersect_point:
    95. 

  95. 

  96. - :ref:`Array<class_Array>` **intersect_point** **(** :ref:`Vector2<class_Vector2>` point, :ref:`int<class_int>` max_results=32, :ref:`Array<class_Array>` exclude=[  ], :ref:`int<class_int>` collision_layer=2147483647, :ref:`bool<class_bool>` collide_with_bodies=true, :ref:`bool<class_bool>` collide_with_areas=false **)**
    97. 

  97. 

  98. Checks whether a point is inside any solid shape. The shapes the point is inside of are returned in an array containing dictionaries with the following fields:
    99. 

  99. 

  100. ``collider``: The colliding object.
    101. 

  101. 

  102. ``collider_id``: The colliding object's ID.
    103. 

  103. 

  104. ``metadata``: The intersecting shape's metadata. This metadata is different from :ref:`Object.get_meta<class_Object_method_get_meta>`, and is set with :ref:`Physics2DServer.shape_set_data<class_Physics2DServer_method_shape_set_data>`.
    105. 

  105. 

  106. ``rid``: The intersecting object's :ref:`RID<class_RID>`.
    107. 

  107. 

  108. ``shape``: The shape index of the colliding shape.
    109. 

  109. 

  110. The number of intersections can be limited with the ``max_results`` parameter, to reduce the processing time.
    111. 

  111. 

  112. Additionally, the method can take an ``exclude`` array of objects or :ref:`RID<class_RID>`\ s that are to be excluded from collisions, a ``collision_mask`` bitmask representing the physics layers to check in, or booleans to determine if the ray should collide with :ref:`PhysicsBody2D<class_PhysicsBody2D>`\ s or :ref:`Area2D<class_Area2D>`\ s, respectively.
    113. 

  113. 

  114. **Note:** :ref:`ConcavePolygonShape2D<class_ConcavePolygonShape2D>`\ s and :ref:`CollisionPolygon2D<class_CollisionPolygon2D>`\ s in ``Segments`` build mode are not solid shapes. Therefore, they will not be detected.
    115. 

  115. 

  116. ----
    117. 

  117. 

  118. .. _class_Physics2DDirectSpaceState_method_intersect_point_on_canvas:
    119. 

  119. 

  120. - :ref:`Array<class_Array>` **intersect_point_on_canvas** **(** :ref:`Vector2<class_Vector2>` point, :ref:`int<class_int>` canvas_instance_id, :ref:`int<class_int>` max_results=32, :ref:`Array<class_Array>` exclude=[  ], :ref:`int<class_int>` collision_layer=2147483647, :ref:`bool<class_bool>` collide_with_bodies=true, :ref:`bool<class_bool>` collide_with_areas=false **)**
    121. 

  121. 

  122. Checks whether a point is inside any solid shape, in a specific canvas layer given by ``canvas_instance_id``. The shapes the point is inside of are returned in an array containing dictionaries with the following fields:
    123. 

  123. 

  124. ``collider``: The colliding object.
    125. 

  125. 

  126. ``collider_id``: The colliding object's ID.
    127. 

  127. 

  128. ``metadata``: The intersecting shape's metadata. This metadata is different from :ref:`Object.get_meta<class_Object_method_get_meta>`, and is set with :ref:`Physics2DServer.shape_set_data<class_Physics2DServer_method_shape_set_data>`.
    129. 

  129. 

  130. ``rid``: The intersecting object's :ref:`RID<class_RID>`.
    131. 

  131. 

  132. ``shape``: The shape index of the colliding shape.
    133. 

  133. 

  134. The number of intersections can be limited with the ``max_results`` parameter, to reduce the processing time.
    135. 

  135. 

  136. Additionally, the method can take an ``exclude`` array of objects or :ref:`RID<class_RID>`\ s that are to be excluded from collisions, a ``collision_mask`` bitmask representing the physics layers to check in, or booleans to determine if the ray should collide with :ref:`PhysicsBody2D<class_PhysicsBody2D>`\ s or :ref:`Area2D<class_Area2D>`\ s, respectively.
    137. 

  137. 

  138. **Note:** :ref:`ConcavePolygonShape2D<class_ConcavePolygonShape2D>`\ s and :ref:`CollisionPolygon2D<class_CollisionPolygon2D>`\ s in ``Segments`` build mode are not solid shapes. Therefore, they will not be detected.
    139. 

  139. 

  140. ----
    141. 

  141. 

  142. .. _class_Physics2DDirectSpaceState_method_intersect_ray:
    143. 

  143. 

  144. - :ref:`Dictionary<class_Dictionary>` **intersect_ray** **(** :ref:`Vector2<class_Vector2>` from, :ref:`Vector2<class_Vector2>` to, :ref:`Array<class_Array>` exclude=[  ], :ref:`int<class_int>` collision_layer=2147483647, :ref:`bool<class_bool>` collide_with_bodies=true, :ref:`bool<class_bool>` collide_with_areas=false **)**
    145. 

  145. 

  146. Intersects a ray in a given space. The returned object is a dictionary with the following fields:
    147. 

  147. 

  148. ``collider``: The colliding object.
    149. 

  149. 

  150. ``collider_id``: The colliding object's ID.
    151. 

  151. 

  152. ``metadata``: The intersecting shape's metadata. This metadata is different from :ref:`Object.get_meta<class_Object_method_get_meta>`, and is set with :ref:`Physics2DServer.shape_set_data<class_Physics2DServer_method_shape_set_data>`.
    153. 

  153. 

  154. ``normal``: The object's surface normal at the intersection point.
    155. 

  155. 

  156. ``position``: The intersection point.
    157. 

  157. 

  158. ``rid``: The intersecting object's :ref:`RID<class_RID>`.
    159. 

  159. 

  160. ``shape``: The shape index of the colliding shape.
    161. 

  161. 

  162. If the ray did not intersect anything, then an empty dictionary is returned instead.
    163. 

  163. 

  164. Additionally, the method can take an ``exclude`` array of objects or :ref:`RID<class_RID>`\ s that are to be excluded from collisions, a ``collision_mask`` bitmask representing the physics layers to check in, or booleans to determine if the ray should collide with :ref:`PhysicsBody2D<class_PhysicsBody2D>`\ s or :ref:`Area2D<class_Area2D>`\ s, respectively.
    165. 

  165. 

  166. ----
    167. 

  167. 

  168. .. _class_Physics2DDirectSpaceState_method_intersect_shape:
    169. 

  169. 

  170. - :ref:`Array<class_Array>` **intersect_shape** **(** :ref:`Physics2DShapeQueryParameters<class_Physics2DShapeQueryParameters>` shape, :ref:`int<class_int>` max_results=32 **)**
    171. 

  171. 

  172. Checks the intersections of a shape, given through a :ref:`Physics2DShapeQueryParameters<class_Physics2DShapeQueryParameters>` object, against the space.
    173. 

  173. 

  174. **Note:** This method does not take into account the ``motion`` property of the object. The intersected shapes are returned in an array containing dictionaries with the following fields:
    175. 

  175. 

  176. ``collider``: The colliding object.
    177. 

  177. 

  178. ``collider_id``: The colliding object's ID.
    179. 

  179. 

  180. ``metadata``: The intersecting shape's metadata. This metadata is different from :ref:`Object.get_meta<class_Object_method_get_meta>`, and is set with :ref:`Physics2DServer.shape_set_data<class_Physics2DServer_method_shape_set_data>`.
    181. 

  181. 

  182. ``rid``: The intersecting object's :ref:`RID<class_RID>`.
    183. 

  183. 

  184. ``shape``: The shape index of the colliding shape.
    185. 

  185. 

  186. The number of intersections can be limited with the ``max_results`` parameter, to reduce the processing time.
    187. 

  187. 

  188. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
    189. 

  189. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
    190. 

  190. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
    191. 

  191.