diff options
Diffstat (limited to 'doc/classes/SkeletonModification2DCCDIK.xml')
| -rw-r--r-- | doc/classes/SkeletonModification2DCCDIK.xml | 105 |
1 files changed, 35 insertions, 70 deletions
diff --git a/doc/classes/SkeletonModification2DCCDIK.xml b/doc/classes/SkeletonModification2DCCDIK.xml index 1a74905df2..f876615de7 100644 --- a/doc/classes/SkeletonModification2DCCDIK.xml +++ b/doc/classes/SkeletonModification2DCCDIK.xml @@ -13,142 +13,107 @@ </tutorials> <methods> <method name="get_ccdik_joint_bone2d_node" qualifiers="const"> - <return type="NodePath"> - </return> - <argument index="0" name="joint_idx" type="int"> - </argument> + <return type="NodePath" /> + <argument index="0" name="joint_idx" type="int" /> <description> Returns the [Bone2D] node assigned to the CCDIK joint at [code]joint_idx[/code]. </description> </method> <method name="get_ccdik_joint_bone_index" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="joint_idx" type="int"> - </argument> + <return type="int" /> + <argument index="0" name="joint_idx" type="int" /> <description> Returns the index of the [Bone2D] node assigned to the CCDIK joint at [code]joint_idx[/code]. </description> </method> <method name="get_ccdik_joint_constraint_angle_invert" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="joint_idx" type="int"> - </argument> + <return type="bool" /> + <argument index="0" name="joint_idx" type="int" /> <description> Returns whether the CCDIK joint at [code]joint_idx[/code] uses an inverted joint constraint. See [method set_ccdik_joint_constraint_angle_invert] for details. </description> </method> <method name="get_ccdik_joint_constraint_angle_max" qualifiers="const"> - <return type="float"> - </return> - <argument index="0" name="joint_idx" type="int"> - </argument> + <return type="float" /> + <argument index="0" name="joint_idx" type="int" /> <description> Returns the maximum angle constraint for the joint at [code]joint_idx[/code]. </description> </method> <method name="get_ccdik_joint_constraint_angle_min" qualifiers="const"> - <return type="float"> - </return> - <argument index="0" name="joint_idx" type="int"> - </argument> + <return type="float" /> + <argument index="0" name="joint_idx" type="int" /> <description> Returns the minimum angle constraint for the joint at [code]joint_idx[/code]. </description> </method> <method name="get_ccdik_joint_enable_constraint" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="joint_idx" type="int"> - </argument> + <return type="bool" /> + <argument index="0" name="joint_idx" type="int" /> <description> Returns whether angle constraints on the CCDIK joint at [code]joint_idx[/code] are enabled. </description> </method> <method name="get_ccdik_joint_rotate_from_joint" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="joint_idx" type="int"> - </argument> + <return type="bool" /> + <argument index="0" name="joint_idx" type="int" /> <description> Returns whether the joint at [code]joint_idx[/code] is set to rotate from the joint, [code]true[/code], or to rotate from the tip, [code]false[/code]. The default is to rotate from the tip. </description> </method> <method name="set_ccdik_joint_bone2d_node"> - <return type="void"> - </return> - <argument index="0" name="joint_idx" type="int"> - </argument> - <argument index="1" name="bone2d_nodepath" type="NodePath"> - </argument> + <return type="void" /> + <argument index="0" name="joint_idx" type="int" /> + <argument index="1" name="bone2d_nodepath" type="NodePath" /> <description> Sets the [Bone2D] node assigned to the CCDIK joint at [code]joint_idx[/code]. </description> </method> <method name="set_ccdik_joint_bone_index"> - <return type="void"> - </return> - <argument index="0" name="joint_idx" type="int"> - </argument> - <argument index="1" name="bone_idx" type="int"> - </argument> + <return type="void" /> + <argument index="0" name="joint_idx" type="int" /> + <argument index="1" name="bone_idx" type="int" /> <description> Sets the bone index, [code]bone_index[/code], of the CCDIK joint at [code]joint_idx[/code]. When possible, this will also update the [code]bone2d_node[/code] of the CCDIK joint based on data provided by the linked skeleton. </description> </method> <method name="set_ccdik_joint_constraint_angle_invert"> - <return type="void"> - </return> - <argument index="0" name="joint_idx" type="int"> - </argument> - <argument index="1" name="invert" type="bool"> - </argument> + <return type="void" /> + <argument index="0" name="joint_idx" type="int" /> + <argument index="1" name="invert" type="bool" /> <description> Sets whether the CCDIK joint at [code]joint_idx[/code] uses an inverted joint constraint. An inverted joint constraint only constraints the CCDIK joint to the angles [i]outside of[/i] the inputted minimum and maximum angles. For this reason, it is referred to as an inverted joint constraint, as it constraints the joint to the outside of the inputted values. </description> </method> <method name="set_ccdik_joint_constraint_angle_max"> - <return type="void"> - </return> - <argument index="0" name="joint_idx" type="int"> - </argument> - <argument index="1" name="angle_max" type="float"> - </argument> + <return type="void" /> + <argument index="0" name="joint_idx" type="int" /> + <argument index="1" name="angle_max" type="float" /> <description> Sets the maximum angle constraint for the joint at [code]joint_idx[/code]. </description> </method> <method name="set_ccdik_joint_constraint_angle_min"> - <return type="void"> - </return> - <argument index="0" name="joint_idx" type="int"> - </argument> - <argument index="1" name="angle_min" type="float"> - </argument> + <return type="void" /> + <argument index="0" name="joint_idx" type="int" /> + <argument index="1" name="angle_min" type="float" /> <description> Sets the minimum angle constraint for the joint at [code]joint_idx[/code]. </description> </method> <method name="set_ccdik_joint_enable_constraint"> - <return type="void"> - </return> - <argument index="0" name="joint_idx" type="int"> - </argument> - <argument index="1" name="enable_constraint" type="bool"> - </argument> + <return type="void" /> + <argument index="0" name="joint_idx" type="int" /> + <argument index="1" name="enable_constraint" type="bool" /> <description> Determines whether angle constraints on the CCDIK joint at [code]joint_idx[/code] are enabled. When [code]true[/code], constraints will be enabled and taken into account when solving. </description> </method> <method name="set_ccdik_joint_rotate_from_joint"> - <return type="void"> - </return> - <argument index="0" name="joint_idx" type="int"> - </argument> - <argument index="1" name="rotate_from_joint" type="bool"> - </argument> + <return type="void" /> + <argument index="0" name="joint_idx" type="int" /> + <argument index="1" name="rotate_from_joint" type="bool" /> <description> Sets whether the joint at [code]joint_idx[/code] is set to rotate from the joint, [code]true[/code], or to rotate from the tip, [code]false[/code]. </description> |