class_skeletonprofilehumanoid.rst 3.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556
  1. :github_url: hide
  2. .. DO NOT EDIT THIS FILE!!!
  3. .. Generated automatically from Godot engine sources.
  4. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/SkeletonProfileHumanoid.xml.
  6. .. _class_SkeletonProfileHumanoid:
  7. SkeletonProfileHumanoid
  8. =======================
  9. **Inherits:** :ref:`SkeletonProfile<class_SkeletonProfile>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
  10. A humanoid :ref:`SkeletonProfile<class_SkeletonProfile>` preset.
  11. .. rst-class:: classref-introduction-group
  12. Description
  13. -----------
  14. A :ref:`SkeletonProfile<class_SkeletonProfile>` as a preset that is optimized for the human form. This exists for standardization, so all parameters are read-only.
  15. .. rst-class:: classref-introduction-group
  16. Tutorials
  17. ---------
  18. - :doc:`Retargeting 3D Skeletons <../tutorials/assets_pipeline/retargeting_3d_skeletons>`
  19. .. rst-class:: classref-reftable-group
  20. Properties
  21. ----------
  22. .. table::
  23. :widths: auto
  24. +-------------------------------------+-----------------+------------------------------------------------------------------------------------------------+
  25. | :ref:`int<class_int>` | bone_size | ``56`` (overrides :ref:`SkeletonProfile<class_SkeletonProfile_property_bone_size>`) |
  26. +-------------------------------------+-----------------+------------------------------------------------------------------------------------------------+
  27. | :ref:`int<class_int>` | group_size | ``4`` (overrides :ref:`SkeletonProfile<class_SkeletonProfile_property_group_size>`) |
  28. +-------------------------------------+-----------------+------------------------------------------------------------------------------------------------+
  29. | :ref:`StringName<class_StringName>` | root_bone | ``&"Root"`` (overrides :ref:`SkeletonProfile<class_SkeletonProfile_property_root_bone>`) |
  30. +-------------------------------------+-----------------+------------------------------------------------------------------------------------------------+
  31. | :ref:`StringName<class_StringName>` | scale_base_bone | ``&"Hips"`` (overrides :ref:`SkeletonProfile<class_SkeletonProfile_property_scale_base_bone>`) |
  32. +-------------------------------------+-----------------+------------------------------------------------------------------------------------------------+
  33. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  34. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  35. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  36. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  37. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  38. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
  39. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`