forestia/bevy
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: AnimationPlayer::play doesn't have transition_duration arg (#10970)

Browse Source 
# Objective

The documentation for `AnimationPlayer::play` mentions a non-existent
`transition_duration` argument from an old iteration of the API. It's
confusing.

## Solution

Remove the offending sentence.
This commit is contained in:
Tim Siegel 2023-12-13 13:51:34 -05:00 committed by GitHub
parent 9c78128e8f
commit 1ab0f28acd
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 0 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
crates/bevy_animation/src/lib.rs
View File

@ -285,8 +285,6 @@ impl AnimationPlayer {
} }
/// Start playing an animation, resetting state of the player, unless the requested animation is already playing. /// Start playing an animation, resetting state of the player, unless the requested animation is already playing.
/// If `transition_duration` is set, this will use a linear blending
/// between the previous and the new animation to make a smooth transition
pub fn play(&mut self, handle: Handle<AnimationClip>) -> &mut Self { pub fn play(&mut self, handle: Handle<AnimationClip>) -> &mut Self {
if !self.is_playing_clip(&handle) || self.is_paused() { if !self.is_playing_clip(&handle) || self.is_paused() {
self.start(handle); self.start(handle);