diff options
Diffstat (limited to 'doc/classes/Skeleton2D.xml')
-rw-r--r-- | doc/classes/Skeleton2D.xml | 28 |
1 files changed, 14 insertions, 14 deletions
diff --git a/doc/classes/Skeleton2D.xml b/doc/classes/Skeleton2D.xml index 7867e5afa3..808f93b491 100644 --- a/doc/classes/Skeleton2D.xml +++ b/doc/classes/Skeleton2D.xml @@ -13,17 +13,17 @@ <methods> <method name="execute_modifications"> <return type="void" /> - <argument index="0" name="delta" type="float" /> - <argument index="1" name="execution_mode" type="int" /> + <param index="0" name="delta" type="float" /> + <param index="1" name="execution_mode" type="int" /> <description> Executes all the modifications on the [SkeletonModificationStack2D], if the Skeleton3D has one assigned. </description> </method> <method name="get_bone"> <return type="Bone2D" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> - Returns a [Bone2D] from the node hierarchy parented by Skeleton2D. The object to return is identified by the parameter [code]idx[/code]. Bones are indexed by descending the node hierarchy from top to bottom, adding the children of each branch before moving to the next sibling. + Returns a [Bone2D] from the node hierarchy parented by Skeleton2D. The object to return is identified by the parameter [param idx]. Bones are indexed by descending the node hierarchy from top to bottom, adding the children of each branch before moving to the next sibling. </description> </method> <method name="get_bone_count" qualifiers="const"> @@ -34,9 +34,9 @@ </method> <method name="get_bone_local_pose_override"> <return type="Transform2D" /> - <argument index="0" name="bone_idx" type="int" /> + <param index="0" name="bone_idx" type="int" /> <description> - Returns the local pose override transform for [code]bone_idx[/code]. + Returns the local pose override transform for [param bone_idx]. </description> </method> <method name="get_modification_stack" qualifiers="const"> @@ -53,19 +53,19 @@ </method> <method name="set_bone_local_pose_override"> <return type="void" /> - <argument index="0" name="bone_idx" type="int" /> - <argument index="1" name="override_pose" type="Transform2D" /> - <argument index="2" name="strength" type="float" /> - <argument index="3" name="persistent" type="bool" /> + <param index="0" name="bone_idx" type="int" /> + <param index="1" name="override_pose" type="Transform2D" /> + <param index="2" name="strength" type="float" /> + <param index="3" name="persistent" type="bool" /> <description> - Sets the local pose transform, [code]pose[/code], for the bone at [code]bone_idx[/code]. - [code]amount[/code] is the interpolation strength that will be used when applying the pose, and [code]persistent[/code] determines if the applied pose will remain. - [b]Note:[/b] The pose transform needs to be a local transform relative to the [Bone2D] node at [code]bone_idx[/code]! + Sets the local pose transform, [param override_pose], for the bone at [param bone_idx]. + [param strength] is the interpolation strength that will be used when applying the pose, and [param persistent] determines if the applied pose will remain. + [b]Note:[/b] The pose transform needs to be a local transform relative to the [Bone2D] node at [param bone_idx]! </description> </method> <method name="set_modification_stack"> <return type="void" /> - <argument index="0" name="modification_stack" type="SkeletonModificationStack2D" /> + <param index="0" name="modification_stack" type="SkeletonModificationStack2D" /> <description> Sets the [SkeletonModificationStack2D] attached to this skeleton. </description> |