Struct Main

pub struct Main;

The schedule that contains the app logic that is evaluated each tick of App::update().

By default, it will run the following schedules in the given order:

On the first run of the schedule (and only on the first run), it will run:

• StateTransition ¹
  • This means that OnEnter(MyState::Foo) will be called before PreStartup if MyState was added to the app with MyState::Foo as the initial state, as well as OnEnter(MyComputedState) if it computes to Some(Self) in MyState::Foo.
  • If you want to run systems before any state transitions, regardless of which state is the starting state, for example, for registering required components, you can add your own custom startup schedule before StateTransition. See MainScheduleOrder::insert_startup_before for more details.
• PreStartup
• Startup
• PostStartup

Then it will run:

• First
• PreUpdate
• StateTransition ¹
• RunFixedMainLoop
  • This will run FixedMain zero to many times, based on how much time has elapsed.
• Update
• PostUpdate
• Last

Rendering

Note rendering is not executed in the main schedule by default. Instead, rendering is performed in a separate SubApp which exchanges data with the main app in between the main schedule runs.

See RenderPlugin and PipelinedRenderingPlugin for more details.

---

1. StateTransition is inserted only if you have bevy_state feature enabled. It is enabled in default features. ↩

Implementations

impl Main

pub fn run_main(world: &mut World, run_at_least_once: Local<'_, bool>)

A system that runs the “main schedule”

Trait Implementations

impl Clone for Main

fn clone(&self) -> Main

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Main

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

Formats the value using the given formatter.

impl Default for Main

fn default() -> Main

Returns the “default value” for a type.

impl Hash for Main

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Main

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl ScheduleLabel for Main

where Self: 'static + Send + Sync + Clone + Eq + Debug + Hash,

fn dyn_clone(&self) -> Box<dyn ScheduleLabel>

Clones this ScheduleLabel.

fn as_dyn_eq(&self) -> &dyn DynEq

Casts this value to a form where it can be compared with other type-erased values.

fn dyn_hash(&self, state: &mut dyn Hasher)

Feeds this value into the given Hasher.

fn intern(&self) -> Interned<dyn ScheduleLabel>

where Self: Sized,

Returns an Interned value corresponding to self.

impl Eq for Main

impl StructuralPartialEq for Main