Struct components::engine::d2::swf::Library

pub struct Library {
    pub frame_rate: f32,
    /* private fields */
}

An exported Flump library containing movies and bitmaps.

Fields

frame_rate: f32

The original frame rate of movies in this library.

Implementations

impl Library

pub fn new(pack: impl AssetPack, base_dir: String) -> Library

Creates a library using files in an AssetPack. @param baseDir The directory in the pack containing Flump’s library.json and texture atlases.

pub fn from_flipbooks(flipbooks: Vec<Flipbook, Global>) -> Library

Creates a library procedurally using a set of Flipbook definitions. Each flipbook will be converted to a movie that can be instanciated with createMovie(). *

pub fn dispose_files(&self) -> &Library

Disposes the source library.json File used to create this Library. This can free up some memory, if you don’t intend to recreate this Library later from the same AssetPack.

@returns This instance, for chaining.

pub fn symbol(
    &self,
    symbol_name: String
) -> Option<&Rc<dyn Symbol<MovieSprite> + 'static>>

Retrieve a name symbol from this library, or None if not found.

pub fn create_sprite(
    &self,
    symbol_name: String,
    required: bool
) -> Option<Sprite>

Creates a sprite from a symbol name, it’ll either be a movie or a bitmap. @param required If true and the symbol is not in this library, an error is thrown.

pub fn create_movie(
    &self,
    symbol_name: String,
    required: bool
) -> Option<MovieSprite>

Creates a movie sprite from a symbol name. @param required If true and the symbol is not in this library, an error is thrown.

pub fn iter(
    &self
) -> impl Iterator<Item = (&String, &Rc<dyn Symbol<MovieSprite> + 'static>)>

Iterates over all the symbols in this library.

Trait Implementations

impl Clone for Library

fn clone(&self) -> Library

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Library

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

Formats the value using the given formatter.

impl Default for Library

fn default() -> Library

Returns the “default value” for a type.