Struct bones_lib::ecs::stage::SystemStagesBuilder

pub struct SystemStagesBuilder { /* private fields */ }
Expand description

Builder for SystemStages. It is immutable once created,

Implementations§

§

impl SystemStagesBuilder

pub fn with_core_stages() -> SystemStagesBuilder

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) -> SystemStagesBuilder

Create SystemStagesBuilder by taking existing SystemStages.

pub fn add_startup_system<Args, S>( &mut self, system: S, ) -> &mut SystemStagesBuilder
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 SystemStagesBuilder
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 SystemStagesBuilder
where 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 SystemStagesBuilder
where 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 SystemStagesBuilder
where L: StageLabel, S: SystemStage + 'static,

Insert a new stage, after another existing stage

pub fn insert_startup_resource<T>(&mut self, resource: T)
where T: HasSchema,

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>(&mut self) -> RefMut<'_, T>
where T: HasSchema + Default,

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>(&self) -> Option<RefMut<'_, T>>
where T: HasSchema,

Get mutable reference to startup resource if found.

Trait Implementations§

§

impl Default for SystemStagesBuilder

§

fn default() -> SystemStagesBuilder

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> FromWorld for T
where T: Default,

§

fn from_world(_world: &World) -> T

Creates Self using data from the given World.
§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> RawDefault for T
where T: Default,

§

unsafe fn raw_default(dst: *mut c_void)

Write the default value of the type to the pointer. Read more
§

fn raw_default_cb() -> Unsafe<&'static (dyn Fn(*mut c_void) + Send + Sync)>

Get a callback suitable for [SchemaData].
§

impl<T> RawDrop for T

§

unsafe fn raw_drop(ptr: *mut c_void)

Write the default value of the type to the pointer. Read more
§

fn raw_drop_cb() -> Unsafe<&'static (dyn Fn(*mut c_void) + Send + Sync)>

Get a callback suitable for [SchemaData].
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more