Crate app 

This crate is about everything concerning the highest-level, application layer of a Bevy app.

Modules

ctrlc

Cross platform handling of Ctrl-C signals.

prelude

The app prelude.

Macros

plugin_group

A macro for generating a well-documented PluginGroup from a list of Plugin paths.

Structs

AnimationSystems

Animation system set. This exists in PostUpdate.

App

App is the primary API for writing user applications. It automates the setup of a standard lifecycle and provides interface glue for plugins.

First

Runs first in the schedule.

FixedFirst

Runs first in the FixedMain schedule.

FixedLast

The schedule that runs last in FixedMain

FixedMain

The schedule that contains systems which only run after a fixed period of time has elapsed.

FixedMainScheduleOrder

Defines the schedules to be run for the FixedMain schedule, including their order.

FixedPostUpdate

The schedule that runs after the FixedUpdate schedule, for reacting to changes made in the main update logic.

FixedPreUpdate

The schedule that contains logic that must run before FixedUpdate.

FixedUpdate

The schedule that contains most gameplay logic, which runs at a fixed rate rather than every render frame. For logic that should run once per render frame, use the Update schedule instead.

HierarchyPropagatePlugin

Plugin to automatically propagate a component value to all direct and transient relationship targets (e.g. bevy_ecs::hierarchy::Children) of entities with a Propagate component.

Inherited

Internal struct for managing propagation

Last

Runs last in the schedule.

Main

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

MainScheduleOrder

Defines the schedules to be run for the Main schedule, including their order.

MainSchedulePlugin

Initializes the Main schedule, sub schedules, and resources for a given App.

PanicHandlerPlugin

Adds sensible panic handlers to Apps. This plugin is part of the DefaultPlugins. Adding this plugin will setup a panic hook appropriate to your target platform:

PluginGroupBuilder

Facilitates the creation and configuration of a PluginGroup.

PostStartup

The schedule that runs once after Startup.

PostUpdate

The schedule that contains logic that must run after Update. For example, synchronizing “local transforms” in a hierarchy to “global” absolute transforms. This enables the PostUpdate transform-sync system to react to “local transform” changes in Update without the Update systems needing to know about (or add scheduler dependencies for) the “global transform sync system”.

PreStartup

The schedule that runs before Startup.

PreUpdate

The schedule that contains logic that must run before Update. For example, a system that reads raw keyboard input OS events into a Messages resource. This enables systems in Update to consume the messages from the Messages resource without actually knowing about (or taking a direct scheduler dependency on) the “os-level keyboard event system”.

Propagate

Causes the inner component to be added to this entity and all direct and transient relationship targets. A target with a Propagate<C> component of its own will override propagation from that point in the tree.

PropagateOver

Stops the output component being added to this entity. Relationship targets will still inherit the component from this entity or its parents.

PropagateSet

The set in which propagation systems are added. You can schedule your logic relative to this set.

PropagateStop

Stops the propagation at this entity. Children will not inherit the component.

RunFixedMainLoop

Runs the FixedMain schedule in a loop according until all relevant elapsed time has been “consumed”.

ScheduleRunnerPlugin

Configures an App to run its Schedule according to a given RunMode.

SpawnScene

The schedule that contains scene spawning.

Startup

The schedule that runs once when the app starts.

SubApp

A secondary application with its own World. These can run independently of each other.

SubApps

The collection of sub-apps that belong to an App.

TaskPoolOptions

Helper for configuring and creating the default task pools. For end-users who want full control, set up TaskPoolPlugin

TaskPoolPlugin

Setup of default task pools: AsyncComputeTaskPool, ComputeTaskPool, IoTaskPool.

TaskPoolThreadAssignmentPolicy

Defines a simple way to determine how many threads to use given the number of remaining cores and number of total cores

TerminalCtrlCHandlerPlugin

Gracefully handles Ctrl+C by emitting a AppExit event. This plugin is part of the DefaultPlugins.

Update

The schedule that contains any app logic that must run once per render frame. For most gameplay logic, consider using FixedUpdate instead.

Enums

AppExit

A Message that indicates the App should exit. If one or more of these are present at the end of an update, the runner will end and (maybe) return control to the caller.

PluginsState

Plugins state in the application

RunFixedMainLoopSystems

Set enum for the systems that want to run inside RunFixedMainLoop, but before or after the fixed update logic. Systems in this set will run exactly once per frame, regardless of the number of fixed updates. They will also run under a variable timestep.

RunMode

Determines the method used to run an App’s Schedule.

Traits

AppLabel

A strongly-typed class of labels used to identify an App.

DynEq

An object safe version of Eq. This trait is automatically implemented for any 'static type that implements Eq.

Plugin

A collection of Bevy app logic and configuration.

PluginGroup

Combines multiple Plugins into a single unit.

Plugins

Types that represent a set of Plugins.

Functions

propagate_inherited

add/remove Inherited::<C> for targets of entities with modified Inherited::<C>

propagate_output

add C to entities with Inherited::<C>

update_reparented

add/remove Inherited::<C> and C for entities which have changed relationship

update_source

add/remove Inherited::<C> and C for entities with a direct Propagate::<C>

update_stopped

remove Inherited::<C> and C for entities with a PropagateStop::<C>

Type Aliases

AnimationDeprecated

Deprecated alias for AnimationSystems.

InternedAppLabel

A shorthand for Interned<dyn AppLabel>.

RunFixedMainLoopSystemDeprecated

Deprecated alias for RunFixedMainLoopSystems.

Derive Macros

AppLabel

Generates an impl of the AppLabel trait.