[][src]Module bevy::ecs

Bevy's entity-component-system.

Modules

bevy_utils
lazy_static

A macro for declaring lazily evaluated statics.

prelude

Macros

impl_query_set
smaller_tuples_too

Imagine macro parameters, but more like those Russian dolls.

Structs

Added

Query transformer that retrieves components of type T that have been added since the start of the frame.

Archetype

A collection of entities having the same component types

ArchetypeComponent
ArchetypesGeneration

Determines freshness of information derived from World::archetypes

AtomicBorrow

Atomically enforces Rust-style borrow checking at runtime

Batch

A sequence of entities yielded by BatchedIter

BatchedIter

Batched version of QueryIter

BuiltEntity

The output of an EntityBuilder, suitable for passing to World::spawn or World::insert

ChainSystem
Changed

Query transformer that retrieves components of type T that have either been mutated or added since the start of the frame.

ChangedRes

A shared borrow of a Resource that will only return in a query if the Resource has been changed

Commands

A list of commands that will be run to populate a World and Resources.

ComponentFlags
Entity

Lightweight unique ID of an entity

EntityBuilder

Helper for incrementally constructing a bundle of components with dynamic component types

EntityMap
EntityReserver

Reserves entities in a way that is usable in multi-threaded contexts.

FetchArcCommands
FetchChangedRes
FetchCommands
FetchLocal
FetchOr
FetchParamTuple
FetchQuery
FetchQuerySet
FetchRes
FetchResMut
FuncSystem
In
InputFuncSystem
Insert
InsertResource
Local

Local resources are unique per-system. Two instances of the same system will each have their own resource. Local resources are automatically initialized using the FromResources trait.

Location

A location of an entity in an archetype

MissingComponent

Error indicating that an entity did not have a required component

Mut

Unique borrow of an entity's component

Mutated

Query transformer that retrieves components of type T that have been mutated since the start of the frame. Added components do not count as mutated.

NoSuchEntity

Error indicating that no entity with a particular ID exists

Or
ParIter

Parallel version of QueryIter

ParallelSystemStageExecutor

Executes the stage in parallel by analyzing system dependencies. System execution order is undefined except under the following conditions:

Query

Provides scoped access to a World according to a given [HecsQuery]

QueryIter

Iterator over the set of entities with the components in Q

QuerySet
Ref

Shared borrow of an entity's component

RefMut

Unique borrow of an entity's component

Res

Shared borrow of a Resource

ResMut

Unique borrow of a Resource

ResourceRef

Shared borrow of an entity's component

ResourceRefMut

Unique borrow of a resource

Resources

A collection of resource instances identified by their type.

RunOnce
Schedule
SerialSystemStageExecutor
SpawnBatchIter

Entity IDs created by World::spawn_batch

State
StateStage
SystemId
SystemStage
SystemState
ThreadLocalSystemFn
TypeAccess

Provides information about the types a [System] reads and writes

TypeInfo

Metadata required to store a component

TypeState

Metadata about a type stored in an archetype

VecResourceStorage
With
Without
World

An unordered collection of entities, each having any number of distinctly typed components

WorldBuilder

Modify a World using the builder pattern

Enums

ComponentError

Errors that arise when accessing components

MapEntitiesError
QueryAccess
QueryError

An error that occurs when using a Query

ResourceIndex
ShouldRun
StageError
StateError
ThreadLocalExecution

Determines the strategy used to run the run_thread_local function in a System

Traits

Bundle

A statically typed collection of components

Command

A World mutation

Component

Types that can be components, implemented automatically for all Send + Sync + 'static types

DynamicBundle

A dynamically typed collection of components

EntityFilter
Fetch

Streaming iterators over contiguous homogeneous ranges of components

FetchSystemParam
FromResources

Creates Self using data from the Resources collection

IntoChainSystem
IntoSystem
MapEntities
QueryFilter
QueryTuple
ReadOnlyFetch

A fetch that is read only. This should only be implemented for read-only fetches.

Resource

A Resource type

ResourcesWriter
Stage
System

An ECS system that can be added to a Schedule

SystemParam
SystemStageExecutor
WorldBuilderSource

Converts a reference to Self to a WorldBuilder

WorldQuery

A collection of component types to fetch from a World

Functions

clear_trackers_system

Derive Macros

Bundle

Implement Bundle for a monomorphic struct

SystemParam