Inicio Explorar Axuda
Iniciar sesión
Godot
/
godot-docs
réplica de https://github.com/godotengine/godot-docs.git
2
0
Fork 0
Ficheiros Incidencias 0 Wiki
Árbore: 40cb5153bd
Ramas Etiquetas
godot-docs
/
classes
/
class_collisionobject.rst

class_collisionobject.rst 18 KB
Histórico Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181 
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
    2. 

  2. .. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
    3. 

  3. 

  4. .. _class_CollisionObject:
    5. 

  5. 

  6. CollisionObject
    7. 

  7. ===============
    8. 

  8. 

  9. **Inherits:** :ref:`Spatial<class_spatial>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
    10. 

  10. 

  11. **Inherited By:** :ref:`PhysicsBody<class_physicsbody>`, :ref:`Area<class_area>`
    12. 

  12. 

  13. **Category:** Core
    14. 

  14. 

  15. Brief Description
    16. 

  16. -----------------
    17. 

  17. 

  18. 

  19. 

  20. Member Functions
    21. 

  21. ----------------
    22. 

  22. 

  23. +------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    24. 

  24. | void                               | :ref:`_input_event<class_CollisionObject__input_event>`  **(** :ref:`Object<class_object>` camera, :ref:`InputEvent<class_inputevent>` event, :ref:`Vector3<class_vector3>` click_pos, :ref:`Vector3<class_vector3>` click_normal, :ref:`int<class_int>` shape_idx  **)** virtual |
    25. 

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

  26. | :ref:`int<class_int>`              | :ref:`create_shape_owner<class_CollisionObject_create_shape_owner>`  **(** :ref:`Object<class_object>` owner  **)**                                                                                                                                                               |
    27. 

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

  28. | :ref:`bool<class_bool>`            | :ref:`get_capture_input_on_drag<class_CollisionObject_get_capture_input_on_drag>`  **(** **)** const                                                                                                                                                                              |
    29. 

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

  30. | :ref:`RID<class_rid>`              | :ref:`get_rid<class_CollisionObject_get_rid>`  **(** **)** const                                                                                                                                                                                                                  |
    31. 

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

  32. | :ref:`Array<class_array>`          | :ref:`get_shape_owners<class_CollisionObject_get_shape_owners>`  **(** **)**                                                                                                                                                                                                      |
    33. 

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

  34. | :ref:`bool<class_bool>`            | :ref:`is_ray_pickable<class_CollisionObject_is_ray_pickable>`  **(** **)** const                                                                                                                                                                                                  |
    35. 

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

  36. | :ref:`bool<class_bool>`            | :ref:`is_shape_owner_disabled<class_CollisionObject_is_shape_owner_disabled>`  **(** :ref:`int<class_int>` owner_id  **)** const                                                                                                                                                  |
    37. 

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

  38. | void                               | :ref:`remove_shape_owner<class_CollisionObject_remove_shape_owner>`  **(** :ref:`int<class_int>` owner_id  **)**                                                                                                                                                                  |
    39. 

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

  40. | void                               | :ref:`set_capture_input_on_drag<class_CollisionObject_set_capture_input_on_drag>`  **(** :ref:`bool<class_bool>` enable  **)**                                                                                                                                                    |
    41. 

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

  42. | void                               | :ref:`set_ray_pickable<class_CollisionObject_set_ray_pickable>`  **(** :ref:`bool<class_bool>` ray_pickable  **)**                                                                                                                                                                |
    43. 

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

  44. | :ref:`int<class_int>`              | :ref:`shape_find_owner<class_CollisionObject_shape_find_owner>`  **(** :ref:`int<class_int>` shape_index  **)** const                                                                                                                                                             |
    45. 

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

  46. | void                               | :ref:`shape_owner_add_shape<class_CollisionObject_shape_owner_add_shape>`  **(** :ref:`int<class_int>` owner_id, :ref:`Shape<class_shape>` shape  **)**                                                                                                                           |
    47. 

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

  48. | void                               | :ref:`shape_owner_clear_shapes<class_CollisionObject_shape_owner_clear_shapes>`  **(** :ref:`int<class_int>` owner_id  **)**                                                                                                                                                      |
    49. 

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

  50. | :ref:`Object<class_object>`        | :ref:`shape_owner_get_owner<class_CollisionObject_shape_owner_get_owner>`  **(** :ref:`int<class_int>` owner_id  **)** const                                                                                                                                                      |
    51. 

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

  52. | :ref:`Shape<class_shape>`          | :ref:`shape_owner_get_shape<class_CollisionObject_shape_owner_get_shape>`  **(** :ref:`int<class_int>` owner_id, :ref:`int<class_int>` shape_id  **)** const                                                                                                                      |
    53. 

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

  54. | :ref:`int<class_int>`              | :ref:`shape_owner_get_shape_count<class_CollisionObject_shape_owner_get_shape_count>`  **(** :ref:`int<class_int>` owner_id  **)** const                                                                                                                                          |
    55. 

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

  56. | :ref:`int<class_int>`              | :ref:`shape_owner_get_shape_index<class_CollisionObject_shape_owner_get_shape_index>`  **(** :ref:`int<class_int>` owner_id, :ref:`int<class_int>` shape_id  **)** const                                                                                                          |
    57. 

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

  58. | :ref:`Transform<class_transform>`  | :ref:`shape_owner_get_transform<class_CollisionObject_shape_owner_get_transform>`  **(** :ref:`int<class_int>` owner_id  **)** const                                                                                                                                              |
    59. 

  59. +------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    60. 

  60. | void                               | :ref:`shape_owner_remove_shape<class_CollisionObject_shape_owner_remove_shape>`  **(** :ref:`int<class_int>` owner_id, :ref:`int<class_int>` shape_id  **)**                                                                                                                      |
    61. 

  61. +------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    62. 

  62. | void                               | :ref:`shape_owner_set_disabled<class_CollisionObject_shape_owner_set_disabled>`  **(** :ref:`int<class_int>` owner_id, :ref:`bool<class_bool>` disabled  **)**                                                                                                                    |
    63. 

  63. +------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    64. 

  64. | void                               | :ref:`shape_owner_set_transform<class_CollisionObject_shape_owner_set_transform>`  **(** :ref:`int<class_int>` owner_id, :ref:`Transform<class_transform>` transform  **)**                                                                                                       |
    65. 

  65. +------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    66. 

  66. 

  67. Signals
    68. 

  68. -------
    69. 

  69. 

  70. -  **input_event**  **(** :ref:`Object<class_object>` camera, :ref:`Object<class_object>` event, :ref:`Vector3<class_vector3>` click_pos, :ref:`Vector3<class_vector3>` click_normal, :ref:`int<class_int>` shape_idx  **)**
    71. 

  71. -  **mouse_entered**  **(** **)**
    72. 

  72. -  **mouse_exited**  **(** **)**
    73. 

  73. 

  74. Member Variables
    75. 

  75. ----------------
    76. 

  76. 

  77. - :ref:`bool<class_bool>` **input_capture_on_drag**
    78. 

  78. - :ref:`bool<class_bool>` **input_ray_pickable**
    79. 

  79. 

  80. Member Function Description
    81. 

  81. ---------------------------
    82. 

  82. 

  83. .. _class_CollisionObject__input_event:
    84. 

  84. 

  85. - void  **_input_event**  **(** :ref:`Object<class_object>` camera, :ref:`InputEvent<class_inputevent>` event, :ref:`Vector3<class_vector3>` click_pos, :ref:`Vector3<class_vector3>` click_normal, :ref:`int<class_int>` shape_idx  **)** virtual
    86. 

  86. 

  87. .. _class_CollisionObject_create_shape_owner:
    88. 

  88. 

  89. - :ref:`int<class_int>`  **create_shape_owner**  **(** :ref:`Object<class_object>` owner  **)**
    90. 

  90. 

  91. Creates new holder for the shapes. Argument is a :ref:`CollisionShape<class_collisionshape>` node. It will return owner_id which usually you will want to save for later use.
    92. 

  92. 

  93. .. _class_CollisionObject_get_capture_input_on_drag:
    94. 

  94. 

  95. - :ref:`bool<class_bool>`  **get_capture_input_on_drag**  **(** **)** const
    96. 

  96. 

  97. .. _class_CollisionObject_get_rid:
    98. 

  98. 

  99. - :ref:`RID<class_rid>`  **get_rid**  **(** **)** const
    100. 

  100. 

  101. .. _class_CollisionObject_get_shape_owners:
    102. 

  102. 

  103. - :ref:`Array<class_array>`  **get_shape_owners**  **(** **)**
    104. 

  104. 

  105. Shape owner is a node which is holding concrete shape resources. This method will return an array which is holding an integer numbers that are representing unique ID of each owner. You can use those ids when you are using others shape_owner methods.
    106. 

  106. 

  107. .. _class_CollisionObject_is_ray_pickable:
    108. 

  108. 

  109. - :ref:`bool<class_bool>`  **is_ray_pickable**  **(** **)** const
    110. 

  110. 

  111. .. _class_CollisionObject_is_shape_owner_disabled:
    112. 

  112. 

  113. - :ref:`bool<class_bool>`  **is_shape_owner_disabled**  **(** :ref:`int<class_int>` owner_id  **)** const
    114. 

  114. 

  115. .. _class_CollisionObject_remove_shape_owner:
    116. 

  116. 

  117. - void  **remove_shape_owner**  **(** :ref:`int<class_int>` owner_id  **)**
    118. 

  118. 

  119. .. _class_CollisionObject_set_capture_input_on_drag:
    120. 

  120. 

  121. - void  **set_capture_input_on_drag**  **(** :ref:`bool<class_bool>` enable  **)**
    122. 

  122. 

  123. .. _class_CollisionObject_set_ray_pickable:
    124. 

  124. 

  125. - void  **set_ray_pickable**  **(** :ref:`bool<class_bool>` ray_pickable  **)**
    126. 

  126. 

  127. .. _class_CollisionObject_shape_find_owner:
    128. 

  128. 

  129. - :ref:`int<class_int>`  **shape_find_owner**  **(** :ref:`int<class_int>` shape_index  **)** const
    130. 

  130. 

  131. .. _class_CollisionObject_shape_owner_add_shape:
    132. 

  132. 

  133. - void  **shape_owner_add_shape**  **(** :ref:`int<class_int>` owner_id, :ref:`Shape<class_shape>` shape  **)**
    134. 

  134. 

  135. .. _class_CollisionObject_shape_owner_clear_shapes:
    136. 

  136. 

  137. - void  **shape_owner_clear_shapes**  **(** :ref:`int<class_int>` owner_id  **)**
    138. 

  138. 

  139. Will remove all the shapes associated with given owner.
    140. 

  140. 

  141. .. _class_CollisionObject_shape_owner_get_owner:
    142. 

  142. 

  143. - :ref:`Object<class_object>`  **shape_owner_get_owner**  **(** :ref:`int<class_int>` owner_id  **)** const
    144. 

  144. 

  145. .. _class_CollisionObject_shape_owner_get_shape:
    146. 

  146. 

  147. - :ref:`Shape<class_shape>`  **shape_owner_get_shape**  **(** :ref:`int<class_int>` owner_id, :ref:`int<class_int>` shape_id  **)** const
    148. 

  148. 

  149. Will return a :ref:`Shape<class_shape>`. First argument owner_id is an integer that can be obtained from :ref:`get_shape_owners<class_CollisionObject_get_shape_owners>`. Shape_id is a position of the shape inside owner; it's a value in range from 0 to :ref:`shape_owner_get_shape_count<class_CollisionObject_shape_owner_get_shape_count>`.
    150. 

  150. 

  151. .. _class_CollisionObject_shape_owner_get_shape_count:
    152. 

  152. 

  153. - :ref:`int<class_int>`  **shape_owner_get_shape_count**  **(** :ref:`int<class_int>` owner_id  **)** const
    154. 

  154. 

  155. Returns number of shapes to which given owner is associated to.
    156. 

  156. 

  157. .. _class_CollisionObject_shape_owner_get_shape_index:
    158. 

  158. 

  159. - :ref:`int<class_int>`  **shape_owner_get_shape_index**  **(** :ref:`int<class_int>` owner_id, :ref:`int<class_int>` shape_id  **)** const
    160. 

  160. 

  161. .. _class_CollisionObject_shape_owner_get_transform:
    162. 

  162. 

  163. - :ref:`Transform<class_transform>`  **shape_owner_get_transform**  **(** :ref:`int<class_int>` owner_id  **)** const
    164. 

  164. 

  165. Will return :ref:`Transform<class_transform>` of an owner node.
    166. 

  166. 

  167. .. _class_CollisionObject_shape_owner_remove_shape:
    168. 

  168. 

  169. - void  **shape_owner_remove_shape**  **(** :ref:`int<class_int>` owner_id, :ref:`int<class_int>` shape_id  **)**
    170. 

  170. 

  171. Removes related shape from the owner.
    172. 

  172. 

  173. .. _class_CollisionObject_shape_owner_set_disabled:
    174. 

  174. 

  175. - void  **shape_owner_set_disabled**  **(** :ref:`int<class_int>` owner_id, :ref:`bool<class_bool>` disabled  **)**
    176. 

  176. 

  177. .. _class_CollisionObject_shape_owner_set_transform:
    178. 

  178. 

  179. - void  **shape_owner_set_transform**  **(** :ref:`int<class_int>` owner_id, :ref:`Transform<class_transform>` transform  **)**
    180. 

  180. 

  181.