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
Branch: 3.6
Branches Tags
godot-docs
/
classes
/
class_physicsdirectspacestate.rst

class_physicsdirectspacestate.rst 13 KB
Permalink History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191 
  1. :github_url: hide
    2. 

  2. 

  3. .. DO NOT EDIT THIS FILE!!!
    4. 

  4. .. Generated automatically from Godot engine sources.
    5. 

  5. .. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py.
    6. 

  6. .. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/PhysicsDirectSpaceState.xml.
    7. 

  7. 

  8. .. _class_PhysicsDirectSpaceState:
    9. 

  9. 

  10. PhysicsDirectSpaceState
    11. 

  11. =======================
    12. 

  12. 

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

  14. 

  15. Direct access object to a space in the :ref:`PhysicsServer<class_PhysicsServer>`.
    16. 

  16. 

  17. .. rst-class:: classref-introduction-group
    18. 

  18. 

  19. Description
    20. 

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

  21. 

  22. Direct access object to a space in the :ref:`PhysicsServer<class_PhysicsServer>`. It's used mainly to do queries against objects and areas residing in a given space.
    23. 

  23. 

  24. .. rst-class:: classref-introduction-group
    25. 

  25. 

  26. Tutorials
    27. 

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

  28. 

  29. - :doc:`Physics introduction <../tutorials/physics/physics_introduction>`
    30. 

  30. 

  31. - :doc:`Ray-casting <../tutorials/physics/ray-casting>`
    32. 

  32. 

  33. .. rst-class:: classref-reftable-group
    34. 

  34. 

  35. Methods
    36. 

  36. -------
    37. 

  37. 

  38. .. table::
    39. 

  39.    :widths: auto
    40. 

  40. 

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

  42.    | :ref:`Array<class_Array>`           | :ref:`cast_motion<class_PhysicsDirectSpaceState_method_cast_motion>` **(** :ref:`PhysicsShapeQueryParameters<class_PhysicsShapeQueryParameters>` shape, :ref:`Vector3<class_Vector3>` motion **)**                                                                                                                                                               |
    43. 

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

  44.    | :ref:`Array<class_Array>`           | :ref:`collide_shape<class_PhysicsDirectSpaceState_method_collide_shape>` **(** :ref:`PhysicsShapeQueryParameters<class_PhysicsShapeQueryParameters>` shape, :ref:`int<class_int>` max_results=32 **)**                                                                                                                                                           |
    45. 

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

  46.    | :ref:`Dictionary<class_Dictionary>` | :ref:`get_rest_info<class_PhysicsDirectSpaceState_method_get_rest_info>` **(** :ref:`PhysicsShapeQueryParameters<class_PhysicsShapeQueryParameters>` shape **)**                                                                                                                                                                                                 |
    47. 

  47.    +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    48. 

  48.    | :ref:`Array<class_Array>`           | :ref:`intersect_point<class_PhysicsDirectSpaceState_method_intersect_point>` **(** :ref:`Vector3<class_Vector3>` 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 **)** |
    49. 

  49.    +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    50. 

  50.    | :ref:`Dictionary<class_Dictionary>` | :ref:`intersect_ray<class_PhysicsDirectSpaceState_method_intersect_ray>` **(** :ref:`Vector3<class_Vector3>` from, :ref:`Vector3<class_Vector3>` to, :ref:`Array<class_Array>` exclude=[  ], :ref:`int<class_int>` collision_mask=2147483647, :ref:`bool<class_bool>` collide_with_bodies=true, :ref:`bool<class_bool>` collide_with_areas=false **)**           |
    51. 

  51.    +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    52. 

  52.    | :ref:`Array<class_Array>`           | :ref:`intersect_shape<class_PhysicsDirectSpaceState_method_intersect_shape>` **(** :ref:`PhysicsShapeQueryParameters<class_PhysicsShapeQueryParameters>` shape, :ref:`int<class_int>` max_results=32 **)**                                                                                                                                                       |
    53. 

  53.    +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    54. 

  54. 

  55. .. rst-class:: classref-section-separator
    56. 

  56. 

  57. ----
    58. 

  58. 

  59. .. rst-class:: classref-descriptions-group
    60. 

  60. 

  61. Method Descriptions
    62. 

  62. -------------------
    63. 

  63. 

  64. .. _class_PhysicsDirectSpaceState_method_cast_motion:
    65. 

  65. 

  66. .. rst-class:: classref-method
    67. 

  67. 

  68. :ref:`Array<class_Array>` **cast_motion** **(** :ref:`PhysicsShapeQueryParameters<class_PhysicsShapeQueryParameters>` shape, :ref:`Vector3<class_Vector3>` motion **)**
    69. 

  69. 

  70. Checks how far a :ref:`Shape<class_Shape>` can move without colliding. All the parameters for the query, including the shape, are supplied through a :ref:`PhysicsShapeQueryParameters<class_PhysicsShapeQueryParameters>` object.
    71. 

  71. 

  72. 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.
    73. 

  73. 

  74. \ **Note:** Any :ref:`Shape<class_Shape>`\ s that the shape is already colliding with e.g. inside of, will be ignored. Use :ref:`collide_shape<class_PhysicsDirectSpaceState_method_collide_shape>` to determine the :ref:`Shape<class_Shape>`\ s that the shape is already colliding with.
    75. 

  75. 

  76. .. rst-class:: classref-item-separator
    77. 

  77. 

  78. ----
    79. 

  79. 

  80. .. _class_PhysicsDirectSpaceState_method_collide_shape:
    81. 

  81. 

  82. .. rst-class:: classref-method
    83. 

  83. 

  84. :ref:`Array<class_Array>` **collide_shape** **(** :ref:`PhysicsShapeQueryParameters<class_PhysicsShapeQueryParameters>` shape, :ref:`int<class_int>` max_results=32 **)**
    85. 

  85. 

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

  87. 

  88. .. rst-class:: classref-item-separator
    89. 

  89. 

  90. ----
    91. 

  91. 

  92. .. _class_PhysicsDirectSpaceState_method_get_rest_info:
    93. 

  93. 

  94. .. rst-class:: classref-method
    95. 

  95. 

  96. :ref:`Dictionary<class_Dictionary>` **get_rest_info** **(** :ref:`PhysicsShapeQueryParameters<class_PhysicsShapeQueryParameters>` shape **)**
    97. 

  97. 

  98. Checks the intersections of a shape, given through a :ref:`PhysicsShapeQueryParameters<class_PhysicsShapeQueryParameters>` object, against the space. If it collides with more than one shape, the nearest one is selected. The returned object is a dictionary containing the following fields:
    99. 

  99. 

  100. \ ``collider_id``: The colliding object's ID.
    101. 

  101. 

  102. \ ``linear_velocity``: The colliding object's velocity :ref:`Vector3<class_Vector3>`. If the object is an :ref:`Area<class_Area>`, the result is ``(0, 0, 0)``.
    103. 

  103. 

  104. \ ``normal``: The object's surface normal at the intersection point.
    105. 

  105. 

  106. \ ``point``: The intersection point.
    107. 

  107. 

  108. \ ``rid``: The intersecting object's :ref:`RID<class_RID>`.
    109. 

  109. 

  110. \ ``shape``: The shape index of the colliding shape.
    111. 

  111. 

  112. If the shape did not intersect anything, then an empty dictionary is returned instead.
    113. 

  113. 

  114. .. rst-class:: classref-item-separator
    115. 

  115. 

  116. ----
    117. 

  117. 

  118. .. _class_PhysicsDirectSpaceState_method_intersect_point:
    119. 

  119. 

  120. .. rst-class:: classref-method
    121. 

  121. 

  122. :ref:`Array<class_Array>` **intersect_point** **(** :ref:`Vector3<class_Vector3>` 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 **)**
    123. 

  123. 

  124. 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:
    125. 

  125. 

  126. \ ``collider``: The colliding object.
    127. 

  127. 

  128. \ ``collider_id``: The colliding object's ID.
    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:`PhysicsBody<class_PhysicsBody>`\ s or :ref:`Area<class_Area>`\ s, respectively.
    137. 

  137. 

  138. .. rst-class:: classref-item-separator
    139. 

  139. 

  140. ----
    141. 

  141. 

  142. .. _class_PhysicsDirectSpaceState_method_intersect_ray:
    143. 

  143. 

  144. .. rst-class:: classref-method
    145. 

  145. 

  146. :ref:`Dictionary<class_Dictionary>` **intersect_ray** **(** :ref:`Vector3<class_Vector3>` from, :ref:`Vector3<class_Vector3>` to, :ref:`Array<class_Array>` exclude=[  ], :ref:`int<class_int>` collision_mask=2147483647, :ref:`bool<class_bool>` collide_with_bodies=true, :ref:`bool<class_bool>` collide_with_areas=false **)**
    147. 

  147. 

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

  149. 

  150. \ ``collider``: The colliding object.
    151. 

  151. 

  152. \ ``collider_id``: The colliding object's ID.
    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:`PhysicsBody<class_PhysicsBody>`\ s or :ref:`Area<class_Area>`\ s, respectively.
    165. 

  165. 

  166. .. rst-class:: classref-item-separator
    167. 

  167. 

  168. ----
    169. 

  169. 

  170. .. _class_PhysicsDirectSpaceState_method_intersect_shape:
    171. 

  171. 

  172. .. rst-class:: classref-method
    173. 

  173. 

  174. :ref:`Array<class_Array>` **intersect_shape** **(** :ref:`PhysicsShapeQueryParameters<class_PhysicsShapeQueryParameters>` shape, :ref:`int<class_int>` max_results=32 **)**
    175. 

  175. 

  176. Checks the intersections of a shape, given through a :ref:`PhysicsShapeQueryParameters<class_PhysicsShapeQueryParameters>` object, against the space. The intersected shapes are returned in an array containing dictionaries with the following fields:
    177. 

  177. 

  178. \ ``collider``: The colliding object.
    179. 

  179. 

  180. \ ``collider_id``: The colliding object's ID.
    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. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
    192.