:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/BoneConstraint3D.xml. .. _class_BoneConstraint3D: BoneConstraint3D ================ **Inherits:** :ref:`SkeletonModifier3D` **<** :ref:`Node3D` **<** :ref:`Node` **<** :ref:`Object` **Inherited By:** :ref:`AimModifier3D`, :ref:`ConvertTransformModifier3D`, :ref:`CopyTransformModifier3D` A node that may modify Skeleton3D's bone with associating the two bones. .. rst-class:: classref-introduction-group Description ----------- Base class of :ref:`SkeletonModifier3D` that modifies the bone set in :ref:`set_apply_bone()` based on the transform of the bone retrieved by :ref:`get_reference_bone()`. .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`clear_setting`\ (\ ) | +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_amount`\ (\ index\: :ref:`int`\ ) |const| | +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_apply_bone`\ (\ index\: :ref:`int`\ ) |const| | +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_apply_bone_name`\ (\ index\: :ref:`int`\ ) |const| | +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_reference_bone`\ (\ index\: :ref:`int`\ ) |const| | +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_reference_bone_name`\ (\ index\: :ref:`int`\ ) |const| | +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_setting_count`\ (\ ) |const| | +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_amount`\ (\ index\: :ref:`int`, amount\: :ref:`float`\ ) | +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_apply_bone`\ (\ index\: :ref:`int`, bone\: :ref:`int`\ ) | +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_apply_bone_name`\ (\ index\: :ref:`int`, bone_name\: :ref:`String`\ ) | +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_reference_bone`\ (\ index\: :ref:`int`, bone\: :ref:`int`\ ) | +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_reference_bone_name`\ (\ index\: :ref:`int`, bone_name\: :ref:`String`\ ) | +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_setting_count`\ (\ count\: :ref:`int`\ ) | +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_BoneConstraint3D_method_clear_setting: .. rst-class:: classref-method |void| **clear_setting**\ (\ ) :ref:`🔗` Clear all settings. .. rst-class:: classref-item-separator ---- .. _class_BoneConstraint3D_method_get_amount: .. rst-class:: classref-method :ref:`float` **get_amount**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` Returns the apply amount of the setting at ``index``. .. rst-class:: classref-item-separator ---- .. _class_BoneConstraint3D_method_get_apply_bone: .. rst-class:: classref-method :ref:`int` **get_apply_bone**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` Returns the apply bone of the setting at ``index``. This bone will be modified. .. rst-class:: classref-item-separator ---- .. _class_BoneConstraint3D_method_get_apply_bone_name: .. rst-class:: classref-method :ref:`String` **get_apply_bone_name**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` Returns the apply bone name of the setting at ``index``. This bone will be modified. .. rst-class:: classref-item-separator ---- .. _class_BoneConstraint3D_method_get_reference_bone: .. rst-class:: classref-method :ref:`int` **get_reference_bone**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` Returns the reference bone of the setting at ``index``. This bone will be only referenced and not modified by this modifier. .. rst-class:: classref-item-separator ---- .. _class_BoneConstraint3D_method_get_reference_bone_name: .. rst-class:: classref-method :ref:`String` **get_reference_bone_name**\ (\ index\: :ref:`int`\ ) |const| :ref:`🔗` Returns the reference bone name of the setting at ``index``. This bone will be only referenced and not modified by this modifier. .. rst-class:: classref-item-separator ---- .. _class_BoneConstraint3D_method_get_setting_count: .. rst-class:: classref-method :ref:`int` **get_setting_count**\ (\ ) |const| :ref:`🔗` Returns the number of settings in the modifier. .. rst-class:: classref-item-separator ---- .. _class_BoneConstraint3D_method_set_amount: .. rst-class:: classref-method |void| **set_amount**\ (\ index\: :ref:`int`, amount\: :ref:`float`\ ) :ref:`🔗` Sets the apply amount of the setting at ``index`` to ``amount``. .. rst-class:: classref-item-separator ---- .. _class_BoneConstraint3D_method_set_apply_bone: .. rst-class:: classref-method |void| **set_apply_bone**\ (\ index\: :ref:`int`, bone\: :ref:`int`\ ) :ref:`🔗` Sets the apply bone of the setting at ``index`` to ``bone``. This bone will be modified. .. rst-class:: classref-item-separator ---- .. _class_BoneConstraint3D_method_set_apply_bone_name: .. rst-class:: classref-method |void| **set_apply_bone_name**\ (\ index\: :ref:`int`, bone_name\: :ref:`String`\ ) :ref:`🔗` Sets the apply bone of the setting at ``index`` to ``bone_name``. This bone will be modified. .. rst-class:: classref-item-separator ---- .. _class_BoneConstraint3D_method_set_reference_bone: .. rst-class:: classref-method |void| **set_reference_bone**\ (\ index\: :ref:`int`, bone\: :ref:`int`\ ) :ref:`🔗` Sets the reference bone of the setting at ``index`` to ``bone``. This bone will be only referenced and not modified by this modifier. .. rst-class:: classref-item-separator ---- .. _class_BoneConstraint3D_method_set_reference_bone_name: .. rst-class:: classref-method |void| **set_reference_bone_name**\ (\ index\: :ref:`int`, bone_name\: :ref:`String`\ ) :ref:`🔗` Sets the reference bone of the setting at ``index`` to ``bone_name``. This bone will be only referenced and not modified by this modifier. .. rst-class:: classref-item-separator ---- .. _class_BoneConstraint3D_method_set_setting_count: .. rst-class:: classref-method |void| **set_setting_count**\ (\ count\: :ref:`int`\ ) :ref:`🔗` Sets the number of settings in the modifier. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |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.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` .. |void| replace:: :abbr:`void (No return value.)`