Struct benimator::SpriteSheetAnimationState
source · [−]pub struct SpriteSheetAnimationState { /* private fields */ }
Expand description
Animation state component which is automatically inserted/removed
It can be used to reset the animation state.
Example
fn restart_anim_from_start(mut query: Query<&mut SpriteSheetAnimationState>) {
for mut state in query.iter_mut() {
state.reset();
}
}
Implementations
sourceimpl SpriteSheetAnimationState
impl SpriteSheetAnimationState
sourcepub fn reset(&mut self)
pub fn reset(&mut self)
Reset animation state
The animation will restart from the first frame, like if the animation was freshly spawned.
sourcepub fn animation_frame_index(&self) -> usize
pub fn animation_frame_index(&self) -> usize
Returns the index of the current animation frame
The index is relative to the animation sequence. not to the sprite-sheet.
sourcepub fn sprite_frame_index(&self, animation: &SpriteSheetAnimation) -> usize
pub fn sprite_frame_index(&self, animation: &SpriteSheetAnimation) -> usize
Returns the index of the current sprite frame
The index is relative to the sprite atlas. not to the animation frame sequence.
Trait Implementations
sourceimpl Component for SpriteSheetAnimationState where
Self: Send + Sync + 'static,
impl Component for SpriteSheetAnimationState where
Self: Send + Sync + 'static,
type Storage = TableStorage
sourceimpl Default for SpriteSheetAnimationState
impl Default for SpriteSheetAnimationState
sourcefn default() -> SpriteSheetAnimationState
fn default() -> SpriteSheetAnimationState
Returns the “default value” for a type. Read more
Auto Trait Implementations
impl RefUnwindSafe for SpriteSheetAnimationState
impl Send for SpriteSheetAnimationState
impl Sync for SpriteSheetAnimationState
impl Unpin for SpriteSheetAnimationState
impl UnwindSafe for SpriteSheetAnimationState
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<T> Downcast for T where
T: Any,
impl<T> Downcast for T where
T: Any,
fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
Convert Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
. Read more
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
Convert Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
. Read more
fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
Convert &Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s. Read more
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Convert &mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s. Read more
sourceimpl<T> FromWorld for T where
T: Default,
impl<T> FromWorld for T where
T: Default,
sourcefn from_world(_world: &mut World) -> T
fn from_world(_world: &mut World) -> T
Creates Self
using data from the given World
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
fn vzip(self) -> V
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more