class_bone2d.rst 2.7 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the Bone2D.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_Bone2D:
  5. Bone2D
  6. ======
  7. **Inherits:** :ref:`Node2D<class_Node2D>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
  8. **Category:** Core
  9. Brief Description
  10. -----------------
  11. Properties
  12. ----------
  13. +---------------------------------------+----------------------------------------------------+
  14. | :ref:`float<class_float>` | :ref:`default_length<class_Bone2D_default_length>` |
  15. +---------------------------------------+----------------------------------------------------+
  16. | :ref:`Transform2D<class_Transform2D>` | :ref:`rest<class_Bone2D_rest>` |
  17. +---------------------------------------+----------------------------------------------------+
  18. Methods
  19. -------
  20. +----------------------------------------+------------------------------------------------------------------------------------+
  21. | void | :ref:`apply_rest<class_Bone2D_apply_rest>` **(** **)** |
  22. +----------------------------------------+------------------------------------------------------------------------------------+
  23. | :ref:`int<class_int>` | :ref:`get_index_in_skeleton<class_Bone2D_get_index_in_skeleton>` **(** **)** const |
  24. +----------------------------------------+------------------------------------------------------------------------------------+
  25. | :ref:`Transform2D<class_Transform2D>` | :ref:`get_skeleton_rest<class_Bone2D_get_skeleton_rest>` **(** **)** const |
  26. +----------------------------------------+------------------------------------------------------------------------------------+
  27. Property Descriptions
  28. ---------------------
  29. .. _class_Bone2D_default_length:
  30. - :ref:`float<class_float>` **default_length**
  31. +----------+---------------------------+
  32. | *Setter* | set_default_length(value) |
  33. +----------+---------------------------+
  34. | *Getter* | get_default_length() |
  35. +----------+---------------------------+
  36. .. _class_Bone2D_rest:
  37. - :ref:`Transform2D<class_Transform2D>` **rest**
  38. +----------+-----------------+
  39. | *Setter* | set_rest(value) |
  40. +----------+-----------------+
  41. | *Getter* | get_rest() |
  42. +----------+-----------------+
  43. Method Descriptions
  44. -------------------
  45. .. _class_Bone2D_apply_rest:
  46. - void **apply_rest** **(** **)**
  47. .. _class_Bone2D_get_index_in_skeleton:
  48. - :ref:`int<class_int>` **get_index_in_skeleton** **(** **)** const
  49. .. _class_Bone2D_get_skeleton_rest:
  50. - :ref:`Transform2D<class_Transform2D>` **get_skeleton_rest** **(** **)** const