diff options
Diffstat (limited to 'doc/classes/SkeletonModifier3D.xml')
| -rw-r--r-- | doc/classes/SkeletonModifier3D.xml | 29 |
1 files changed, 29 insertions, 0 deletions
diff --git a/doc/classes/SkeletonModifier3D.xml b/doc/classes/SkeletonModifier3D.xml new file mode 100644 index 0000000000..fab33750ea --- /dev/null +++ b/doc/classes/SkeletonModifier3D.xml @@ -0,0 +1,29 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="SkeletonModifier3D" inherits="Node3D" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> + <brief_description> + A Node that may modify Skeleton3D's bone. + </brief_description> + <description> + [SkeletonModifier3D] retrieves a target [Skeleton3D] by having a [Skeleton3D] parent. + If there is [AnimationMixer], modification always performs after playback process of the [AnimationMixer]. + </description> + <tutorials> + </tutorials> + <members> + <member name="active" type="bool" setter="set_active" getter="is_active" default="true"> + If [code]true[/code], the [SkeletonModifier3D] will be processing. + </member> + <member name="influence" type="float" setter="set_influence" getter="get_influence" default="1.0"> + Sets the influence of the modification. + [b]Note:[/b] This value is used by [Skeleton3D] to blend, so the [SkeletonModifier3D] should always apply only 100% of the result without interpolation. + </member> + </members> + <signals> + <signal name="modification_processed"> + <description> + Notifies when the modification have been finished. + [b]Note:[/b] If you want to get the modified bone pose by the modifier, you must use [method Skeleton3D.get_bone_pose] or [method Skeleton3D.get_bone_global_pose] at the moment this signal is fired. + </description> + </signal> + </signals> +</class> |