Struct bones_ecs::stage::SystemStagesBuilder

pub struct SystemStagesBuilder { /* private fields */ }

Builder for SystemStages. It is immutable once created,

Implementations

impl SystemStagesBuilder

pub fn with_core_stages() -> Self

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

pub fn finish(self) -> SystemStages

Finish building and convert to SystemStages

pub fn from_stages(stages: SystemStages) -> Self

Create SystemStagesBuilder by taking existing SystemStages.

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. If wish to reset session and run again, can modify SessionStarted resource in world.

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 insert_startup_resource<T: HasSchema>(&mut self, resource: T)

Insert a startup resource. On stage / session startup (first step), will be inserted into World.

If already exists, will be overwritten.

pub fn init_startup_resource<T: HasSchema + Default>(&mut self) -> RefMut<'_, T>

Init startup resource with default, and return mutable ref for modification. If already exists, returns mutable ref to existing resource.

pub fn startup_resource_mut<T: HasSchema>(&self) -> Option<RefMut<'_, T>>

Get mutable reference to startup resource if found.

Trait Implementations

impl Default for SystemStagesBuilder

fn default() -> Self

Returns the “default value” for a type.