Struct ambient_api::animation::AnimationPlayerRef

pub struct AnimationPlayerRef(pub EntityId);

This plays animations, and can handle blending and masking of animations together to create complex effects. A single animation player can be attached to multiple entities in the scene.

This is just a reference to an entity which lives in the ecs. You need to call despawn to remove it.

Tuple Fields

0: EntityId

Implementations

impl AnimationPlayerRef

pub fn new(root: impl AsRef<AnimationNodeRef>) -> AnimationPlayerRef

Create a new animation player, with root as the currently playing node

pub fn play( &self, node: impl AsRef<AnimationNodeRef> ) -> Option<AnimationNodeRef>

Replaces the current root node of the animation player with a new node

pub fn despawn(self)

Despawn this animation player. Note that dropping this player won’t despawn it automatically; only call this method will despawn it.

Trait Implementations

impl Clone for AnimationPlayerRef

fn clone(&self) -> AnimationPlayerRef

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AnimationPlayerRef

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

Formats the value using the given formatter.

impl Copy for AnimationPlayerRef