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: 75b51ec2f4
Branches Tags
godot-docs
/
classes
/
class_physicstestmotionresult3d.rst

class_physicstestmotionresult3d.rst 11 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172 
  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 PhysicsTestMotionResult3D.xml source instead.
    5. 

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

  6. 

  7. .. _class_PhysicsTestMotionResult3D:
    8. 

  8. 

  9. PhysicsTestMotionResult3D
    10. 

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

  11. 

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

  13. 

  14. Result from a 3D body motion test.
    15. 

  15. 

  16. Description
    17. 

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

  18. 

  19. This class contains the motion and collision result from :ref:`PhysicsServer3D.body_test_motion<class_PhysicsServer3D_method_body_test_motion>`.
    20. 

  20. 

  21. Methods
    22. 

  22. -------
    23. 

  23. 

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

  25. | :ref:`Object<class_Object>`   | :ref:`get_collider<class_PhysicsTestMotionResult3D_method_get_collider>` **(** :ref:`int<class_int>` collision_index=0 **)** |const|                           |
    26. 

  26. +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
    27. 

  27. | :ref:`int<class_int>`         | :ref:`get_collider_id<class_PhysicsTestMotionResult3D_method_get_collider_id>` **(** :ref:`int<class_int>` collision_index=0 **)** |const|                     |
    28. 

  28. +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
    29. 

  29. | :ref:`RID<class_RID>`         | :ref:`get_collider_rid<class_PhysicsTestMotionResult3D_method_get_collider_rid>` **(** :ref:`int<class_int>` collision_index=0 **)** |const|                   |
    30. 

  30. +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
    31. 

  31. | :ref:`int<class_int>`         | :ref:`get_collider_shape<class_PhysicsTestMotionResult3D_method_get_collider_shape>` **(** :ref:`int<class_int>` collision_index=0 **)** |const|               |
    32. 

  32. +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
    33. 

  33. | :ref:`Vector3<class_Vector3>` | :ref:`get_collider_velocity<class_PhysicsTestMotionResult3D_method_get_collider_velocity>` **(** :ref:`int<class_int>` collision_index=0 **)** |const|         |
    34. 

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

  35. | :ref:`int<class_int>`         | :ref:`get_collision_count<class_PhysicsTestMotionResult3D_method_get_collision_count>` **(** **)** |const|                                                     |
    36. 

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

  37. | :ref:`float<class_float>`     | :ref:`get_collision_depth<class_PhysicsTestMotionResult3D_method_get_collision_depth>` **(** :ref:`int<class_int>` collision_index=0 **)** |const|             |
    38. 

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

  39. | :ref:`int<class_int>`         | :ref:`get_collision_local_shape<class_PhysicsTestMotionResult3D_method_get_collision_local_shape>` **(** :ref:`int<class_int>` collision_index=0 **)** |const| |
    40. 

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

  41. | :ref:`Vector3<class_Vector3>` | :ref:`get_collision_normal<class_PhysicsTestMotionResult3D_method_get_collision_normal>` **(** :ref:`int<class_int>` collision_index=0 **)** |const|           |
    42. 

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

  43. | :ref:`Vector3<class_Vector3>` | :ref:`get_collision_point<class_PhysicsTestMotionResult3D_method_get_collision_point>` **(** :ref:`int<class_int>` collision_index=0 **)** |const|             |
    44. 

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

  45. | :ref:`float<class_float>`     | :ref:`get_collision_safe_fraction<class_PhysicsTestMotionResult3D_method_get_collision_safe_fraction>` **(** **)** |const|                                     |
    46. 

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

  47. | :ref:`float<class_float>`     | :ref:`get_collision_unsafe_fraction<class_PhysicsTestMotionResult3D_method_get_collision_unsafe_fraction>` **(** **)** |const|                                 |
    48. 

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

  49. | :ref:`Vector3<class_Vector3>` | :ref:`get_remainder<class_PhysicsTestMotionResult3D_method_get_remainder>` **(** **)** |const|                                                                 |
    50. 

  50. +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
    51. 

  51. | :ref:`Vector3<class_Vector3>` | :ref:`get_travel<class_PhysicsTestMotionResult3D_method_get_travel>` **(** **)** |const|                                                                       |
    52. 

  52. +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
    53. 

  53. 

  54. Method Descriptions
    55. 

  55. -------------------
    56. 

  56. 

  57. .. _class_PhysicsTestMotionResult3D_method_get_collider:
    58. 

  58. 

  59. - :ref:`Object<class_Object>` **get_collider** **(** :ref:`int<class_int>` collision_index=0 **)** |const|
    60. 

  60. 

  61. Returns the colliding body's attached :ref:`Object<class_Object>` given a collision index (the deepest collision by default), if a collision occurred.
    62. 

  62. 

  63. ----
    64. 

  64. 

  65. .. _class_PhysicsTestMotionResult3D_method_get_collider_id:
    66. 

  66. 

  67. - :ref:`int<class_int>` **get_collider_id** **(** :ref:`int<class_int>` collision_index=0 **)** |const|
    68. 

  68. 

  69. Returns the unique instance ID of the colliding body's attached :ref:`Object<class_Object>` given a collision index (the deepest collision by default), if a collision occurred. See :ref:`Object.get_instance_id<class_Object_method_get_instance_id>`.
    70. 

  70. 

  71. ----
    72. 

  72. 

  73. .. _class_PhysicsTestMotionResult3D_method_get_collider_rid:
    74. 

  74. 

  75. - :ref:`RID<class_RID>` **get_collider_rid** **(** :ref:`int<class_int>` collision_index=0 **)** |const|
    76. 

  76. 

  77. Returns the colliding body's :ref:`RID<class_RID>` used by the :ref:`PhysicsServer3D<class_PhysicsServer3D>` given a collision index (the deepest collision by default), if a collision occurred.
    78. 

  78. 

  79. ----
    80. 

  80. 

  81. .. _class_PhysicsTestMotionResult3D_method_get_collider_shape:
    82. 

  82. 

  83. - :ref:`int<class_int>` **get_collider_shape** **(** :ref:`int<class_int>` collision_index=0 **)** |const|
    84. 

  84. 

  85. Returns the colliding body's shape index given a collision index (the deepest collision by default), if a collision occurred. See :ref:`CollisionObject3D<class_CollisionObject3D>`.
    86. 

  86. 

  87. ----
    88. 

  88. 

  89. .. _class_PhysicsTestMotionResult3D_method_get_collider_velocity:
    90. 

  90. 

  91. - :ref:`Vector3<class_Vector3>` **get_collider_velocity** **(** :ref:`int<class_int>` collision_index=0 **)** |const|
    92. 

  92. 

  93. Returns the colliding body's velocity given a collision index (the deepest collision by default), if a collision occurred.
    94. 

  94. 

  95. ----
    96. 

  96. 

  97. .. _class_PhysicsTestMotionResult3D_method_get_collision_count:
    98. 

  98. 

  99. - :ref:`int<class_int>` **get_collision_count** **(** **)** |const|
    100. 

  100. 

  101. Returns the number of detected collisions.
    102. 

  102. 

  103. ----
    104. 

  104. 

  105. .. _class_PhysicsTestMotionResult3D_method_get_collision_depth:
    106. 

  106. 

  107. - :ref:`float<class_float>` **get_collision_depth** **(** :ref:`int<class_int>` collision_index=0 **)** |const|
    108. 

  108. 

  109. Returns the length of overlap along the collision normal given a collision index (the deepest collision by default), if a collision occurred.
    110. 

  110. 

  111. ----
    112. 

  112. 

  113. .. _class_PhysicsTestMotionResult3D_method_get_collision_local_shape:
    114. 

  114. 

  115. - :ref:`int<class_int>` **get_collision_local_shape** **(** :ref:`int<class_int>` collision_index=0 **)** |const|
    116. 

  116. 

  117. Returns the moving object's colliding shape given a collision index (the deepest collision by default), if a collision occurred.
    118. 

  118. 

  119. ----
    120. 

  120. 

  121. .. _class_PhysicsTestMotionResult3D_method_get_collision_normal:
    122. 

  122. 

  123. - :ref:`Vector3<class_Vector3>` **get_collision_normal** **(** :ref:`int<class_int>` collision_index=0 **)** |const|
    124. 

  124. 

  125. Returns the colliding body's shape's normal at the point of collision given a collision index (the deepest collision by default), if a collision occurred.
    126. 

  126. 

  127. ----
    128. 

  128. 

  129. .. _class_PhysicsTestMotionResult3D_method_get_collision_point:
    130. 

  130. 

  131. - :ref:`Vector3<class_Vector3>` **get_collision_point** **(** :ref:`int<class_int>` collision_index=0 **)** |const|
    132. 

  132. 

  133. Returns the point of collision in global coordinates given a collision index (the deepest collision by default), if a collision occurred.
    134. 

  134. 

  135. ----
    136. 

  136. 

  137. .. _class_PhysicsTestMotionResult3D_method_get_collision_safe_fraction:
    138. 

  138. 

  139. - :ref:`float<class_float>` **get_collision_safe_fraction** **(** **)** |const|
    140. 

  140. 

  141. Returns the maximum fraction of the motion that can occur without a collision, between ``0`` and ``1``.
    142. 

  142. 

  143. ----
    144. 

  144. 

  145. .. _class_PhysicsTestMotionResult3D_method_get_collision_unsafe_fraction:
    146. 

  146. 

  147. - :ref:`float<class_float>` **get_collision_unsafe_fraction** **(** **)** |const|
    148. 

  148. 

  149. Returns the minimum fraction of the motion needed to collide, if a collision occurred, between ``0`` and ``1``.
    150. 

  150. 

  151. ----
    152. 

  152. 

  153. .. _class_PhysicsTestMotionResult3D_method_get_remainder:
    154. 

  154. 

  155. - :ref:`Vector3<class_Vector3>` **get_remainder** **(** **)** |const|
    156. 

  156. 

  157. Returns the moving object's remaining movement vector.
    158. 

  158. 

  159. ----
    160. 

  160. 

  161. .. _class_PhysicsTestMotionResult3D_method_get_travel:
    162. 

  162. 

  163. - :ref:`Vector3<class_Vector3>` **get_travel** **(** **)** |const|
    164. 

  164. 

  165. Returns the moving object's travel before collision.
    166. 

  166. 

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

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

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

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

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

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