diff options
Diffstat (limited to 'doc/classes')
| -rw-r--r-- | doc/classes/Animation.xml | 5 | ||||
| -rw-r--r-- | doc/classes/AnimationMixer.xml | 14 | ||||
| -rw-r--r-- | doc/classes/AnimationTree.xml | 1 |
3 files changed, 20 insertions, 0 deletions
diff --git a/doc/classes/Animation.xml b/doc/classes/Animation.xml index e04320c30d..ebdca643ce 100644 --- a/doc/classes/Animation.xml +++ b/doc/classes/Animation.xml @@ -234,6 +234,7 @@ <return type="float" /> <param index="0" name="track_idx" type="int" /> <param index="1" name="time_sec" type="float" /> + <param index="2" name="backward" type="bool" default="false" /> <description> Returns the interpolated blend shape value at the given time (in seconds). The [param track_idx] must be the index of a blend shape track. </description> @@ -305,6 +306,7 @@ <return type="Vector3" /> <param index="0" name="track_idx" type="int" /> <param index="1" name="time_sec" type="float" /> + <param index="2" name="backward" type="bool" default="false" /> <description> Returns the interpolated position value at the given time (in seconds). The [param track_idx] must be the index of a 3D position track. </description> @@ -329,6 +331,7 @@ <return type="Quaternion" /> <param index="0" name="track_idx" type="int" /> <param index="1" name="time_sec" type="float" /> + <param index="2" name="backward" type="bool" default="false" /> <description> Returns the interpolated rotation value at the given time (in seconds). The [param track_idx] must be the index of a 3D rotation track. </description> @@ -346,6 +349,7 @@ <return type="Vector3" /> <param index="0" name="track_idx" type="int" /> <param index="1" name="time_sec" type="float" /> + <param index="2" name="backward" type="bool" default="false" /> <description> Returns the interpolated scale value at the given time (in seconds). The [param track_idx] must be the index of a 3D scale track. </description> @@ -574,6 +578,7 @@ <return type="Variant" /> <param index="0" name="track_idx" type="int" /> <param index="1" name="time_sec" type="float" /> + <param index="2" name="backward" type="bool" default="false" /> <description> Returns the interpolated value at the given time (in seconds). The [param track_idx] must be the index of a value track. </description> diff --git a/doc/classes/AnimationMixer.xml b/doc/classes/AnimationMixer.xml index d17e9377da..e521baffda 100644 --- a/doc/classes/AnimationMixer.xml +++ b/doc/classes/AnimationMixer.xml @@ -273,6 +273,11 @@ The number of possible simultaneous sounds for each of the assigned AudioStreamPlayers. For example, if this value is [code]32[/code] and the animation has two audio tracks, the two [AudioStreamPlayer]s assigned can play simultaneously up to [code]32[/code] voices each. </member> + <member name="callback_mode_discrete" type="int" setter="set_callback_mode_discrete" getter="get_callback_mode_discrete" enum="AnimationMixer.AnimationCallbackModeDiscrete" default="1"> + Ordinarily, tracks can be set to [constant Animation.UPDATE_DISCRETE] to update infrequently, usually when using nearest interpolation. + However, when blending with [constant Animation.UPDATE_CONTINUOUS] several results are considered. The [member callback_mode_discrete] specify it explicitly. See also [enum AnimationCallbackModeDiscrete]. + To make the blended results look good, it is recommended to set this to [constant ANIMATION_CALLBACK_MODE_DISCRETE_FORCE_CONTINUOUS] to update every frame during blending. Other values exist for compatibility and they are fine if there is no blending, but not so, may produce artifacts. + </member> <member name="callback_mode_method" type="int" setter="set_callback_mode_method" getter="get_callback_mode_method" enum="AnimationMixer.AnimationCallbackModeMethod" default="0"> The call mode to use for Call Method tracks. </member> @@ -350,5 +355,14 @@ <constant name="ANIMATION_CALLBACK_MODE_METHOD_IMMEDIATE" value="1" enum="AnimationCallbackModeMethod"> Make method calls immediately when reached in the animation. </constant> + <constant name="ANIMATION_CALLBACK_MODE_DISCRETE_DOMINANT" value="0" enum="AnimationCallbackModeDiscrete"> + An [constant Animation.UPDATE_DISCRETE] track value takes precedence when blending [constant Animation.UPDATE_CONTINUOUS] or [constant Animation.UPDATE_CAPTURE] track values and [constant Animation.UPDATE_DISCRETE] track values. + </constant> + <constant name="ANIMATION_CALLBACK_MODE_DISCRETE_RECESSIVE" value="1" enum="AnimationCallbackModeDiscrete"> + An [constant Animation.UPDATE_CONTINUOUS] or [constant Animation.UPDATE_CAPTURE] track value takes precedence when blending the [constant Animation.UPDATE_CONTINUOUS] or [constant Animation.UPDATE_CAPTURE] track values and the [constant Animation.UPDATE_DISCRETE] track values. This is the default behavior for [AnimationPlayer]. + </constant> + <constant name="ANIMATION_CALLBACK_MODE_DISCRETE_FORCE_CONTINUOUS" value="2" enum="AnimationCallbackModeDiscrete"> + Always treat the [constant Animation.UPDATE_DISCRETE] track value as [constant Animation.UPDATE_CONTINUOUS] with [constant Animation.INTERPOLATION_NEAREST]. This is the default behavior for [AnimationTree]. + </constant> </constants> </class> diff --git a/doc/classes/AnimationTree.xml b/doc/classes/AnimationTree.xml index 3e0c088b8a..778b5cf513 100644 --- a/doc/classes/AnimationTree.xml +++ b/doc/classes/AnimationTree.xml @@ -31,6 +31,7 @@ <member name="anim_player" type="NodePath" setter="set_animation_player" getter="get_animation_player" default="NodePath("")"> The path to the [AnimationPlayer] used for animating. </member> + <member name="callback_mode_discrete" type="int" setter="set_callback_mode_discrete" getter="get_callback_mode_discrete" overrides="AnimationMixer" enum="AnimationMixer.AnimationCallbackModeDiscrete" default="2" /> <member name="deterministic" type="bool" setter="set_deterministic" getter="is_deterministic" overrides="AnimationMixer" default="true" /> <member name="tree_root" type="AnimationRootNode" setter="set_tree_root" getter="get_tree_root"> The root animation node of this [AnimationTree]. See [AnimationRootNode]. |