summaryrefslogtreecommitdiff
path: root/doc/classes/Skeleton3D.xml
diff options
context:
space:
mode:
authorYuri Sizov <yuris@humnom.net>2022-08-06 21:11:48 +0300
committerYuri Sizov <yuris@humnom.net>2022-08-08 22:34:31 +0300
commitc5d7115038de5f83cb83e08748615a84fc26bee2 (patch)
tree13b9b42aac25f7769428ef91f637e260b768f25d /doc/classes/Skeleton3D.xml
parent35c1eae8d70eb6ae49495339b95f89bcd084c3f2 (diff)
Rename the argument tag to param in XML documentation
Diffstat (limited to 'doc/classes/Skeleton3D.xml')
-rw-r--r--doc/classes/Skeleton3D.xml126
1 files changed, 63 insertions, 63 deletions
diff --git a/doc/classes/Skeleton3D.xml b/doc/classes/Skeleton3D.xml
index 6295724aa2..c02a482a91 100644
--- a/doc/classes/Skeleton3D.xml
+++ b/doc/classes/Skeleton3D.xml
@@ -15,15 +15,15 @@
<methods>
<method name="add_bone">
<return type="void" />
- <argument index="0" name="name" type="String" />
+ <param index="0" name="name" type="String" />
<description>
Adds a bone, with name [code]name[/code]. [method get_bone_count] will become the bone index.
</description>
</method>
<method name="add_bone_child">
<return type="void" />
- <argument index="0" name="bone_idx" type="int" />
- <argument index="1" name="child_bone_idx" type="int" />
+ <param index="0" name="bone_idx" type="int" />
+ <param index="1" name="child_bone_idx" type="int" />
<description>
Takes the given bone pose/transform and converts it to a world transform, relative to the [Skeleton3D] node.
This is useful for using the bone transform in calculations with transforms from [Node3D]-based nodes.
@@ -54,15 +54,15 @@
</method>
<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 [SkeletonModificationStack3D], if the Skeleton3D has one assigned.
</description>
</method>
<method name="find_bone" qualifiers="const">
<return type="int" />
- <argument index="0" name="name" type="String" />
+ <param index="0" name="name" type="String" />
<description>
Returns the bone index that matches [code]name[/code] as its name.
</description>
@@ -75,14 +75,14 @@
</method>
<method name="force_update_bone_child_transform">
<return type="void" />
- <argument index="0" name="bone_idx" type="int" />
+ <param index="0" name="bone_idx" type="int" />
<description>
Force updates the bone transform for the bone at [code]bone_idx[/code] and all of its children.
</description>
</method>
<method name="get_bone_children">
<return type="PackedInt32Array" />
- <argument index="0" name="bone_idx" type="int" />
+ <param index="0" name="bone_idx" type="int" />
<description>
Returns an array containing the bone indexes of all the children node of the passed in bone, [code]bone_idx[/code].
</description>
@@ -95,49 +95,49 @@
</method>
<method name="get_bone_global_pose" qualifiers="const">
<return type="Transform3D" />
- <argument index="0" name="bone_idx" type="int" />
+ <param index="0" name="bone_idx" type="int" />
<description>
Returns the overall transform of the specified bone, with respect to the skeleton. Being relative to the skeleton frame, this is not the actual "global" transform of the bone.
</description>
</method>
<method name="get_bone_global_pose_no_override" qualifiers="const">
<return type="Transform3D" />
- <argument index="0" name="bone_idx" type="int" />
+ <param index="0" name="bone_idx" type="int" />
<description>
Returns the overall transform of the specified bone, with respect to the skeleton, but without any global pose overrides. Being relative to the skeleton frame, this is not the actual "global" transform of the bone.
</description>
</method>
<method name="get_bone_global_pose_override" qualifiers="const">
<return type="Transform3D" />
- <argument index="0" name="bone_idx" type="int" />
+ <param index="0" name="bone_idx" type="int" />
<description>
Returns the global pose override transform for [code]bone_idx[/code].
</description>
</method>
<method name="get_bone_global_rest" qualifiers="const">
<return type="Transform3D" />
- <argument index="0" name="bone_idx" type="int" />
+ <param index="0" name="bone_idx" type="int" />
<description>
Returns the global rest transform for [code]bone_idx[/code].
</description>
</method>
<method name="get_bone_local_pose_override" qualifiers="const">
<return type="Transform3D" />
- <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].
</description>
</method>
<method name="get_bone_name" qualifiers="const">
<return type="String" />
- <argument index="0" name="bone_idx" type="int" />
+ <param index="0" name="bone_idx" type="int" />
<description>
Returns the name of the bone at index [code]index[/code].
</description>
</method>
<method name="get_bone_parent" qualifiers="const">
<return type="int" />
- <argument index="0" name="bone_idx" type="int" />
+ <param index="0" name="bone_idx" type="int" />
<description>
Returns the bone index which is the parent of the bone at [code]bone_idx[/code]. If -1, then bone has no parent.
[b]Note:[/b] The parent bone returned will always be less than [code]bone_idx[/code].
@@ -145,32 +145,32 @@
</method>
<method name="get_bone_pose" qualifiers="const">
<return type="Transform3D" />
- <argument index="0" name="bone_idx" type="int" />
+ <param index="0" name="bone_idx" type="int" />
<description>
Returns the pose transform of the specified bone. Pose is applied on top of the custom pose, which is applied on top the rest pose.
</description>
</method>
<method name="get_bone_pose_position" qualifiers="const">
<return type="Vector3" />
- <argument index="0" name="bone_idx" type="int" />
+ <param index="0" name="bone_idx" type="int" />
<description>
</description>
</method>
<method name="get_bone_pose_rotation" qualifiers="const">
<return type="Quaternion" />
- <argument index="0" name="bone_idx" type="int" />
+ <param index="0" name="bone_idx" type="int" />
<description>
</description>
</method>
<method name="get_bone_pose_scale" qualifiers="const">
<return type="Vector3" />
- <argument index="0" name="bone_idx" type="int" />
+ <param index="0" name="bone_idx" type="int" />
<description>
</description>
</method>
<method name="get_bone_rest" qualifiers="const">
<return type="Transform3D" />
- <argument index="0" name="bone_idx" type="int" />
+ <param index="0" name="bone_idx" type="int" />
<description>
Returns the rest transform for a bone [code]bone_idx[/code].
</description>
@@ -189,8 +189,8 @@
</method>
<method name="global_pose_to_local_pose">
<return type="Transform3D" />
- <argument index="0" name="bone_idx" type="int" />
- <argument index="1" name="global_pose" type="Transform3D" />
+ <param index="0" name="bone_idx" type="int" />
+ <param index="1" name="global_pose" type="Transform3D" />
<description>
Takes the passed-in global pose and converts it to local pose transform.
This can be used to easily convert a global pose from [method get_bone_global_pose] to a global transform in [method set_bone_local_pose_override].
@@ -198,7 +198,7 @@
</method>
<method name="global_pose_to_world_transform">
<return type="Transform3D" />
- <argument index="0" name="global_pose" type="Transform3D" />
+ <param index="0" name="global_pose" type="Transform3D" />
<description>
Takes the passed-in global pose and converts it to a world transform.
This can be used to easily convert a global pose from [method get_bone_global_pose] to a global transform usable with a node's transform, like [member Node3D.global_transform] for example.
@@ -206,8 +206,8 @@
</method>
<method name="global_pose_z_forward_to_bone_forward">
<return type="Basis" />
- <argument index="0" name="bone_idx" type="int" />
- <argument index="1" name="basis" type="Basis" />
+ <param index="0" name="bone_idx" type="int" />
+ <param index="1" name="basis" type="Basis" />
<description>
Rotates the given [Basis] so that the forward axis of the Basis is facing in the forward direction of the bone at [code]bone_idx[/code].
This is helper function to make using [method Transform3D.looking_at] easier with bone poses.
@@ -215,15 +215,15 @@
</method>
<method name="is_bone_enabled" qualifiers="const">
<return type="bool" />
- <argument index="0" name="bone_idx" type="int" />
+ <param index="0" name="bone_idx" type="int" />
<description>
Returns whether the bone pose for the bone at [code]bone_idx[/code] is enabled.
</description>
</method>
<method name="local_pose_to_global_pose">
<return type="Transform3D" />
- <argument index="0" name="bone_idx" type="int" />
- <argument index="1" name="local_pose" type="Transform3D" />
+ <param index="0" name="bone_idx" type="int" />
+ <param index="1" name="local_pose" type="Transform3D" />
<description>
Converts the passed-in local pose to a global pose relative to the inputted bone, [code]bone_idx[/code].
This could be used to convert [method get_bone_pose] for use with the [method set_bone_global_pose_override] function.
@@ -237,7 +237,7 @@
</method>
<method name="physical_bones_add_collision_exception">
<return type="void" />
- <argument index="0" name="exception" type="RID" />
+ <param index="0" name="exception" type="RID" />
<description>
Adds a collision exception to the physical bone.
Works just like the [RigidDynamicBody3D] node.
@@ -245,7 +245,7 @@
</method>
<method name="physical_bones_remove_collision_exception">
<return type="void" />
- <argument index="0" name="exception" type="RID" />
+ <param index="0" name="exception" type="RID" />
<description>
Removes a collision exception to the physical bone.
Works just like the [RigidDynamicBody3D] node.
@@ -253,7 +253,7 @@
</method>
<method name="physical_bones_start_simulation">
<return type="void" />
- <argument index="0" name="bones" type="StringName[]" default="[]" />
+ <param index="0" name="bones" type="StringName[]" default="[]" />
<description>
Tells the [PhysicalBone3D] nodes in the Skeleton to start simulating and reacting to the physics world.
Optionally, a list of bone names can be passed-in, allowing only the passed-in bones to be simulated.
@@ -267,15 +267,15 @@
</method>
<method name="register_skin">
<return type="SkinReference" />
- <argument index="0" name="skin" type="Skin" />
+ <param index="0" name="skin" type="Skin" />
<description>
Binds the given Skin to the Skeleton.
</description>
</method>
<method name="remove_bone_child">
<return type="void" />
- <argument index="0" name="bone_idx" type="int" />
- <argument index="1" name="child_bone_idx" type="int" />
+ <param index="0" name="bone_idx" type="int" />
+ <param index="1" name="child_bone_idx" type="int" />
<description>
Removes the passed in child bone index, [code]child_bone_idx[/code], from the passed-in bone, [code]bone_idx[/code], if it exists.
[b]Note:[/b] This does not remove the child bone, but instead it removes the connection it has to the parent bone.
@@ -283,26 +283,26 @@
</method>
<method name="set_bone_children">
<return type="void" />
- <argument index="0" name="bone_idx" type="int" />
- <argument index="1" name="bone_children" type="PackedInt32Array" />
+ <param index="0" name="bone_idx" type="int" />
+ <param index="1" name="bone_children" type="PackedInt32Array" />
<description>
Sets the children for the passed in bone, [code]bone_idx[/code], to the passed-in array of bone indexes, [code]bone_children[/code].
</description>
</method>
<method name="set_bone_enabled">
<return type="void" />
- <argument index="0" name="bone_idx" type="int" />
- <argument index="1" name="enabled" type="bool" default="true" />
+ <param index="0" name="bone_idx" type="int" />
+ <param index="1" name="enabled" type="bool" default="true" />
<description>
Disables the pose for the bone at [code]bone_idx[/code] if [code]false[/code], enables the bone pose if [code]true[/code].
</description>
</method>
<method name="set_bone_global_pose_override">
<return type="void" />
- <argument index="0" name="bone_idx" type="int" />
- <argument index="1" name="pose" type="Transform3D" />
- <argument index="2" name="amount" type="float" />
- <argument index="3" name="persistent" type="bool" default="false" />
+ <param index="0" name="bone_idx" type="int" />
+ <param index="1" name="pose" type="Transform3D" />
+ <param index="2" name="amount" type="float" />
+ <param index="3" name="persistent" type="bool" default="false" />
<description>
Sets the global 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.
@@ -311,10 +311,10 @@
</method>
<method name="set_bone_local_pose_override">
<return type="void" />
- <argument index="0" name="bone_idx" type="int" />
- <argument index="1" name="pose" type="Transform3D" />
- <argument index="2" name="amount" type="float" />
- <argument index="3" name="persistent" type="bool" default="false" />
+ <param index="0" name="bone_idx" type="int" />
+ <param index="1" name="pose" type="Transform3D" />
+ <param index="2" name="amount" type="float" />
+ <param index="3" name="persistent" type="bool" default="false" />
<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.
@@ -323,15 +323,15 @@
</method>
<method name="set_bone_name">
<return type="void" />
- <argument index="0" name="bone_idx" type="int" />
- <argument index="1" name="name" type="String" />
+ <param index="0" name="bone_idx" type="int" />
+ <param index="1" name="name" type="String" />
<description>
</description>
</method>
<method name="set_bone_parent">
<return type="void" />
- <argument index="0" name="bone_idx" type="int" />
- <argument index="1" name="parent_idx" type="int" />
+ <param index="0" name="bone_idx" type="int" />
+ <param index="1" name="parent_idx" type="int" />
<description>
Sets the bone index [code]parent_idx[/code] as the parent of the bone at [code]bone_idx[/code]. If -1, then bone has no parent.
[b]Note:[/b] [code]parent_idx[/code] must be less than [code]bone_idx[/code].
@@ -339,50 +339,50 @@
</method>
<method name="set_bone_pose_position">
<return type="void" />
- <argument index="0" name="bone_idx" type="int" />
- <argument index="1" name="position" type="Vector3" />
+ <param index="0" name="bone_idx" type="int" />
+ <param index="1" name="position" type="Vector3" />
<description>
</description>
</method>
<method name="set_bone_pose_rotation">
<return type="void" />
- <argument index="0" name="bone_idx" type="int" />
- <argument index="1" name="rotation" type="Quaternion" />
+ <param index="0" name="bone_idx" type="int" />
+ <param index="1" name="rotation" type="Quaternion" />
<description>
</description>
</method>
<method name="set_bone_pose_scale">
<return type="void" />
- <argument index="0" name="bone_idx" type="int" />
- <argument index="1" name="scale" type="Vector3" />
+ <param index="0" name="bone_idx" type="int" />
+ <param index="1" name="scale" type="Vector3" />
<description>
</description>
</method>
<method name="set_bone_rest">
<return type="void" />
- <argument index="0" name="bone_idx" type="int" />
- <argument index="1" name="rest" type="Transform3D" />
+ <param index="0" name="bone_idx" type="int" />
+ <param index="1" name="rest" type="Transform3D" />
<description>
Sets the rest transform for bone [code]bone_idx[/code].
</description>
</method>
<method name="set_modification_stack">
<return type="void" />
- <argument index="0" name="modification_stack" type="SkeletonModificationStack3D" />
+ <param index="0" name="modification_stack" type="SkeletonModificationStack3D" />
<description>
Sets the modification stack for this skeleton to the passed-in modification stack, [code]modification_stack[/code].
</description>
</method>
<method name="unparent_bone_and_rest">
<return type="void" />
- <argument index="0" name="bone_idx" type="int" />
+ <param index="0" name="bone_idx" type="int" />
<description>
Unparents the bone at [code]bone_idx[/code] and sets its rest position to that of its parent prior to being reset.
</description>
</method>
<method name="world_transform_to_global_pose">
<return type="Transform3D" />
- <argument index="0" name="world_transform" type="Transform3D" />
+ <param index="0" name="world_transform" type="Transform3D" />
<description>
Takes the passed-in global transform and converts it to a global pose.
This can be used to easily convert a global transform from [member Node3D.global_transform] to a global pose usable with [method set_bone_global_pose_override], for example.
@@ -401,12 +401,12 @@
</members>
<signals>
<signal name="bone_enabled_changed">
- <argument index="0" name="bone_idx" type="int" />
+ <param index="0" name="bone_idx" type="int" />
<description>
</description>
</signal>
<signal name="bone_pose_changed">
- <argument index="0" name="bone_idx" type="int" />
+ <param index="0" name="bone_idx" type="int" />
<description>
This signal is emitted when one of the bones in the Skeleton3D node have changed their pose. This is used to inform nodes that rely on bone positions that one of the bones in the Skeleton3D have changed their transform/pose.
</description>