Struct bevy_animations::SingleFrameAnimation
source · pub struct SingleFrameAnimation {
pub blocking: bool,
pub blocking_priority: i32,
pub blocking_timer: AnimationTimer,
pub blocking_finished: bool,
pub frame: Vec2,
/* private fields */
}
Expand description
Single Frame Animations. These are easy versatile animations to add to any entity or FX animation
§Example
fn init_animation(
mut animations: ResMut<Animations>,
mut commands: Commands,
asset_server: ResMut<AssetServer>,
mut texture_atlases: ResMut<Assets<TextureAtlas>>,
) {
let asset = asset_server.load("path/to/your/sprite_sheet");
let texture_atlas = TextureAtlas::from_grid(asset, Vec2::new(16.0, 16.0), 10, 1, None, None);
let texture_atlas_handle = texture_atlases.add(texture_atlas);
let entity = commands
.spawn(AnimationDirection::default())
.insert(SpriteSheetBundle {
texture_atlas: texture_atlas_handle.clone(),
..Default::default()
})
.id();
animations.insert_animation(
NewAnimation {
handle: texture_atlas_handle.clone(), /* the handle for the TextureAtlas */
animation: AnimationType::SingleFrame(
SingleFrameAnimation::new(
0, /* x_index_pos */
AnimationDirectionIndexes::IndexBased(FlipBased {
/* direction_indexes */
x_direction_is_flipped: true,
x_direction_index: 0,
}),
true, /* blocking */
1, /* blocking_priority */
0.25, /* blocking_duration_in_sec */
Vec2::new(4., 4.), /* frame */
),
"jump_start", /* AnimationName */
),
},
Some(entity), /* specify an entity to add the animation to now instead of later */
)
}
Fields§
§blocking: bool
§blocking_priority: i32
§blocking_timer: AnimationTimer
§blocking_finished: bool
§frame: Vec2
Implementations§
source§impl SingleFrameAnimation
impl SingleFrameAnimation
pub fn new( x_index_pos: usize, direction_indexes: AnimationDirectionIndexes, blocking: bool, blocking_priority: i32, blocking_duration_in_sec: f32, frame: Vec2 ) -> Self
pub fn cycle_animation( &mut self, sprite: Mut<'_, Sprite>, texture_atlas: Mut<'_, TextureAtlas>, direction: &AnimationDirection, delta: Duration )
pub fn sprite_index(&self, direction: &AnimationDirection) -> usize
pub fn reset_animation( &mut self, sprite: Option<Mut<'_, Sprite>>, _direction: Option<&AnimationDirection> )
Trait Implementations§
source§impl Clone for SingleFrameAnimation
impl Clone for SingleFrameAnimation
source§fn clone(&self) -> SingleFrameAnimation
fn clone(&self) -> SingleFrameAnimation
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moresource§impl Debug for SingleFrameAnimation
impl Debug for SingleFrameAnimation
source§impl Default for SingleFrameAnimation
impl Default for SingleFrameAnimation
source§fn default() -> SingleFrameAnimation
fn default() -> SingleFrameAnimation
Returns the “default value” for a type. Read more
Auto Trait Implementations§
impl Freeze for SingleFrameAnimation
impl RefUnwindSafe for SingleFrameAnimation
impl Send for SingleFrameAnimation
impl Sync for SingleFrameAnimation
impl Unpin for SingleFrameAnimation
impl UnwindSafe for SingleFrameAnimation
Blanket Implementations§
source§impl<T, U> AsBindGroupShaderType<U> for T
impl<T, U> AsBindGroupShaderType<U> for T
source§fn as_bind_group_shader_type(&self, _images: &RenderAssets<Image>) -> U
fn as_bind_group_shader_type(&self, _images: &RenderAssets<Image>) -> U
Return the
T
ShaderType
for self
. When used in AsBindGroup
derives, it is safe to assume that all images in self
exist.source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
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
.source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Convert
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.source§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.source§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.source§impl<T> DowncastSync for T
impl<T> DowncastSync for T
source§impl<S> FromSample<S> for S
impl<S> FromSample<S> for S
fn from_sample_(s: S) -> S
source§impl<T> FromWorld for Twhere
T: Default,
impl<T> FromWorld for Twhere
T: Default,
source§fn from_world(_world: &mut World) -> T
fn from_world(_world: &mut World) -> T
Creates
Self
using data from the given World
.