Struct bones_framework::lib::Session

pub struct Session {
    pub world: World,
    pub stages: SystemStages,
    pub active: bool,
    pub visible: bool,
    pub priority: i32,
    pub runner: Box<dyn SessionRunner>,
}

A bones game. This includes all of the game worlds, and systems.

Fields

world: World

The ECS world for the core.

stages: SystemStages

The system stages.

active: bool

Whether or not this session should have it’s systems run.

visible: bool

Whether or not this session should be rendered.

priority: i32

The priority of this session relative to other sessions in the Game.

runner: Box<dyn SessionRunner>

The session runner to use for this session.

Implementations

impl Session

pub fn new() -> Session

Create an empty Session.

pub fn install_plugin(&mut self, plugin: impl SessionPlugin) -> &mut Session

Install a plugin.

pub fn snapshot(&self) -> World

Snapshot the world state.

This is the same as core.world.clone(), but it is more explicit.

pub fn restore(&mut self, world: &mut World)

Restore the world state.

Re-sets the world state to that of the provided world, which may or may not have been created with snapshot().

This is the same as doing an std::mem::swap on self.world, but it is more explicit.

Methods from Deref<Target = SystemStages>

pub fn run(&mut self, world: &mut World)

Execute the systems on the given world.

pub fn add_startup_system<Args, S>(&mut self, system: S) -> &mut SystemStageswhere S: IntoSystem<Args, (), (), Sys = StaticSystem<(), ()>>,

Add a system that will run only once, before all of the other non-startup systems.

pub fn add_system_to_stage<Args, S>( &mut self, label: impl StageLabel, system: S ) -> &mut SystemStageswhere S: IntoSystem<Args, (), (), Sys = StaticSystem<(), ()>>,

Add a System to the stage with the given label.

pub fn insert_stage_before<L, S>( &mut self, label: L, stage: S ) -> &mut SystemStageswhere L: StageLabel, S: SystemStage + 'static,

Insert a new stage, before another existing stage

pub fn insert_stage_after<L, S>( &mut self, label: L, stage: S ) -> &mut SystemStageswhere L: StageLabel, S: SystemStage + 'static,

Insert a new stage, after another existing stage

Trait Implementations

impl Debug for Session

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

Formats the value using the given formatter.

impl Default for Session

fn default() -> Session

Returns the “default value” for a type.

impl Deref for Session

type Target = SystemStages

The resulting type after dereferencing.

fn deref(&self) -> &<Session as Deref>::Target

Dereferences the value.

impl DerefMut for Session

fn deref_mut(&mut self) -> &mut <Session as Deref>::Target

Mutably dereferences the value.