Página Principal Explorar Ajuda
Iniciar Sessão
Godot
/
godot-docs
mirror de https://github.com/godotengine/godot-docs.git
2
0
Fork 0
Ficheiros Problemas 0 Wiki
Árvore: 2be4e9b938
Ramos Etiquetas
godot-docs
/
classes
/
class_physicstestmotionresult3d.rst

class_physicstestmotionresult3d.rst 11 KB
Histórico Em bruto

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173 
  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/PhysicsTestMotionResult3D.xml.
    7. 

  7. 

  8. .. _class_PhysicsTestMotionResult3D:
    9. 

  9. 

  10. PhysicsTestMotionResult3D
    11. 

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

  12. 

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

  14. 

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

  16. 

  17. Description
    18. 

  18. -----------
    19. 

  19. 

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

  21. 

  22. Methods
    23. 

  23. -------
    24. 

  24. 

  25. +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
    26. 

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

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

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

  29. +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
    30. 

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  54. 

  55. Method Descriptions
    56. 

  56. -------------------
    57. 

  57. 

  58. .. _class_PhysicsTestMotionResult3D_method_get_collider:
    59. 

  59. 

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

  61. 

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

  63. 

  64. ----
    65. 

  65. 

  66. .. _class_PhysicsTestMotionResult3D_method_get_collider_id:
    67. 

  67. 

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

  69. 

  70. 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>`.
    71. 

  71. 

  72. ----
    73. 

  73. 

  74. .. _class_PhysicsTestMotionResult3D_method_get_collider_rid:
    75. 

  75. 

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

  77. 

  78. 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.
    79. 

  79. 

  80. ----
    81. 

  81. 

  82. .. _class_PhysicsTestMotionResult3D_method_get_collider_shape:
    83. 

  83. 

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

  85. 

  86. 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>`.
    87. 

  87. 

  88. ----
    89. 

  89. 

  90. .. _class_PhysicsTestMotionResult3D_method_get_collider_velocity:
    91. 

  91. 

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

  93. 

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

  95. 

  96. ----
    97. 

  97. 

  98. .. _class_PhysicsTestMotionResult3D_method_get_collision_count:
    99. 

  99. 

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

  101. 

  102. Returns the number of detected collisions.
    103. 

  103. 

  104. ----
    105. 

  105. 

  106. .. _class_PhysicsTestMotionResult3D_method_get_collision_depth:
    107. 

  107. 

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

  109. 

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

  111. 

  112. ----
    113. 

  113. 

  114. .. _class_PhysicsTestMotionResult3D_method_get_collision_local_shape:
    115. 

  115. 

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

  117. 

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

  119. 

  120. ----
    121. 

  121. 

  122. .. _class_PhysicsTestMotionResult3D_method_get_collision_normal:
    123. 

  123. 

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

  125. 

  126. 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.
    127. 

  127. 

  128. ----
    129. 

  129. 

  130. .. _class_PhysicsTestMotionResult3D_method_get_collision_point:
    131. 

  131. 

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

  133. 

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

  135. 

  136. ----
    137. 

  137. 

  138. .. _class_PhysicsTestMotionResult3D_method_get_collision_safe_fraction:
    139. 

  139. 

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

  141. 

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

  143. 

  144. ----
    145. 

  145. 

  146. .. _class_PhysicsTestMotionResult3D_method_get_collision_unsafe_fraction:
    147. 

  147. 

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

  149. 

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

  151. 

  152. ----
    153. 

  153. 

  154. .. _class_PhysicsTestMotionResult3D_method_get_remainder:
    155. 

  155. 

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

  157. 

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

  159. 

  160. ----
    161. 

  161. 

  162. .. _class_PhysicsTestMotionResult3D_method_get_travel:
    163. 

  163. 

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

  165. 

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

  167. 

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

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

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

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

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

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