Struct Module

pub struct Module { /* private fields */ }

A component of a Storyboard

Storyboards, in osb, are split into different components called Modules. This allows the storyboarder to have the good practice of splitting a Storyboard into different parts efficiently.

In terms of scalabitily, this allows anyone to create, share and import Modules of any kind. Everyone can publish their own Module to crates.io and anyone can use them.

This forces the storyboarder to initialize and push Modules properly onto their Storyboards. It is recommended to create a function for each new Module or create a file of its own depending on the complexity of your module.

A Module is tied to a Layer and cannot be changed.

Implementations

impl Module

pub fn new(layer: Layer) -> Self

Initializes a new Module

Examples found in repository

examples/module.rs (line 4)

fn module() -> Module {
    let mut module = Module::new(Layer::Background);

    let mut sprite = Sprite::new("res/sprite.png");
    sprite.move_((0, 320, 240));
    module.push(sprite);

    module
}

pub fn push(&mut self, sprite: Sprite)

Adds a Sprite to a Module

Usage:

use osb::{Layer, Module, Sprite};
let mut module = Module::new(Layer::Background);
let mut sprite = Sprite::new("res/sprite.png");
module.push(sprite);

Examples found in repository

examples/module.rs (line 8)

fn module() -> Module {
    let mut module = Module::new(Layer::Background);

    let mut sprite = Sprite::new("res/sprite.png");
    sprite.move_((0, 320, 240));
    module.push(sprite);

    module
}

pub fn output(&self) -> String

Returns the contents of the Module

Warning: this method is not meant to be used

pub fn layer(&self) -> Layer

Returns the layer of the Module

Example:

use osb::{Layer, Module};
let mut module = Module::new(Layer::Background);
assert_eq!(module.layer(), Layer::Background);