Struct AnimationPlayer 

pub struct AnimationPlayer { /* private fields */ }

Plays clips (looping, or once) on the AnimationBones below its entity, blending smoothly from one clip to the next.

Implementations

impl AnimationPlayer

pub fn play(&mut self, clip: Handle<AnimationClip>) -> &mut Self

Plays clip right away, from its start.

pub fn play_once(&mut self, clip: Handle<AnimationClip>, fade: f32) -> &mut Self

Blends to clip over fade seconds and plays it once, from its start (even if it is already playing), holding its last pose. See Self::is_finished.

pub fn is_finished(&self) -> bool

Whether the clip played once is over.

pub fn crossfade( &mut self, clip: Handle<AnimationClip>, duration: f32, ) -> &mut Self

Blends from the current clip to clip over duration seconds. Keeps playing if clip is already the active clip.

pub fn set_speed(&mut self, speed: f32) -> &mut Self

Playback speed of the active clip (1 = authored speed).

pub fn stop(&mut self)

Stops animating: the bones go back to their rest pose.

pub fn is_playing(&self, clip: &Handle<AnimationClip>) -> bool

Trait Implementations

impl Clone for AnimationPlayer

fn clone(&self) -> AnimationPlayer

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Component for AnimationPlayer

where Self: Send + Sync + 'static,

const STORAGE_TYPE: StorageType = ::bevy::ecs::component::StorageType::Table

A constant indicating the storage type used for this component.

type Mutability = Mutable

A marker type to assist Bevy with determining if this component is mutable, or immutable. Mutable components will have [Component<Mutability = Mutable>], while immutable components will instead have [Component<Mutability = Immutable>].

fn register_required_components( _requiree: ComponentId, required_components: &mut RequiredComponentsRegistrator<'_, '_>, )

Registers required components.

fn clone_behavior() -> ComponentCloneBehavior

Called when registering this component, allowing to override clone function (or disable cloning altogether) for this component.

fn relationship_accessor() -> Option<ComponentRelationshipAccessor<Self>>

Returns [ComponentRelationshipAccessor] required for working with relationships in dynamic contexts.

fn on_add() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_add [ComponentHook] for this [Component] if one is defined.

fn on_insert() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_insert [ComponentHook] for this [Component] if one is defined.

fn on_replace() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_replace [ComponentHook] for this [Component] if one is defined.

fn on_remove() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_remove [ComponentHook] for this [Component] if one is defined.

fn on_despawn() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_despawn [ComponentHook] for this [Component] if one is defined.

fn map_entities<E>(_this: &mut Self, _mapper: &mut E)

where E: EntityMapper,

Maps the entities on this component using the given [EntityMapper]. This is used to remap entities in contexts like scenes and entity cloning. When deriving [Component], this is populated by annotating fields containing entities with #[entities]

impl Debug for AnimationPlayer

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for AnimationPlayer

fn default() -> AnimationPlayer

Returns the “default value” for a type.