class_collisionobject.rst 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  3. .. DO NOT EDIT THIS FILE, but the CollisionObject.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_CollisionObject:
  6. CollisionObject
  7. ===============
  8. **Inherits:** :ref:`Spatial<class_Spatial>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
  9. **Inherited By:** :ref:`Area<class_Area>`, :ref:`PhysicsBody<class_PhysicsBody>`
  10. Base node for collision objects.
  11. Description
  12. -----------
  13. CollisionObject is the base class for physics objects. It can hold any number of collision :ref:`Shape<class_Shape>`\ s. Each shape must be assigned to a *shape owner*. The CollisionObject can have any number of shape owners. Shape owners are not nodes and do not appear in the editor, but are accessible through code using the ``shape_owner_*`` methods.
  14. Properties
  15. ----------
  16. +-------------------------+------------------------------------------------------------------------------------+-----------+
  17. | :ref:`bool<class_bool>` | :ref:`input_capture_on_drag<class_CollisionObject_property_input_capture_on_drag>` | ``false`` |
  18. +-------------------------+------------------------------------------------------------------------------------+-----------+
  19. | :ref:`bool<class_bool>` | :ref:`input_ray_pickable<class_CollisionObject_property_input_ray_pickable>` | ``true`` |
  20. +-------------------------+------------------------------------------------------------------------------------+-----------+
  21. Methods
  22. -------
  23. +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  24. | void | :ref:`_input_event<class_CollisionObject_method__input_event>` **(** :ref:`Object<class_Object>` camera, :ref:`InputEvent<class_InputEvent>` event, :ref:`Vector3<class_Vector3>` click_position, :ref:`Vector3<class_Vector3>` click_normal, :ref:`int<class_int>` shape_idx **)** |virtual| |
  25. +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  26. | :ref:`int<class_int>` | :ref:`create_shape_owner<class_CollisionObject_method_create_shape_owner>` **(** :ref:`Object<class_Object>` owner **)** |
  27. +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  28. | :ref:`RID<class_RID>` | :ref:`get_rid<class_CollisionObject_method_get_rid>` **(** **)** |const| |
  29. +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  30. | :ref:`Array<class_Array>` | :ref:`get_shape_owners<class_CollisionObject_method_get_shape_owners>` **(** **)** |
  31. +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  32. | :ref:`bool<class_bool>` | :ref:`is_shape_owner_disabled<class_CollisionObject_method_is_shape_owner_disabled>` **(** :ref:`int<class_int>` owner_id **)** |const| |
  33. +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  34. | void | :ref:`remove_shape_owner<class_CollisionObject_method_remove_shape_owner>` **(** :ref:`int<class_int>` owner_id **)** |
  35. +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  36. | :ref:`int<class_int>` | :ref:`shape_find_owner<class_CollisionObject_method_shape_find_owner>` **(** :ref:`int<class_int>` shape_index **)** |const| |
  37. +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  38. | void | :ref:`shape_owner_add_shape<class_CollisionObject_method_shape_owner_add_shape>` **(** :ref:`int<class_int>` owner_id, :ref:`Shape<class_Shape>` shape **)** |
  39. +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  40. | void | :ref:`shape_owner_clear_shapes<class_CollisionObject_method_shape_owner_clear_shapes>` **(** :ref:`int<class_int>` owner_id **)** |
  41. +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  42. | :ref:`Object<class_Object>` | :ref:`shape_owner_get_owner<class_CollisionObject_method_shape_owner_get_owner>` **(** :ref:`int<class_int>` owner_id **)** |const| |
  43. +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  44. | :ref:`Shape<class_Shape>` | :ref:`shape_owner_get_shape<class_CollisionObject_method_shape_owner_get_shape>` **(** :ref:`int<class_int>` owner_id, :ref:`int<class_int>` shape_id **)** |const| |
  45. +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  46. | :ref:`int<class_int>` | :ref:`shape_owner_get_shape_count<class_CollisionObject_method_shape_owner_get_shape_count>` **(** :ref:`int<class_int>` owner_id **)** |const| |
  47. +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  48. | :ref:`int<class_int>` | :ref:`shape_owner_get_shape_index<class_CollisionObject_method_shape_owner_get_shape_index>` **(** :ref:`int<class_int>` owner_id, :ref:`int<class_int>` shape_id **)** |const| |
  49. +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  50. | :ref:`Transform<class_Transform>` | :ref:`shape_owner_get_transform<class_CollisionObject_method_shape_owner_get_transform>` **(** :ref:`int<class_int>` owner_id **)** |const| |
  51. +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  52. | void | :ref:`shape_owner_remove_shape<class_CollisionObject_method_shape_owner_remove_shape>` **(** :ref:`int<class_int>` owner_id, :ref:`int<class_int>` shape_id **)** |
  53. +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  54. | void | :ref:`shape_owner_set_disabled<class_CollisionObject_method_shape_owner_set_disabled>` **(** :ref:`int<class_int>` owner_id, :ref:`bool<class_bool>` disabled **)** |
  55. +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  56. | void | :ref:`shape_owner_set_transform<class_CollisionObject_method_shape_owner_set_transform>` **(** :ref:`int<class_int>` owner_id, :ref:`Transform<class_Transform>` transform **)** |
  57. +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  58. Signals
  59. -------
  60. .. _class_CollisionObject_signal_input_event:
  61. - **input_event** **(** :ref:`Node<class_Node>` camera, :ref:`InputEvent<class_InputEvent>` event, :ref:`Vector3<class_Vector3>` click_position, :ref:`Vector3<class_Vector3>` click_normal, :ref:`int<class_int>` shape_idx **)**
  62. Emitted when :ref:`_input_event<class_CollisionObject_method__input_event>` receives an event. See its description for details.
  63. ----
  64. .. _class_CollisionObject_signal_mouse_entered:
  65. - **mouse_entered** **(** **)**
  66. Emitted when the mouse pointer enters any of this object's shapes.
  67. ----
  68. .. _class_CollisionObject_signal_mouse_exited:
  69. - **mouse_exited** **(** **)**
  70. Emitted when the mouse pointer exits all this object's shapes.
  71. Property Descriptions
  72. ---------------------
  73. .. _class_CollisionObject_property_input_capture_on_drag:
  74. - :ref:`bool<class_bool>` **input_capture_on_drag**
  75. +-----------+----------------------------------+
  76. | *Default* | ``false`` |
  77. +-----------+----------------------------------+
  78. | *Setter* | set_capture_input_on_drag(value) |
  79. +-----------+----------------------------------+
  80. | *Getter* | get_capture_input_on_drag() |
  81. +-----------+----------------------------------+
  82. If ``true``, the ``CollisionObject`` will continue to receive input events as the mouse is dragged across its shapes.
  83. ----
  84. .. _class_CollisionObject_property_input_ray_pickable:
  85. - :ref:`bool<class_bool>` **input_ray_pickable**
  86. +-----------+-------------------------+
  87. | *Default* | ``true`` |
  88. +-----------+-------------------------+
  89. | *Setter* | set_ray_pickable(value) |
  90. +-----------+-------------------------+
  91. | *Getter* | is_ray_pickable() |
  92. +-----------+-------------------------+
  93. If ``true``, the ``CollisionObject``'s shapes will respond to :ref:`RayCast<class_RayCast>`\ s.
  94. Method Descriptions
  95. -------------------
  96. .. _class_CollisionObject_method__input_event:
  97. - void **_input_event** **(** :ref:`Object<class_Object>` camera, :ref:`InputEvent<class_InputEvent>` event, :ref:`Vector3<class_Vector3>` click_position, :ref:`Vector3<class_Vector3>` click_normal, :ref:`int<class_int>` shape_idx **)** |virtual|
  98. Accepts unhandled :ref:`InputEvent<class_InputEvent>`\ s. ``click_position`` is the clicked location in world space and ``click_normal`` is the normal vector extending from the clicked surface of the :ref:`Shape<class_Shape>` at ``shape_idx``. Connect to the ``input_event`` signal to easily pick up these events.
  99. ----
  100. .. _class_CollisionObject_method_create_shape_owner:
  101. - :ref:`int<class_int>` **create_shape_owner** **(** :ref:`Object<class_Object>` owner **)**
  102. Creates a new shape owner for the given object. Returns ``owner_id`` of the new owner for future reference.
  103. ----
  104. .. _class_CollisionObject_method_get_rid:
  105. - :ref:`RID<class_RID>` **get_rid** **(** **)** |const|
  106. Returns the object's :ref:`RID<class_RID>`.
  107. ----
  108. .. _class_CollisionObject_method_get_shape_owners:
  109. - :ref:`Array<class_Array>` **get_shape_owners** **(** **)**
  110. Returns an :ref:`Array<class_Array>` of ``owner_id`` identifiers. You can use these ids in other methods that take ``owner_id`` as an argument.
  111. ----
  112. .. _class_CollisionObject_method_is_shape_owner_disabled:
  113. - :ref:`bool<class_bool>` **is_shape_owner_disabled** **(** :ref:`int<class_int>` owner_id **)** |const|
  114. If ``true``, the shape owner and its shapes are disabled.
  115. ----
  116. .. _class_CollisionObject_method_remove_shape_owner:
  117. - void **remove_shape_owner** **(** :ref:`int<class_int>` owner_id **)**
  118. Removes the given shape owner.
  119. ----
  120. .. _class_CollisionObject_method_shape_find_owner:
  121. - :ref:`int<class_int>` **shape_find_owner** **(** :ref:`int<class_int>` shape_index **)** |const|
  122. Returns the ``owner_id`` of the given shape.
  123. ----
  124. .. _class_CollisionObject_method_shape_owner_add_shape:
  125. - void **shape_owner_add_shape** **(** :ref:`int<class_int>` owner_id, :ref:`Shape<class_Shape>` shape **)**
  126. Adds a :ref:`Shape<class_Shape>` to the shape owner.
  127. ----
  128. .. _class_CollisionObject_method_shape_owner_clear_shapes:
  129. - void **shape_owner_clear_shapes** **(** :ref:`int<class_int>` owner_id **)**
  130. Removes all shapes from the shape owner.
  131. ----
  132. .. _class_CollisionObject_method_shape_owner_get_owner:
  133. - :ref:`Object<class_Object>` **shape_owner_get_owner** **(** :ref:`int<class_int>` owner_id **)** |const|
  134. Returns the parent object of the given shape owner.
  135. ----
  136. .. _class_CollisionObject_method_shape_owner_get_shape:
  137. - :ref:`Shape<class_Shape>` **shape_owner_get_shape** **(** :ref:`int<class_int>` owner_id, :ref:`int<class_int>` shape_id **)** |const|
  138. Returns the :ref:`Shape<class_Shape>` with the given id from the given shape owner.
  139. ----
  140. .. _class_CollisionObject_method_shape_owner_get_shape_count:
  141. - :ref:`int<class_int>` **shape_owner_get_shape_count** **(** :ref:`int<class_int>` owner_id **)** |const|
  142. Returns the number of shapes the given shape owner contains.
  143. ----
  144. .. _class_CollisionObject_method_shape_owner_get_shape_index:
  145. - :ref:`int<class_int>` **shape_owner_get_shape_index** **(** :ref:`int<class_int>` owner_id, :ref:`int<class_int>` shape_id **)** |const|
  146. Returns the child index of the :ref:`Shape<class_Shape>` with the given id from the given shape owner.
  147. ----
  148. .. _class_CollisionObject_method_shape_owner_get_transform:
  149. - :ref:`Transform<class_Transform>` **shape_owner_get_transform** **(** :ref:`int<class_int>` owner_id **)** |const|
  150. Returns the shape owner's :ref:`Transform<class_Transform>`.
  151. ----
  152. .. _class_CollisionObject_method_shape_owner_remove_shape:
  153. - void **shape_owner_remove_shape** **(** :ref:`int<class_int>` owner_id, :ref:`int<class_int>` shape_id **)**
  154. Removes a shape from the given shape owner.
  155. ----
  156. .. _class_CollisionObject_method_shape_owner_set_disabled:
  157. - void **shape_owner_set_disabled** **(** :ref:`int<class_int>` owner_id, :ref:`bool<class_bool>` disabled **)**
  158. If ``true``, disables the given shape owner.
  159. ----
  160. .. _class_CollisionObject_method_shape_owner_set_transform:
  161. - void **shape_owner_set_transform** **(** :ref:`int<class_int>` owner_id, :ref:`Transform<class_Transform>` transform **)**
  162. Sets the :ref:`Transform<class_Transform>` of the given shape owner.
  163. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  164. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  165. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`