Struct bones_ecs::stage::SystemStages

pub struct SystemStages {
    pub stages: Vec<Box<dyn SystemStage>>,
    pub has_started: bool,
    pub startup_systems: Vec<StaticSystem<(), ()>>,
    pub single_success_systems: Vec<StaticSystem<(), Option<()>>>,
}

An ordered collection of SystemStages.

Fields

stages: Vec<Box<dyn SystemStage>>

The stages in the collection, in the order that they will be run.

has_started: bool

Whether or not the startup systems have been run yet.

startup_systems: Vec<StaticSystem<(), ()>>

The systems that should run at startup.

single_success_systems: Vec<StaticSystem<(), Option<()>>>

Systems that are continously run until they succeed(return Some). These run before all stages. Uses Option to allow for easy usage of ?.

Implementations

impl SystemStages

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

Execute the systems on the given world.

pub fn with_core_stages() -> Self

Create a SystemStages collection, initialized with a stage for each CoreStage.

pub fn add_startup_system<Args, S>(&mut self, system: S) -> &mut Self

where S: IntoSystem<Args, (), (), Sys = StaticSystem<(), ()>>,

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

pub fn add_single_success_system<Args, S>(&mut self, system: S) -> &mut Self

where S: IntoSystem<Args, (), Option<()>, Sys = StaticSystem<(), Option<()>>>,

Add a system that will run each frame until it succeeds (returns Some). Runs before all stages. Uses Option to allow for easy usage of ?.

pub fn add_system_to_stage<Args, S>( &mut self, label: impl StageLabel, system: S, ) -> &mut Self

where S: IntoSystem<Args, (), (), Sys = StaticSystem<(), ()>>,

Add a System to the stage with the given label.

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

Insert a new stage, before another existing stage

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

Insert a new stage, after another existing stage

pub fn reset_remove_all_systems(&mut self)

Remove all systems from all stages, including startup and single success systems. Resets has_started as well, allowing for startup systems to run once again.

pub fn remove_all_systems(&mut self)

Remove all systems from all stages, including startup and single success systems. Does not reset has_started.

Trait Implementations

impl Debug for SystemStages

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

Formats the value using the given formatter.

impl Default for SystemStages

fn default() -> Self

Returns the “default value” for a type.