Files
godot-docs/classes/class_skin.rst
2022-02-01 16:35:13 +01:00

116 lines
6.8 KiB
ReStructuredText

:github_url: hide
.. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the Skin.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_Skin:
Skin
====
**Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
Methods
-------
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_bind<class_Skin_method_add_bind>` **(** :ref:`int<class_int>` bone, :ref:`Transform3D<class_Transform3D>` pose **)** |
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_named_bind<class_Skin_method_add_named_bind>` **(** :ref:`String<class_String>` name, :ref:`Transform3D<class_Transform3D>` pose **)** |
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear_binds<class_Skin_method_clear_binds>` **(** **)** |
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_bind_bone<class_Skin_method_get_bind_bone>` **(** :ref:`int<class_int>` bind_index **)** |const| |
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_bind_count<class_Skin_method_get_bind_count>` **(** **)** |const| |
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`StringName<class_StringName>` | :ref:`get_bind_name<class_Skin_method_get_bind_name>` **(** :ref:`int<class_int>` bind_index **)** |const| |
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Transform3D<class_Transform3D>` | :ref:`get_bind_pose<class_Skin_method_get_bind_pose>` **(** :ref:`int<class_int>` bind_index **)** |const| |
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_bind_bone<class_Skin_method_set_bind_bone>` **(** :ref:`int<class_int>` bind_index, :ref:`int<class_int>` bone **)** |
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_bind_count<class_Skin_method_set_bind_count>` **(** :ref:`int<class_int>` bind_count **)** |
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_bind_name<class_Skin_method_set_bind_name>` **(** :ref:`int<class_int>` bind_index, :ref:`StringName<class_StringName>` name **)** |
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_bind_pose<class_Skin_method_set_bind_pose>` **(** :ref:`int<class_int>` bind_index, :ref:`Transform3D<class_Transform3D>` pose **)** |
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
Method Descriptions
-------------------
.. _class_Skin_method_add_bind:
- void **add_bind** **(** :ref:`int<class_int>` bone, :ref:`Transform3D<class_Transform3D>` pose **)**
----
.. _class_Skin_method_add_named_bind:
- void **add_named_bind** **(** :ref:`String<class_String>` name, :ref:`Transform3D<class_Transform3D>` pose **)**
----
.. _class_Skin_method_clear_binds:
- void **clear_binds** **(** **)**
----
.. _class_Skin_method_get_bind_bone:
- :ref:`int<class_int>` **get_bind_bone** **(** :ref:`int<class_int>` bind_index **)** |const|
----
.. _class_Skin_method_get_bind_count:
- :ref:`int<class_int>` **get_bind_count** **(** **)** |const|
----
.. _class_Skin_method_get_bind_name:
- :ref:`StringName<class_StringName>` **get_bind_name** **(** :ref:`int<class_int>` bind_index **)** |const|
----
.. _class_Skin_method_get_bind_pose:
- :ref:`Transform3D<class_Transform3D>` **get_bind_pose** **(** :ref:`int<class_int>` bind_index **)** |const|
----
.. _class_Skin_method_set_bind_bone:
- void **set_bind_bone** **(** :ref:`int<class_int>` bind_index, :ref:`int<class_int>` bone **)**
----
.. _class_Skin_method_set_bind_count:
- void **set_bind_count** **(** :ref:`int<class_int>` bind_count **)**
----
.. _class_Skin_method_set_bind_name:
- void **set_bind_name** **(** :ref:`int<class_int>` bind_index, :ref:`StringName<class_StringName>` name **)**
----
.. _class_Skin_method_set_bind_pose:
- void **set_bind_pose** **(** :ref:`int<class_int>` bind_index, :ref:`Transform3D<class_Transform3D>` pose **)**
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`