Struct dx::engine::d2::swf::MoviePlayer

pub struct MoviePlayer {
    pub inner: Component,
    pub movie: Option<MovieSprite>,
    pub looping: bool,
    /* private fields */
}

A convenient controller to play though multiple different movies. Designed for characters and objects that have a separate Flump symbol for each of their animations, and need to switch between them. The played movies will be added to a new child entity of the owner.

Fields

inner: Component

movie: Option<MovieSprite>

The movie currently being shown.

looping: bool

Whether the current movie is being looped.

Implementations

impl MoviePlayer

pub fn new(lib: Library) -> Self

pub fn set_cache(&mut self, cache: bool) -> &Self

Configures whether this MoviePlayer will keep a cache of all its MovieSprites, rather than creating a new instance for each play. This makes switching movies faster, at the expense of memory. By default, the cache is enabled. If this MoviePlayer plays lots of different movies, but doesn’t match through them too often, consider disabling the cache. @returns This instance, for chaining.

pub fn set_decorator(
    &mut self,
    decorator: Option<Rc<dyn Fn(MovieSprite)>>
) -> &Self

Configures the callback used to decorate newly created MovieSprites, if any. This can be used to dress up avatars or other custom initialization. @returns This instance, for chaining.

pub fn play(&mut self, name: String, restart: bool) -> &Self

Shows a movie that plays once. When it completes, the last looping movie is returned to. It is an error to call this without starting a loop() first. @param name The symbol name of the movie to play. @param restart If this movie is already being played, whether it will restart it from the beginning. @returns This instance, for chaining.

pub fn play_with_loop(&mut self, name: String, restart: bool) -> &Self

Shows a movie that loops forever. @param name The symbol name of the movie to loop. @param restart If this movie is already being looped, whether it will restart it from the beginning. @returns This instance, for chaining.

pub fn on_added(&self)

pub fn on_removed(&mut self)

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

Trait Implementations

impl AsRef<Component> for MoviePlayer

fn as_ref(&self) -> &Component

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

impl AsRef<MoviePlayer> for Entity

fn as_ref(&self) -> &MoviePlayer

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

impl Clone for MoviePlayer

fn clone(&self) -> MoviePlayer

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MoviePlayer

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

Formats the value using the given formatter.

impl Default for MoviePlayer

fn default() -> MoviePlayer

Returns the “default value” for a type.

impl EntityManager<MoviePlayer> for Entity

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

impl PartialEq<MoviePlayer> for MoviePlayer

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 !=.