Struct dx::engine::d2::swf::MovieSprite

pub struct MovieSprite {
    pub inner: Sprite,
    pub symbol: MovieSymbol,
    pub speed: AnimatedFloat,
    pub paused: bool,
    /* private fields */
}

An instanced Flump animation.

Fields

inner: Sprite

symbol: MovieSymbol

The symbol this sprite displays.

speed: AnimatedFloat

The playback speed multiplier of this movie, defaults to 1.0. Higher values will play faster. This does not affect the speed of nested child movies, use SpeedAdjuster if you need that.

paused: bool

Whether this movie is currently paused.

Implementations

impl MovieSprite

pub const PAUSED: u32 = 256u32

pub const SKIP_NEXT: u32 = 512u32

pub const NEXT_FLAG: u32 = 1_024u32

pub fn new(symbol: MovieSymbol) -> Self

pub fn layer(&self, name: String, required: bool) -> Option<Entity>

Retrieves a named layer from this movie. Children can be added to the returned entity to add sprites that move with the layer, which for example, can be used to add equipment sprites to an avatar. @param required If true and the layer is not found, an error is thrown.

pub fn on_added(&self)

pub fn on_removed(&mut self)

pub fn on_update(&mut self, dt: f32)

pub fn goto(&mut self, frame: usize)

pub fn position(&self) -> f32

pub fn set_position(&mut self, position: f32)

pub fn paused(&self) -> bool

pub fn set_paused(&mut self, paused: bool)

pub fn looped(&mut self) -> Option<Signal0>

pub fn set_pixel_snapping(&mut self, pixel_snapping: bool)

pub fn rewind(&mut self)

Internal method to set the position to 0 and skip the next update. This is required to modify the playback position of child movies during an update step, so that after the update trickles through the children, they end up at position=0 instead of position=dt.

Trait Implementations

impl AsRef<Sprite> for MovieSprite

fn as_ref(&self) -> &Sprite

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for MovieSprite

fn clone(&self) -> MovieSprite

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MovieSprite

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

Formats the value using the given formatter.

impl Default for MovieSprite

fn default() -> MovieSprite

Returns the “default value” for a type.

impl Display for MovieSprite

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

Formats the value using the given formatter.

impl EntityManager<MovieSprite> for Entity

fn get(&self) -> Option<MovieSprite>

impl PartialEq<MovieSprite> for MovieSprite

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<MovieSprite> for MovieSprite

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Symbol<MovieSprite> for MovieSymbol

fn name(&self) -> Option<String>

The name of this symbol.

fn create_sprite(&self) -> MovieSprite

Instantiate a sprite that displays this symbol.