Skip to main content

SystemBuilder

Struct SystemBuilder 

Source
pub struct SystemBuilder { /* private fields */ }
Expand description

Builder for declaring a system’s metadata and component access.

Implementations§

Source§

impl SystemBuilder

Source

pub fn new(name: &str) -> Self

Creates a new system builder with the given name.

Source

pub fn phase(self, phase: Phase) -> Self

Sets which tick phase this system runs in.

Source

pub fn every(self, every: u64) -> Self

Sets the frequency divisor.

The system runs when tick_count % every == 0. Default is 1 (every tick).

Source

pub fn reads<T: Component>(self) -> Self

Declares that this system reads a component type.

Source

pub fn writes<T: Component>(self) -> Self

Declares that this system writes a component type.

Source

pub fn budget_ms(self, ms: u64) -> Self

Sets the CPU budget for this system in milliseconds.

When set, the system can check ctx.budget().is_expired() to yield early. Systems without a budget get an unlimited one.

Source

pub fn run<F: FnMut(&mut dyn SystemContext) + Send + 'static>( self, runner: F, ) -> SystemDescriptor

Finalizes the builder and registers the system with a runner.

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.

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.

Source§

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

Source§

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>,

Source§

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.