Struct App 

pub struct App {
    pub world: World,
    /* private fields */
}

The App struct holds all the apps data and defines the necessary functions and methods to operate on it.

Fields

world: World

Implementations

impl App

pub fn new() -> Self

Create a new App

pub fn add_module(&mut self, module: impl Module + 'static)

Add a Module to the App. If it already exists, nothing happens.

Example

use magma_app::{module::Module, App};

let mut app = App::new();
app.add_module(ExampleModule);

struct ExampleModule;

impl Module for ExampleModule {
    fn setup(self, app: &mut App) {
        // Setup the module
        // E.g. register components to the World or add resources
    }
}

pub fn register_schedule<S: AppSchedule + 'static>(&mut self)

Register an AppSchedule.

pub fn run_schedule<S: AppSchedule + 'static>( &self, ) -> Result<(), ScheduleError>

Run an AppSchedule.

pub fn add_systems<S: AppSchedule + 'static>( &mut self, systems: &'static [(fn(&World), &'static str, &'static [&'static str])], ) -> Result<(), ScheduleError>

Add systems to the App’s World. Systems must take an immutable reference to World.

Errors

Returns an error, when the schedule isn’t registered.

Example

use magma_app::{App, World};
use magma_app::schedule::Startup;

let mut app = App::new();
app.add_systems::<Startup>(&[(example_system, "example_system", &[])]).unwrap();

fn example_system(_world: &World) {
    // E.g. change something in the World
}

pub fn register_event<E: Any + Send + Sync + Clone>(&mut self)

pub fn add_event_systems<E: Any + Send + Sync + Clone>( &mut self, systems: &'static [(fn(&World), &'static str, &'static [&'static str])], ) -> Result<(), EventError>

pub fn set_runner(&mut self, runner: fn(App))

Set the runner of the App

pub fn process_events(&self)

Process pending events.

pub fn run(self)

Run the Application

Trait Implementations

impl Default for App

fn default() -> Self

Returns the “default value” for a type.