diff options
Diffstat (limited to 'doc/classes/Skeleton.xml')
| -rw-r--r-- | doc/classes/Skeleton.xml | 26 |
1 files changed, 14 insertions, 12 deletions
diff --git a/doc/classes/Skeleton.xml b/doc/classes/Skeleton.xml index b693ee0a5e..b1e71ee924 100644 --- a/doc/classes/Skeleton.xml +++ b/doc/classes/Skeleton.xml @@ -17,7 +17,7 @@ <argument index="0" name="name" type="String"> </argument> <description> - Add a bone, with name "name". [method get_bone_count] will become the bone index. + Adds a bone, with name [code]name[/code]. [method get_bone_count] will become the bone index. </description> </method> <method name="bind_child_node_to_bone"> @@ -28,7 +28,7 @@ <argument index="1" name="node" type="Node"> </argument> <description> - Deprecated soon. + [i]Deprecated soon.[/i] </description> </method> <method name="clear_bones"> @@ -44,7 +44,7 @@ <argument index="0" name="name" type="String"> </argument> <description> - Returns the bone index that matches "name" as its name. + Returns the bone index that matches [code]name[/code] as its name. </description> </method> <method name="get_bone_count" qualifiers="const"> @@ -78,7 +78,7 @@ <argument index="0" name="bone_idx" type="int"> </argument> <description> - Returns the name of the bone at index "index". + Returns the name of the bone at index [code]index[/code]. </description> </method> <method name="get_bone_parent" qualifiers="const"> @@ -87,7 +87,8 @@ <argument index="0" name="bone_idx" type="int"> </argument> <description> - Returns the bone index which is the parent of the bone at "bone_idx". If -1, then bone has no parent. Note that the parent bone returned will always be less than "bone_idx". + 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]. </description> </method> <method name="get_bone_pose" qualifiers="const"> @@ -105,7 +106,7 @@ <argument index="0" name="bone_idx" type="int"> </argument> <description> - Returns the rest transform for a bone "bone_idx". + Returns the rest transform for a bone [code]bone_idx[/code]. </description> </method> <method name="get_bone_transform" qualifiers="const"> @@ -123,7 +124,7 @@ <argument index="0" name="bone_idx" type="int"> </argument> <description> - Deprecated soon. + [i]Deprecated soon.[/i] </description> </method> <method name="is_bone_rest_disabled" qualifiers="const"> @@ -218,7 +219,8 @@ <argument index="1" name="parent_idx" type="int"> </argument> <description> - Set the bone index "parent_idx" as the parent of the bone at "bone_idx". If -1, then bone has no parent. Note: "parent_idx" must be less than "bone_idx". + 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]. </description> </method> <method name="set_bone_pose"> @@ -229,7 +231,7 @@ <argument index="1" name="pose" type="Transform"> </argument> <description> - Returns the pose transform for bone "bone_idx". + Returns the pose transform for bone [code]bone_idx[/code]. </description> </method> <method name="set_bone_rest"> @@ -240,7 +242,7 @@ <argument index="1" name="rest" type="Transform"> </argument> <description> - Set the rest transform for bone "bone_idx" + Sets the rest transform for bone [code]bone_idx[/code]. </description> </method> <method name="unbind_child_node_from_bone"> @@ -251,7 +253,7 @@ <argument index="1" name="node" type="Node"> </argument> <description> - Deprecated soon. + [i]Deprecated soon.[/i] </description> </method> <method name="unparent_bone_and_rest"> @@ -264,7 +266,7 @@ </method> </methods> <members> - <member name="bones_in_world_transform" type="bool" setter="set_use_bones_in_world_transform" getter="is_using_bones_in_world_transform"> + <member name="bones_in_world_transform" type="bool" setter="set_use_bones_in_world_transform" getter="is_using_bones_in_world_transform" default="false"> </member> </members> <constants> |