Expand description
Most commonly used re-exported types.
Structs
- A filter on a component that only retains results added after the system last ran.
- The
AnyOf
query parameter fetches entities with any of the component types included in T. - ChangeTrackersDeprecated
WorldQuery
that tracks changes and additions for componentT
. - A filter on a component that only retains results added or mutably dereferenced after the system last ran.
- A
SystemParam
that stores a buffer which gets applied to theWorld
at the end of a stage. This is used internally byCommands
to deferWorld
mutations. - Lightweight identifier of an entity.
- Reads events of type
T
in order and tracks which events have already been read. - Sends events of type
T
. - An event collection that represents the events that occurred within the last two
Events::update
calls. Events can be written to using anEventWriter
and are typically cheaply read using anEventReader
. - Wrapper type to mark a
SystemParam
as an input. - A system local
SystemParam
. - Unique mutable borrow of an entity’s component
- The next state of
State<S>
. - Shared borrow of a non-
Send
resource. - Unique borrow of a non-
Send
resource. - A
SystemSet
that will run withinCoreSet::Update
when this state is active. - A filter that tests if any of the given filters apply.
- An alternative to
Commands
that can be used in parallel contexts, such as those inQuery::par_iter
- A collection of potentially conflicting
SystemParam
s allowed by disjoint access. - Provides scoped access to a
World
state according to a givenWorldQuery
and query filter. - Shared borrow of an entity’s component with access to change detection. Similar to
Mut
but is immutable and so doesn’t require unique access. - A struct used to operate on reflected
Component
of a type. - A struct used to operate on reflected
Resource
of a type. - Shared borrow of a
Resource
. - Unique mutable borrow of a
Resource
. - A collection of systems, and the metadata and executor needed to run them in a certain order under certain conditions.
- Resource that stores
Schedule
s mapped toScheduleLabel
s. - A finite-state machine whose transitions have associated schedules ([
OnEnter(state)
] and [OnExit(state)
]). - Filter that selects entities with a component
T
. - Filter that selects entities without a component
T
. - Stores and exposes operations on entities, components, resources, and their associated metadata.
Traits
- The
Bundle
trait enables insertion and removal ofComponent
s from an entity. - A data type that can be used to store data for an entity.
- A system that determines if one or more scheduled systems should run.
- Types that can read change detection information. This change detection is controlled by
DetectChangesMut
types such asResMut
. - Types that implement reliable change detection.
- A type that can be stored in an
Events<E>
resource You can conveniently access events using theEventReader
andEventWriter
system parameter. - Creates an instance of the type this trait is implemented for using data from the supplied World.
- An extension trait providing the
IntoPipeSystem::pipe
method to pass input from one system into the next. - Conversion trait to turn something into a
System
. - Types that can be converted into a
SystemConfig
. - Types that can convert into a
SystemConfigs
. - Types that can be converted into a
SystemSet
. - Types that can be converted into a
SystemSetConfig
. - Types that can convert into a
SystemSetConfigs
. - A type that can be inserted into a
World
as a singleton. - Types that can define world-wide states in a finite-state machine.
- An ECS system that can be added to a
Schedule
- A trait implemented for all functions that can be used as
System
s. - Types that identify logical groups of systems.
Functions
- Generates a
Condition
-satisfying closure that returnstrue
if there are any entities with the given component type. - If a new state is queued in
NextState<S>
, this system: - Instructs the executor to call
apply_buffers
on the systems that have run but not applied their buffers. - System adapter that utilizes the
bevy_utils::tracing::debug!
macro to print the output of a system. - System adapter that utilizes the
bevy_utils::tracing::error!
macro to print the output of a system. - System adapter that ignores the output of the previous system in a pipe. This is useful for fallible systems that should simply return early in case of an
Err
/None
. - Generates a
Condition
-satisfying closure that returnstrue
if the state machine is currently instate
. - System adapter that utilizes the
bevy_utils::tracing::info!
macro to print system information. - Generates a
Condition
that inverses the result of passed one. - Generates a
Condition
-satisfying closure that returnstrue
if there are any new events of the given type since it was last called. - Generates a
Condition
-satisfying closure that returnstrue
if the resource of the given type has been added since the condition was last checked. - Generates a
Condition
-satisfying closure that returnstrue
if the resource of the given type has had its value changed since the condition was last checked. - Generates a
Condition
-satisfying closure that returnstrue
if the resource of the given type has had its value changed since the condition was last checked. - Generates a
Condition
-satisfying closure that returnstrue
if the resource exists. - Generates a
Condition
-satisfying closure that returnstrue
if the resource of the given type has had its value changed since the condition was last checked. - Generates a
Condition
-satisfying closure that returnstrue
if the resource exists and is equal tovalue
. - Generates a
Condition
-satisfying closure that returnstrue
if the resource of the given type has been removed since the condition was last checked. - Generates a
Condition
-satisfying closure that returnstrue
if the first time the condition is run and false every time after - Generates a
Condition
-satisfying closure that returnstrue
if the state machine changed state. - Generates a
Condition
-satisfying closure that returnstrue
if the state machine exists. - Generates a
Condition
-satisfying closure that returnstrue
if the state machine exists and is currently instate
. - System adapter that unwraps the
Ok
variant of aResult
. This is useful for fallible systems that should panic in the case of an error. - System adapter that utilizes the
bevy_utils::tracing::warn!
macro to print the output of a system.
Derive Macros
- Derive macro generating an impl of the trait
SystemSet
.