Strona główna Odkrywaj Pomoc
Zaloguj się
Godot
/
godot-docs
kopia lustrzana https://github.com/godotengine/godot-docs.git
2
0
Forkuj 0
Pliki Problemy 0 Wiki
Drzewo: 0cc4b36524
Gałęzie Tagi
godot-docs
/
classes
/
class_collisionobject.rst

class_collisionobject.rst 19 KB
Historia Czysty

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

  2. .. DO NOT EDIT THIS FILE, but the CollisionObject.xml source instead.
    3. 

  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
    4. 

  4. 

  5. .. _class_CollisionObject:
    6. 

  6. 

  7. CollisionObject
    8. 

  8. ===============
    9. 

  9. 

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

  11. 

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

  13. 

  14. **Category:** Core
    15. 

  15. 

  16. Brief Description
    17. 

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

  18. 

  19. 

  20. 

  21. Member Functions
    22. 

  22. ----------------
    23. 

  23. 

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

  25. | void                               | :ref:`_input_event<class_CollisionObject__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 |
    26. 

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  53. | :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                                                                                                                           |
    54. 

  54. +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    55. 

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

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

  57. | :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                                                                                                               |
    58. 

  58. +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    59. 

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

  60. +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    61. 

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

  62. +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    63. 

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

  64. +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    65. 

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

  66. +------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    67. 

  67. 

  68. Signals
    69. 

  69. -------
    70. 

  70. 

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

  72. -  **mouse_entered**  **(** **)**
    73. 

  73. -  **mouse_exited**  **(** **)**
    74. 

  74. 

  75. Member Variables
    76. 

  76. ----------------
    77. 

  77. 

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

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

  80. 

  81. Member Function Description
    82. 

  82. ---------------------------
    83. 

  83. 

  84. .. _class_CollisionObject__input_event:
    85. 

  85. 

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

  87. 

  88. .. _class_CollisionObject_create_shape_owner:
    89. 

  89. 

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

  91. 

  92. 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.
    93. 

  93. 

  94. .. _class_CollisionObject_get_capture_input_on_drag:
    95. 

  95. 

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

  97. 

  98. .. _class_CollisionObject_get_rid:
    99. 

  99. 

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

  101. 

  102. .. _class_CollisionObject_get_shape_owners:
    103. 

  103. 

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

  105. 

  106. 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.
    107. 

  107. 

  108. .. _class_CollisionObject_is_ray_pickable:
    109. 

  109. 

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

  111. 

  112. .. _class_CollisionObject_is_shape_owner_disabled:
    113. 

  113. 

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

  115. 

  116. .. _class_CollisionObject_remove_shape_owner:
    117. 

  117. 

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

  119. 

  120. .. _class_CollisionObject_set_capture_input_on_drag:
    121. 

  121. 

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

  123. 

  124. .. _class_CollisionObject_set_ray_pickable:
    125. 

  125. 

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

  127. 

  128. .. _class_CollisionObject_shape_find_owner:
    129. 

  129. 

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

  131. 

  132. .. _class_CollisionObject_shape_owner_add_shape:
    133. 

  133. 

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

  135. 

  136. .. _class_CollisionObject_shape_owner_clear_shapes:
    137. 

  137. 

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

  139. 

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

  141. 

  142. .. _class_CollisionObject_shape_owner_get_owner:
    143. 

  143. 

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

  145. 

  146. .. _class_CollisionObject_shape_owner_get_shape:
    147. 

  147. 

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

  149. 

  150. 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>`.
    151. 

  151. 

  152. .. _class_CollisionObject_shape_owner_get_shape_count:
    153. 

  153. 

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

  155. 

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

  157. 

  158. .. _class_CollisionObject_shape_owner_get_shape_index:
    159. 

  159. 

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

  161. 

  162. .. _class_CollisionObject_shape_owner_get_transform:
    163. 

  163. 

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

  165. 

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

  167. 

  168. .. _class_CollisionObject_shape_owner_remove_shape:
    169. 

  169. 

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

  171. 

  172. Removes related shape from the owner.
    173. 

  173. 

  174. .. _class_CollisionObject_shape_owner_set_disabled:
    175. 

  175. 

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

  177. 

  178. .. _class_CollisionObject_shape_owner_set_transform:
    179. 

  179. 

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

  181. 

  182.