Class reference
BoneConstraint3D
Inherits SkeletonModifier3D
A node that may modify Skeleton3D's bone with associating the two bones.
Description
Base class of SkeletonModifier3D that modifies the bone set in set_apply_bone() based on the transform of the bone retrieved by get_reference_bone().
Methods
void clear_setting()
Clear all settings.
float get_amount(int index) const
float get_amount(int index) constReturns the apply amount of the setting at index.
int get_apply_bone(int index) const
int get_apply_bone(int index) constReturns the apply bone of the setting at index. This bone will be modified.
String get_apply_bone_name(int index) const
String get_apply_bone_name(int index) constReturns the apply bone name of the setting at index. This bone will be modified.
int get_reference_bone(int index) const
int get_reference_bone(int index) constReturns the reference bone of the setting at index. This bone will be only referenced and not modified by this modifier.
String get_reference_bone_name(int index) const
String get_reference_bone_name(int index) constReturns the reference bone name of the setting at index. This bone will be only referenced and not modified by this modifier.
NodePath get_reference_node(int index) const
NodePath get_reference_node(int index) constReturns the reference node path of the setting at index. This node will be only referenced and not modified by this modifier.
int get_reference_type(int index) const
int get_reference_type(int index) constReturns the reference target type of the setting at index. See also ReferenceType.
int get_setting_count() const
int get_setting_count() constReturns the number of settings in the modifier.
void set_amount(int index, float amount)
int index, float amount)Sets the apply amount of the setting at index to amount.
void set_apply_bone(int index, int bone)
int index, int bone)Sets the apply bone of the setting at index to bone. This bone will be modified.
void set_apply_bone_name(int index, String bone_name)
int index, String bone_name)Sets the apply bone of the setting at index to bone_name. This bone will be modified.
void set_reference_bone(int index, int bone)
int index, int bone)Sets the reference bone of the setting at index to bone. This bone will be only referenced and not modified by this modifier.
void set_reference_bone_name(int index, String bone_name)
int index, String bone_name)Sets the reference bone of the setting at index to bone_name. This bone will be only referenced and not modified by this modifier.
void set_reference_node(int index, NodePath node)
int index, NodePath node)Sets the reference node path of the setting at index to node. This node will be only referenced and not modified by this modifier.
void set_reference_type(int index, int type)
int index, int type)Sets the reference target type of the setting at index to type. See also ReferenceType.
void set_setting_count(int count)
int count)Sets the number of settings in the modifier.
Constants
REFERENCE_TYPE_BONE = 0
The reference target is a bone. In this case, the reference target spaces is local space.
REFERENCE_TYPE_NODE = 1
The reference target is a Node3D. In this case, the reference target spaces is model space. In other words, the reference target's coordinates are treated as if it were placed directly under Skeleton3D which parent of the BoneConstraint3D.