Struct ark_api::world::AnimationBuilder

pub struct AnimationBuilder<T> { /* private fields */ }

An AnimationBuilder is used to build an animation for a component value.

Set options on it such as curve / easing type, delay, target and finally submit the animation.

Note: bools and integers (also all kinds of entity references) will be set to their target directly, however delay can be used to delay the set of the value.

Implementations

impl<T> AnimationBuilder<T> where
    ValueConverter: ValueConverterTrait<T>, 

pub fn new(accessor: &ValueAccessorReadWriteAnimate<T>) -> Self

Creates an AnimationBuilder from a ValueAccessor.

pub fn delay(&mut self, seconds: f32) -> &mut Self

Sets the delay of the animation (how long to wait before it starts)

pub fn target(&mut self, target: T, duration: f32) -> &mut Self

Sets the target value that the animated value will approach.

pub fn curve(&mut self, curve: AnimationCurve) -> &mut Self

Sets the curve shape of the value animation.

pub fn loop_count(&mut self, loop_count: u32) -> &mut Self

Sets the number of times the animation will loop. 0 is currently undefined.

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

Sets the method of smoothing when the animation target changes.

pub fn enqueue(&mut self) -> &mut Self

Enqueues the animation instead of cancelling a currently on-going animation (if any).

pub fn submit(&self)

Finalizes the animation.

pub fn submit_messenger(
    &self,
    callback: Option<Box<dyn FnMut(&AnimationReplyType) + 'static>>
)

Finalizes the animation.

Also gives you the opportunity to pass in a callback that will be called once the animation is finished. For this to work, you must call entity_messenger().process_messages() from your world_update function.

Trait Implementations

impl<T> Deref for AnimationBuilder<T> where
    ValueConverter: ValueConverterTrait<T>, 

type Target = AnimationRequest

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.