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

class_physicsdirectspacestate2dextension.rst 15 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161 
  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/master/doc/tools/make_rst.py.
    6. 

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

  7. 

  8. .. _class_PhysicsDirectSpaceState2DExtension:
    9. 

  9. 

  10. PhysicsDirectSpaceState2DExtension
    11. 

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

  12. 

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

  14. 

  15. Provides virtual methods that can be overridden to create custom :ref:`PhysicsDirectSpaceState2D<class_PhysicsDirectSpaceState2D>` implementations.
    16. 

  16. 

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

  18. 

  19. Description
    20. 

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

  21. 

  22. This class extends :ref:`PhysicsDirectSpaceState2D<class_PhysicsDirectSpaceState2D>` by providing additional virtual methods that can be overridden. When these methods are overridden, they will be called instead of the internal methods of the physics server.
    23. 

  23. 

  24. Intended for use with GDExtension to create custom implementations of :ref:`PhysicsDirectSpaceState2D<class_PhysicsDirectSpaceState2D>`.
    25. 

  25. 

  26. .. rst-class:: classref-reftable-group
    27. 

  27. 

  28. Methods
    29. 

  29. -------
    30. 

  30. 

  31. .. table::
    32. 

  32.    :widths: auto
    33. 

  33. 

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

  35.    | :ref:`bool<class_bool>` | :ref:`_cast_motion<class_PhysicsDirectSpaceState2DExtension_private_method__cast_motion>`\ (\ shape_rid\: :ref:`RID<class_RID>`, transform\: :ref:`Transform2D<class_Transform2D>`, motion\: :ref:`Vector2<class_Vector2>`, margin\: :ref:`float<class_float>`, collision_mask\: :ref:`int<class_int>`, collide_with_bodies\: :ref:`bool<class_bool>`, collide_with_areas\: :ref:`bool<class_bool>`, closest_safe\: ``float*``, closest_unsafe\: ``float*``\ ) |virtual|                                         |
    36. 

  36.    +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    37. 

  37.    | :ref:`bool<class_bool>` | :ref:`_collide_shape<class_PhysicsDirectSpaceState2DExtension_private_method__collide_shape>`\ (\ shape_rid\: :ref:`RID<class_RID>`, transform\: :ref:`Transform2D<class_Transform2D>`, motion\: :ref:`Vector2<class_Vector2>`, margin\: :ref:`float<class_float>`, collision_mask\: :ref:`int<class_int>`, collide_with_bodies\: :ref:`bool<class_bool>`, collide_with_areas\: :ref:`bool<class_bool>`, results\: ``void*``, max_results\: :ref:`int<class_int>`, result_count\: ``int32_t*``\ ) |virtual|      |
    38. 

  38.    +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    39. 

  39.    | :ref:`int<class_int>`   | :ref:`_intersect_point<class_PhysicsDirectSpaceState2DExtension_private_method__intersect_point>`\ (\ position\: :ref:`Vector2<class_Vector2>`, canvas_instance_id\: :ref:`int<class_int>`, collision_mask\: :ref:`int<class_int>`, collide_with_bodies\: :ref:`bool<class_bool>`, collide_with_areas\: :ref:`bool<class_bool>`, results\: ``PhysicsServer2DExtensionShapeResult*``, max_results\: :ref:`int<class_int>`\ ) |virtual|                                                                            |
    40. 

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

  41.    | :ref:`bool<class_bool>` | :ref:`_intersect_ray<class_PhysicsDirectSpaceState2DExtension_private_method__intersect_ray>`\ (\ from\: :ref:`Vector2<class_Vector2>`, to\: :ref:`Vector2<class_Vector2>`, collision_mask\: :ref:`int<class_int>`, collide_with_bodies\: :ref:`bool<class_bool>`, collide_with_areas\: :ref:`bool<class_bool>`, hit_from_inside\: :ref:`bool<class_bool>`, result\: ``PhysicsServer2DExtensionRayResult*``\ ) |virtual|                                                                                         |
    42. 

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

  43.    | :ref:`int<class_int>`   | :ref:`_intersect_shape<class_PhysicsDirectSpaceState2DExtension_private_method__intersect_shape>`\ (\ shape_rid\: :ref:`RID<class_RID>`, transform\: :ref:`Transform2D<class_Transform2D>`, motion\: :ref:`Vector2<class_Vector2>`, margin\: :ref:`float<class_float>`, collision_mask\: :ref:`int<class_int>`, collide_with_bodies\: :ref:`bool<class_bool>`, collide_with_areas\: :ref:`bool<class_bool>`, result\: ``PhysicsServer2DExtensionShapeResult*``, max_results\: :ref:`int<class_int>`\ ) |virtual| |
    44. 

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

  45.    | :ref:`bool<class_bool>` | :ref:`_rest_info<class_PhysicsDirectSpaceState2DExtension_private_method__rest_info>`\ (\ shape_rid\: :ref:`RID<class_RID>`, transform\: :ref:`Transform2D<class_Transform2D>`, motion\: :ref:`Vector2<class_Vector2>`, margin\: :ref:`float<class_float>`, collision_mask\: :ref:`int<class_int>`, collide_with_bodies\: :ref:`bool<class_bool>`, collide_with_areas\: :ref:`bool<class_bool>`, rest_info\: ``PhysicsServer2DExtensionShapeRestInfo*``\ ) |virtual|                                             |
    46. 

  46.    +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    47. 

  47.    | :ref:`bool<class_bool>` | :ref:`is_body_excluded_from_query<class_PhysicsDirectSpaceState2DExtension_method_is_body_excluded_from_query>`\ (\ body\: :ref:`RID<class_RID>`\ ) |const|                                                                                                                                                                                                                                                                                                                                                      |
    48. 

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

  49. 

  50. .. rst-class:: classref-section-separator
    51. 

  51. 

  52. ----
    53. 

  53. 

  54. .. rst-class:: classref-descriptions-group
    55. 

  55. 

  56. Method Descriptions
    57. 

  57. -------------------
    58. 

  58. 

  59. .. _class_PhysicsDirectSpaceState2DExtension_private_method__cast_motion:
    60. 

  60. 

  61. .. rst-class:: classref-method
    62. 

  62. 

  63. :ref:`bool<class_bool>` **_cast_motion**\ (\ shape_rid\: :ref:`RID<class_RID>`, transform\: :ref:`Transform2D<class_Transform2D>`, motion\: :ref:`Vector2<class_Vector2>`, margin\: :ref:`float<class_float>`, collision_mask\: :ref:`int<class_int>`, collide_with_bodies\: :ref:`bool<class_bool>`, collide_with_areas\: :ref:`bool<class_bool>`, closest_safe\: ``float*``, closest_unsafe\: ``float*``\ ) |virtual| :ref:`🔗<class_PhysicsDirectSpaceState2DExtension_private_method__cast_motion>`
    64. 

  64. 

  65. .. container:: contribute
    66. 

  66. 

  67. 	There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
    68. 

  68. 

  69. .. rst-class:: classref-item-separator
    70. 

  70. 

  71. ----
    72. 

  72. 

  73. .. _class_PhysicsDirectSpaceState2DExtension_private_method__collide_shape:
    74. 

  74. 

  75. .. rst-class:: classref-method
    76. 

  76. 

  77. :ref:`bool<class_bool>` **_collide_shape**\ (\ shape_rid\: :ref:`RID<class_RID>`, transform\: :ref:`Transform2D<class_Transform2D>`, motion\: :ref:`Vector2<class_Vector2>`, margin\: :ref:`float<class_float>`, collision_mask\: :ref:`int<class_int>`, collide_with_bodies\: :ref:`bool<class_bool>`, collide_with_areas\: :ref:`bool<class_bool>`, results\: ``void*``, max_results\: :ref:`int<class_int>`, result_count\: ``int32_t*``\ ) |virtual| :ref:`🔗<class_PhysicsDirectSpaceState2DExtension_private_method__collide_shape>`
    78. 

  78. 

  79. .. container:: contribute
    80. 

  80. 

  81. 	There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
    82. 

  82. 

  83. .. rst-class:: classref-item-separator
    84. 

  84. 

  85. ----
    86. 

  86. 

  87. .. _class_PhysicsDirectSpaceState2DExtension_private_method__intersect_point:
    88. 

  88. 

  89. .. rst-class:: classref-method
    90. 

  90. 

  91. :ref:`int<class_int>` **_intersect_point**\ (\ position\: :ref:`Vector2<class_Vector2>`, canvas_instance_id\: :ref:`int<class_int>`, collision_mask\: :ref:`int<class_int>`, collide_with_bodies\: :ref:`bool<class_bool>`, collide_with_areas\: :ref:`bool<class_bool>`, results\: ``PhysicsServer2DExtensionShapeResult*``, max_results\: :ref:`int<class_int>`\ ) |virtual| :ref:`🔗<class_PhysicsDirectSpaceState2DExtension_private_method__intersect_point>`
    92. 

  92. 

  93. .. container:: contribute
    94. 

  94. 

  95. 	There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
    96. 

  96. 

  97. .. rst-class:: classref-item-separator
    98. 

  98. 

  99. ----
    100. 

  100. 

  101. .. _class_PhysicsDirectSpaceState2DExtension_private_method__intersect_ray:
    102. 

  102. 

  103. .. rst-class:: classref-method
    104. 

  104. 

  105. :ref:`bool<class_bool>` **_intersect_ray**\ (\ from\: :ref:`Vector2<class_Vector2>`, to\: :ref:`Vector2<class_Vector2>`, collision_mask\: :ref:`int<class_int>`, collide_with_bodies\: :ref:`bool<class_bool>`, collide_with_areas\: :ref:`bool<class_bool>`, hit_from_inside\: :ref:`bool<class_bool>`, result\: ``PhysicsServer2DExtensionRayResult*``\ ) |virtual| :ref:`🔗<class_PhysicsDirectSpaceState2DExtension_private_method__intersect_ray>`
    106. 

  106. 

  107. .. container:: contribute
    108. 

  108. 

  109. 	There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
    110. 

  110. 

  111. .. rst-class:: classref-item-separator
    112. 

  112. 

  113. ----
    114. 

  114. 

  115. .. _class_PhysicsDirectSpaceState2DExtension_private_method__intersect_shape:
    116. 

  116. 

  117. .. rst-class:: classref-method
    118. 

  118. 

  119. :ref:`int<class_int>` **_intersect_shape**\ (\ shape_rid\: :ref:`RID<class_RID>`, transform\: :ref:`Transform2D<class_Transform2D>`, motion\: :ref:`Vector2<class_Vector2>`, margin\: :ref:`float<class_float>`, collision_mask\: :ref:`int<class_int>`, collide_with_bodies\: :ref:`bool<class_bool>`, collide_with_areas\: :ref:`bool<class_bool>`, result\: ``PhysicsServer2DExtensionShapeResult*``, max_results\: :ref:`int<class_int>`\ ) |virtual| :ref:`🔗<class_PhysicsDirectSpaceState2DExtension_private_method__intersect_shape>`
    120. 

  120. 

  121. .. container:: contribute
    122. 

  122. 

  123. 	There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
    124. 

  124. 

  125. .. rst-class:: classref-item-separator
    126. 

  126. 

  127. ----
    128. 

  128. 

  129. .. _class_PhysicsDirectSpaceState2DExtension_private_method__rest_info:
    130. 

  130. 

  131. .. rst-class:: classref-method
    132. 

  132. 

  133. :ref:`bool<class_bool>` **_rest_info**\ (\ shape_rid\: :ref:`RID<class_RID>`, transform\: :ref:`Transform2D<class_Transform2D>`, motion\: :ref:`Vector2<class_Vector2>`, margin\: :ref:`float<class_float>`, collision_mask\: :ref:`int<class_int>`, collide_with_bodies\: :ref:`bool<class_bool>`, collide_with_areas\: :ref:`bool<class_bool>`, rest_info\: ``PhysicsServer2DExtensionShapeRestInfo*``\ ) |virtual| :ref:`🔗<class_PhysicsDirectSpaceState2DExtension_private_method__rest_info>`
    134. 

  134. 

  135. .. container:: contribute
    136. 

  136. 

  137. 	There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
    138. 

  138. 

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

  140. 

  141. ----
    142. 

  142. 

  143. .. _class_PhysicsDirectSpaceState2DExtension_method_is_body_excluded_from_query:
    144. 

  144. 

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

  146. 

  147. :ref:`bool<class_bool>` **is_body_excluded_from_query**\ (\ body\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_PhysicsDirectSpaceState2DExtension_method_is_body_excluded_from_query>`
    148. 

  148. 

  149. .. container:: contribute
    150. 

  150. 

  151. 	There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
    152. 

  152. 

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

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

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

  156. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
    157. 

  157. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
    158. 

  158. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
    159. 

  159. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
    160. 

  160. .. |void| replace:: :abbr:`void (No return value.)`
    161. 

  161.