Enum bevy::ecs::schedule::ShouldRun

pub enum ShouldRun {
    Yes,
    No,
    YesAndCheckAgain,
    NoAndCheckAgain,
}

Determines whether a system should be executed or not, and how many times it should be ran each time the stage is executed.

A stage will loop over its run criteria and systems until no more systems need to be executed and no more run criteria need to be checked.

• Any systems with run criteria that returns Yes will be ran exactly one more time during the stage’s execution that tick.
• Any systems with run criteria that returns No are not ran for the rest of the stage’s execution that tick.
• Any systems with run criteria that returns YesAndCheckAgain will be ran during this iteration of the loop. After all the systems that need to run are ran, that criteria will be checked again.
• Any systems with run criteria that returns NoAndCheckAgain will not be ran during this iteration of the loop. After all the systems that need to run are ran, that criteria will be checked again.

Variants

Yes

Yes, the system should run one more time this tick.

No

No, the system should not run for the rest of this tick.

YesAndCheckAgain

Yes, the system should run, and after all systems in this stage have run, the criteria should be checked again. This will cause the stage to loop over the remaining systems and criteria this tick until they no longer need to be checked.

NoAndCheckAgain

No, the system should not run right now, but after all systems in this stage have run, the criteria should be checked again. This will cause the stage to loop over the remaining systems and criteria this tick until they no longer need to be checked.

Implementations

impl ShouldRun

pub fn once(ran: Local<'_, bool>) -> ShouldRun

A run criterion which returns ShouldRun::Yes exactly once.

This leads to the systems controlled by it only being executed one time only.

Trait Implementations

impl Clone for ShouldRun

fn clone(&self) -> ShouldRun

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ShouldRun

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

Formats the value using the given formatter.

impl From<bool> for ShouldRun

fn from(value: bool) -> ShouldRun

Converts to this type from the input type.

impl PartialEq<ShouldRun> for ShouldRun

fn eq(&self, other: &ShouldRun) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for ShouldRun

impl Eq for ShouldRun

impl StructuralEq for ShouldRun

impl StructuralPartialEq for ShouldRun