Home Explore Help
Sign In
godotengine
/
godot-docs
mirror of https://github.com/godotengine/godot-docs
Watch 1
Star 1
Fork 0
Files
Tree: 7a86ac6a30
Branches Tags
godot-docs
/
classes
/
class_skeleton.rst

class_skeleton.rst 25 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333 
  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 Skeleton.xml source instead.
    5. 

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

  6. 

  7. .. _class_Skeleton:
    8. 

  8. 

  9. Skeleton
    10. 

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

  11. 

  12. **Inherits:** :ref:`Spatial<class_Spatial>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
    13. 

  13. 

  14. Skeleton for characters and animated objects.
    15. 

  15. 

  16. Description
    17. 

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

  18. 

  19. Skeleton provides a hierarchical interface for managing bones, including pose, rest and animation (see :ref:`Animation<class_Animation>`). It can also use ragdoll physics.
    20. 

  20. 

  21. The overall transform of a bone with respect to the skeleton is determined by the following hierarchical order: rest pose, custom pose and pose.
    22. 

  22. 

  23. Note that "global pose" below refers to the overall transform of the bone with respect to skeleton, so it not the actual global/world transform of the bone.
    24. 

  24. 

  25. Tutorials
    26. 

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

  27. 

  28. - `3D Inverse Kinematics Demo <https://godotengine.org/asset-library/asset/523>`__
    29. 

  29. 

  30. - `Third Person Shooter Demo <https://godotengine.org/asset-library/asset/678>`__
    31. 

  31. 

  32. Methods
    33. 

  33. -------
    34. 

  34. 

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

  36. | void                                      | :ref:`add_bone<class_Skeleton_method_add_bone>` **(** :ref:`String<class_String>` name **)**                                                                                                                                                             |
    37. 

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

  38. | void                                      | :ref:`bind_child_node_to_bone<class_Skeleton_method_bind_child_node_to_bone>` **(** :ref:`int<class_int>` bone_idx, :ref:`Node<class_Node>` node **)**                                                                                                   |
    39. 

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

  40. | void                                      | :ref:`clear_bones<class_Skeleton_method_clear_bones>` **(** **)**                                                                                                                                                                                        |
    41. 

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

  42. | void                                      | :ref:`clear_bones_global_pose_override<class_Skeleton_method_clear_bones_global_pose_override>` **(** **)**                                                                                                                                              |
    43. 

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

  44. | :ref:`int<class_int>`                     | :ref:`find_bone<class_Skeleton_method_find_bone>` **(** :ref:`String<class_String>` name **)** |const|                                                                                                                                                   |
    45. 

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

  46. | :ref:`int<class_int>`                     | :ref:`get_bone_count<class_Skeleton_method_get_bone_count>` **(** **)** |const|                                                                                                                                                                          |
    47. 

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

  48. | :ref:`Transform<class_Transform>`         | :ref:`get_bone_custom_pose<class_Skeleton_method_get_bone_custom_pose>` **(** :ref:`int<class_int>` bone_idx **)** |const|                                                                                                                               |
    49. 

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

  50. | :ref:`Transform<class_Transform>`         | :ref:`get_bone_global_pose<class_Skeleton_method_get_bone_global_pose>` **(** :ref:`int<class_int>` bone_idx **)** |const|                                                                                                                               |
    51. 

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

  52. | :ref:`Transform<class_Transform>`         | :ref:`get_bone_global_pose_no_override<class_Skeleton_method_get_bone_global_pose_no_override>` **(** :ref:`int<class_int>` bone_idx **)** |const|                                                                                                       |
    53. 

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

  54. | :ref:`String<class_String>`               | :ref:`get_bone_name<class_Skeleton_method_get_bone_name>` **(** :ref:`int<class_int>` bone_idx **)** |const|                                                                                                                                             |
    55. 

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

  56. | :ref:`int<class_int>`                     | :ref:`get_bone_parent<class_Skeleton_method_get_bone_parent>` **(** :ref:`int<class_int>` bone_idx **)** |const|                                                                                                                                         |
    57. 

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

  58. | :ref:`Transform<class_Transform>`         | :ref:`get_bone_pose<class_Skeleton_method_get_bone_pose>` **(** :ref:`int<class_int>` bone_idx **)** |const|                                                                                                                                             |
    59. 

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

  60. | :ref:`Transform<class_Transform>`         | :ref:`get_bone_rest<class_Skeleton_method_get_bone_rest>` **(** :ref:`int<class_int>` bone_idx **)** |const|                                                                                                                                             |
    61. 

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

  62. | :ref:`Array<class_Array>`                 | :ref:`get_bound_child_nodes_to_bone<class_Skeleton_method_get_bound_child_nodes_to_bone>` **(** :ref:`int<class_int>` bone_idx **)** |const|                                                                                                             |
    63. 

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

  64. | :ref:`bool<class_bool>`                   | :ref:`is_bone_rest_disabled<class_Skeleton_method_is_bone_rest_disabled>` **(** :ref:`int<class_int>` bone_idx **)** |const|                                                                                                                             |
    65. 

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

  66. | void                                      | :ref:`localize_rests<class_Skeleton_method_localize_rests>` **(** **)**                                                                                                                                                                                  |
    67. 

  67. +-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    68. 

  68. | void                                      | :ref:`physical_bones_add_collision_exception<class_Skeleton_method_physical_bones_add_collision_exception>` **(** :ref:`RID<class_RID>` exception **)**                                                                                                  |
    69. 

  69. +-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    70. 

  70. | void                                      | :ref:`physical_bones_remove_collision_exception<class_Skeleton_method_physical_bones_remove_collision_exception>` **(** :ref:`RID<class_RID>` exception **)**                                                                                            |
    71. 

  71. +-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    72. 

  72. | void                                      | :ref:`physical_bones_start_simulation<class_Skeleton_method_physical_bones_start_simulation>` **(** :ref:`Array<class_Array>` bones=[  ] **)**                                                                                                           |
    73. 

  73. +-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    74. 

  74. | void                                      | :ref:`physical_bones_stop_simulation<class_Skeleton_method_physical_bones_stop_simulation>` **(** **)**                                                                                                                                                  |
    75. 

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

  76. | :ref:`SkinReference<class_SkinReference>` | :ref:`register_skin<class_Skeleton_method_register_skin>` **(** :ref:`Skin<class_Skin>` skin **)**                                                                                                                                                       |
    77. 

  77. +-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    78. 

  78. | void                                      | :ref:`set_bone_custom_pose<class_Skeleton_method_set_bone_custom_pose>` **(** :ref:`int<class_int>` bone_idx, :ref:`Transform<class_Transform>` custom_pose **)**                                                                                        |
    79. 

  79. +-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    80. 

  80. | void                                      | :ref:`set_bone_disable_rest<class_Skeleton_method_set_bone_disable_rest>` **(** :ref:`int<class_int>` bone_idx, :ref:`bool<class_bool>` disable **)**                                                                                                    |
    81. 

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

  82. | void                                      | :ref:`set_bone_global_pose_override<class_Skeleton_method_set_bone_global_pose_override>` **(** :ref:`int<class_int>` bone_idx, :ref:`Transform<class_Transform>` pose, :ref:`float<class_float>` amount, :ref:`bool<class_bool>` persistent=false **)** |
    83. 

  83. +-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    84. 

  84. | void                                      | :ref:`set_bone_name<class_Skeleton_method_set_bone_name>` **(** :ref:`int<class_int>` bone_idx, :ref:`String<class_String>` name **)**                                                                                                                   |
    85. 

  85. +-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    86. 

  86. | void                                      | :ref:`set_bone_parent<class_Skeleton_method_set_bone_parent>` **(** :ref:`int<class_int>` bone_idx, :ref:`int<class_int>` parent_idx **)**                                                                                                               |
    87. 

  87. +-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    88. 

  88. | void                                      | :ref:`set_bone_pose<class_Skeleton_method_set_bone_pose>` **(** :ref:`int<class_int>` bone_idx, :ref:`Transform<class_Transform>` pose **)**                                                                                                             |
    89. 

  89. +-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    90. 

  90. | void                                      | :ref:`set_bone_rest<class_Skeleton_method_set_bone_rest>` **(** :ref:`int<class_int>` bone_idx, :ref:`Transform<class_Transform>` rest **)**                                                                                                             |
    91. 

  91. +-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    92. 

  92. | void                                      | :ref:`unbind_child_node_from_bone<class_Skeleton_method_unbind_child_node_from_bone>` **(** :ref:`int<class_int>` bone_idx, :ref:`Node<class_Node>` node **)**                                                                                           |
    93. 

  93. +-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    94. 

  94. | void                                      | :ref:`unparent_bone_and_rest<class_Skeleton_method_unparent_bone_and_rest>` **(** :ref:`int<class_int>` bone_idx **)**                                                                                                                                   |
    95. 

  95. +-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    96. 

  96. 

  97. Signals
    98. 

  98. -------
    99. 

  99. 

  100. .. _class_Skeleton_signal_skeleton_updated:
    101. 

  101. 

  102. - **skeleton_updated** **(** **)**
    103. 

  103. 

  104. Constants
    105. 

  105. ---------
    106. 

  106. 

  107. .. _class_Skeleton_constant_NOTIFICATION_UPDATE_SKELETON:
    108. 

  108. 

  109. - **NOTIFICATION_UPDATE_SKELETON** = **50**
    110. 

  110. 

  111. Method Descriptions
    112. 

  112. -------------------
    113. 

  113. 

  114. .. _class_Skeleton_method_add_bone:
    115. 

  115. 

  116. - void **add_bone** **(** :ref:`String<class_String>` name **)**
    117. 

  117. 

  118. Adds a bone, with name ``name``. :ref:`get_bone_count<class_Skeleton_method_get_bone_count>` will become the bone index.
    119. 

  119. 

  120. ----
    121. 

  121. 

  122. .. _class_Skeleton_method_bind_child_node_to_bone:
    123. 

  123. 

  124. - void **bind_child_node_to_bone** **(** :ref:`int<class_int>` bone_idx, :ref:`Node<class_Node>` node **)**
    125. 

  125. 

  126. *Deprecated soon.*
    127. 

  127. 

  128. ----
    129. 

  129. 

  130. .. _class_Skeleton_method_clear_bones:
    131. 

  131. 

  132. - void **clear_bones** **(** **)**
    133. 

  133. 

  134. Clear all the bones in this skeleton.
    135. 

  135. 

  136. ----
    137. 

  137. 

  138. .. _class_Skeleton_method_clear_bones_global_pose_override:
    139. 

  139. 

  140. - void **clear_bones_global_pose_override** **(** **)**
    141. 

  141. 

  142. ----
    143. 

  143. 

  144. .. _class_Skeleton_method_find_bone:
    145. 

  145. 

  146. - :ref:`int<class_int>` **find_bone** **(** :ref:`String<class_String>` name **)** |const|
    147. 

  147. 

  148. Returns the bone index that matches ``name`` as its name.
    149. 

  149. 

  150. ----
    151. 

  151. 

  152. .. _class_Skeleton_method_get_bone_count:
    153. 

  153. 

  154. - :ref:`int<class_int>` **get_bone_count** **(** **)** |const|
    155. 

  155. 

  156. Returns the amount of bones in the skeleton.
    157. 

  157. 

  158. ----
    159. 

  159. 

  160. .. _class_Skeleton_method_get_bone_custom_pose:
    161. 

  161. 

  162. - :ref:`Transform<class_Transform>` **get_bone_custom_pose** **(** :ref:`int<class_int>` bone_idx **)** |const|
    163. 

  163. 

  164. Returns the custom pose of the specified bone. Custom pose is applied on top of the rest pose.
    165. 

  165. 

  166. ----
    167. 

  167. 

  168. .. _class_Skeleton_method_get_bone_global_pose:
    169. 

  169. 

  170. - :ref:`Transform<class_Transform>` **get_bone_global_pose** **(** :ref:`int<class_int>` bone_idx **)** |const|
    171. 

  171. 

  172. Returns the overall transform of the specified bone, with respect to the skeleton. Being relative to the skeleton frame, this is not the actual "global" transform of the bone.
    173. 

  173. 

  174. ----
    175. 

  175. 

  176. .. _class_Skeleton_method_get_bone_global_pose_no_override:
    177. 

  177. 

  178. - :ref:`Transform<class_Transform>` **get_bone_global_pose_no_override** **(** :ref:`int<class_int>` bone_idx **)** |const|
    179. 

  179. 

  180. Returns the overall transform of the specified bone, with respect to the skeleton, but without any global pose overrides. Being relative to the skeleton frame, this is not the actual "global" transform of the bone.
    181. 

  181. 

  182. ----
    183. 

  183. 

  184. .. _class_Skeleton_method_get_bone_name:
    185. 

  185. 

  186. - :ref:`String<class_String>` **get_bone_name** **(** :ref:`int<class_int>` bone_idx **)** |const|
    187. 

  187. 

  188. Returns the name of the bone at index ``index``.
    189. 

  189. 

  190. ----
    191. 

  191. 

  192. .. _class_Skeleton_method_get_bone_parent:
    193. 

  193. 

  194. - :ref:`int<class_int>` **get_bone_parent** **(** :ref:`int<class_int>` bone_idx **)** |const|
    195. 

  195. 

  196. Returns the bone index which is the parent of the bone at ``bone_idx``. If -1, then bone has no parent.
    197. 

  197. 

  198. **Note:** The parent bone returned will always be less than ``bone_idx``.
    199. 

  199. 

  200. ----
    201. 

  201. 

  202. .. _class_Skeleton_method_get_bone_pose:
    203. 

  203. 

  204. - :ref:`Transform<class_Transform>` **get_bone_pose** **(** :ref:`int<class_int>` bone_idx **)** |const|
    205. 

  205. 

  206. Returns the pose transform of the specified bone. Pose is applied on top of the custom pose, which is applied on top the rest pose.
    207. 

  207. 

  208. ----
    209. 

  209. 

  210. .. _class_Skeleton_method_get_bone_rest:
    211. 

  211. 

  212. - :ref:`Transform<class_Transform>` **get_bone_rest** **(** :ref:`int<class_int>` bone_idx **)** |const|
    213. 

  213. 

  214. Returns the rest transform for a bone ``bone_idx``.
    215. 

  215. 

  216. ----
    217. 

  217. 

  218. .. _class_Skeleton_method_get_bound_child_nodes_to_bone:
    219. 

  219. 

  220. - :ref:`Array<class_Array>` **get_bound_child_nodes_to_bone** **(** :ref:`int<class_int>` bone_idx **)** |const|
    221. 

  221. 

  222. *Deprecated soon.*
    223. 

  223. 

  224. ----
    225. 

  225. 

  226. .. _class_Skeleton_method_is_bone_rest_disabled:
    227. 

  227. 

  228. - :ref:`bool<class_bool>` **is_bone_rest_disabled** **(** :ref:`int<class_int>` bone_idx **)** |const|
    229. 

  229. 

  230. ----
    231. 

  231. 

  232. .. _class_Skeleton_method_localize_rests:
    233. 

  233. 

  234. - void **localize_rests** **(** **)**
    235. 

  235. 

  236. ----
    237. 

  237. 

  238. .. _class_Skeleton_method_physical_bones_add_collision_exception:
    239. 

  239. 

  240. - void **physical_bones_add_collision_exception** **(** :ref:`RID<class_RID>` exception **)**
    241. 

  241. 

  242. ----
    243. 

  243. 

  244. .. _class_Skeleton_method_physical_bones_remove_collision_exception:
    245. 

  245. 

  246. - void **physical_bones_remove_collision_exception** **(** :ref:`RID<class_RID>` exception **)**
    247. 

  247. 

  248. ----
    249. 

  249. 

  250. .. _class_Skeleton_method_physical_bones_start_simulation:
    251. 

  251. 

  252. - void **physical_bones_start_simulation** **(** :ref:`Array<class_Array>` bones=[  ] **)**
    253. 

  253. 

  254. ----
    255. 

  255. 

  256. .. _class_Skeleton_method_physical_bones_stop_simulation:
    257. 

  257. 

  258. - void **physical_bones_stop_simulation** **(** **)**
    259. 

  259. 

  260. ----
    261. 

  261. 

  262. .. _class_Skeleton_method_register_skin:
    263. 

  263. 

  264. - :ref:`SkinReference<class_SkinReference>` **register_skin** **(** :ref:`Skin<class_Skin>` skin **)**
    265. 

  265. 

  266. ----
    267. 

  267. 

  268. .. _class_Skeleton_method_set_bone_custom_pose:
    269. 

  269. 

  270. - void **set_bone_custom_pose** **(** :ref:`int<class_int>` bone_idx, :ref:`Transform<class_Transform>` custom_pose **)**
    271. 

  271. 

  272. ----
    273. 

  273. 

  274. .. _class_Skeleton_method_set_bone_disable_rest:
    275. 

  275. 

  276. - void **set_bone_disable_rest** **(** :ref:`int<class_int>` bone_idx, :ref:`bool<class_bool>` disable **)**
    277. 

  277. 

  278. ----
    279. 

  279. 

  280. .. _class_Skeleton_method_set_bone_global_pose_override:
    281. 

  281. 

  282. - void **set_bone_global_pose_override** **(** :ref:`int<class_int>` bone_idx, :ref:`Transform<class_Transform>` pose, :ref:`float<class_float>` amount, :ref:`bool<class_bool>` persistent=false **)**
    283. 

  283. 

  284. ----
    285. 

  285. 

  286. .. _class_Skeleton_method_set_bone_name:
    287. 

  287. 

  288. - void **set_bone_name** **(** :ref:`int<class_int>` bone_idx, :ref:`String<class_String>` name **)**
    289. 

  289. 

  290. ----
    291. 

  291. 

  292. .. _class_Skeleton_method_set_bone_parent:
    293. 

  293. 

  294. - void **set_bone_parent** **(** :ref:`int<class_int>` bone_idx, :ref:`int<class_int>` parent_idx **)**
    295. 

  295. 

  296. Sets the bone index ``parent_idx`` as the parent of the bone at ``bone_idx``. If -1, then bone has no parent.
    297. 

  297. 

  298. **Note:** ``parent_idx`` must be less than ``bone_idx``.
    299. 

  299. 

  300. ----
    301. 

  301. 

  302. .. _class_Skeleton_method_set_bone_pose:
    303. 

  303. 

  304. - void **set_bone_pose** **(** :ref:`int<class_int>` bone_idx, :ref:`Transform<class_Transform>` pose **)**
    305. 

  305. 

  306. Sets the pose transform for bone ``bone_idx``.
    307. 

  307. 

  308. ----
    309. 

  309. 

  310. .. _class_Skeleton_method_set_bone_rest:
    311. 

  311. 

  312. - void **set_bone_rest** **(** :ref:`int<class_int>` bone_idx, :ref:`Transform<class_Transform>` rest **)**
    313. 

  313. 

  314. Sets the rest transform for bone ``bone_idx``.
    315. 

  315. 

  316. ----
    317. 

  317. 

  318. .. _class_Skeleton_method_unbind_child_node_from_bone:
    319. 

  319. 

  320. - void **unbind_child_node_from_bone** **(** :ref:`int<class_int>` bone_idx, :ref:`Node<class_Node>` node **)**
    321. 

  321. 

  322. *Deprecated soon.*
    323. 

  323. 

  324. ----
    325. 

  325. 

  326. .. _class_Skeleton_method_unparent_bone_and_rest:
    327. 

  327. 

  328. - void **unparent_bone_and_rest** **(** :ref:`int<class_int>` bone_idx **)**
    329. 

  329. 

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

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

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

  333.