diff options
Diffstat (limited to 'doc/classes/SkeletonModificationStack3D.xml')
| -rw-r--r-- | doc/classes/SkeletonModificationStack3D.xml | 28 |
1 files changed, 14 insertions, 14 deletions
diff --git a/doc/classes/SkeletonModificationStack3D.xml b/doc/classes/SkeletonModificationStack3D.xml index fc952f6864..9eaeeefd8e 100644 --- a/doc/classes/SkeletonModificationStack3D.xml +++ b/doc/classes/SkeletonModificationStack3D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="SkeletonModificationStack3D" inherits="Resource" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> +<class name="SkeletonModificationStack3D" inherits="Resource" is_deprecated="true" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> <brief_description> A resource that holds a stack of [SkeletonModification3D]s. </brief_description> @@ -12,31 +12,31 @@ <methods> <method name="add_modification"> <return type="void" /> - <argument index="0" name="modification" type="SkeletonModification3D" /> + <param index="0" name="modification" type="SkeletonModification3D" /> <description> Adds the passed-in [SkeletonModification3D] to the stack. </description> </method> <method name="delete_modification"> <return type="void" /> - <argument index="0" name="mod_idx" type="int" /> + <param index="0" name="mod_idx" type="int" /> <description> - Deletes the [SkeletonModification3D] at the index position [code]mod_idx[/code], if it exists. + Deletes the [SkeletonModification3D] at the index position [param mod_idx], if it exists. </description> </method> <method name="enable_all_modifications"> <return type="void" /> - <argument index="0" name="enabled" type="bool" /> + <param index="0" name="enabled" type="bool" /> <description> Enables all [SkeletonModification3D]s in the stack. </description> </method> <method name="execute"> <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 of the [SkeletonModification3D]s in the stack that use the same execution mode as the passed-in [code]execution_mode[/code], starting from index [code]0[/code] to [member modification_count]. + Executes all of the [SkeletonModification3D]s in the stack that use the same execution mode as the passed-in [param execution_mode], starting from index [code]0[/code] to [member modification_count]. [b]Note:[/b] The order of the modifications can matter depending on the modifications. For example, modifications on a spine should operate before modifications on the arms in order to get proper results. </description> </method> @@ -48,9 +48,9 @@ </method> <method name="get_modification" qualifiers="const"> <return type="SkeletonModification3D" /> - <argument index="0" name="mod_idx" type="int" /> + <param index="0" name="mod_idx" type="int" /> <description> - Returns the [SkeletonModification3D] at the passed-in index, [code]mod_idx[/code]. + Returns the [SkeletonModification3D] at the passed-in index, [param mod_idx]. </description> </method> <method name="get_skeleton" qualifiers="const"> @@ -61,10 +61,10 @@ </method> <method name="set_modification"> <return type="void" /> - <argument index="0" name="mod_idx" type="int" /> - <argument index="1" name="modification" type="SkeletonModification3D" /> + <param index="0" name="mod_idx" type="int" /> + <param index="1" name="modification" type="SkeletonModification3D" /> <description> - Sets the modification at [code]mod_idx[/code] to the passed-in modification, [code]modification[/code]. + Sets the modification at [param mod_idx] to the passed-in modification, [param modification]. </description> </method> <method name="setup"> @@ -79,7 +79,7 @@ When true, the modification's in the stack will be called. This is handled automatically through the [Skeleton3D] node. </member> <member name="modification_count" type="int" setter="set_modification_count" getter="get_modification_count" default="0"> - The amount of modifications in the stack. + The number of modifications in the stack. </member> <member name="strength" type="float" setter="set_strength" getter="get_strength" default="1.0"> The interpolation strength of the modifications in stack. A value of [code]0[/code] will make it where the modifications are not applied, a strength of [code]0.5[/code] will be half applied, and a strength of [code]1[/code] will allow the modifications to be fully applied and override the skeleton bone poses. |