Skip to content

Clarify how AnimationTrack:Stop() with a fadeTime of 0 affects Motor6Ds #1036

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Feb 26, 2025
Merged

Clarify how AnimationTrack:Stop() with a fadeTime of 0 affects Motor6Ds #1036

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
55c43b5
Update AnimationTrack.yaml
Starveldt Feb 26, 2025
ee0338f
Update AnimationTrack.yaml
IgnisRBX Feb 26, 2025
ae9d35a
Update content/en-us/reference/engine/classes/AnimationTrack.yaml
IgnisRBX Feb 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 14 additions & 17 deletions content/en-us/reference/engine/classes/AnimationTrack.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -601,24 +601,21 @@ methods:
writeCapabilities: []
- name: AnimationTrack:Stop
summary: |
Stops the `Class.AnimationTrack`. Once called playback of the
`Class.AnimationTrack` will stop and the weight of the animation will move
towards zero over a length of time specified by the optional fadeTime
parameter.
Stops the `Class.AnimationTrack`.
description: |
Stops the `Class.AnimationTrack`. Once called playback of the
`Class.AnimationTrack` will stop and the weight of the animation will move
towards zero over a length of time specified by the optional fadeTime
parameter.

For example, if Stop is called with a fadeTime of 2 seconds it will take
two seconds for the weight of the `Class.AnimationTrack` to reach zero and
its effects completely end. Please note this will be the case regardless
of the initial weight of the animation.

It is not recommended to use a fadeTime of 0 seconds to try to override
this effect and end the animation immediately as presently, this causes
the `Class.AnimationTrack` poses to freeze.
Stops the `Class.AnimationTrack`. Once called, the weight of the animation
will move towards zero over a length of time specified by the optional
`fadeTime` parameter. For example, if `Stop()` is called with a `fadeTime`
of `2`, it will take two seconds for the weight of the track to reach
zero and its effects completely end. Please note this will be the case
regardless of the initial weight of the animation.

It is not recommended to use a `fadeTime` of `0` in an attempt to override
this effect and end the animation immediately for `Class.Motor6D|Motor6Ds`
that have their `Class.Motor.MaxVelocity` set to zero, as this causes
the joints to freeze in place. If it must end immediately, ensure the
`Class.Motor.MaxVelocity` of `Class.Motor6D|Motor6Ds` in your rig are
high enough for them to snap properly.
code_samples:
- AnimationTrack-Stop
parameters:
Expand Down