Expand description
Defines the World
and APIs for accessing it directly.
Re-exports§
pub use crate::change_detection::Mut;
pub use crate::change_detection::Ref;
pub use crate::change_detection::CHECK_TICK_THRESHOLD;
Modules§
- error
- Contains error types returned by bevy’s schedule.
- unsafe_
world_ cell - Contains types that allow disjoint mutable access to a
World
.
Structs§
- Command
Queue - Densely and efficiently stores a queue of heterogenous types implementing
Command
. - Deferred
World - A
World
reference that disallows structural ECS changes. This includes initializing resources, registering components or spawning entities. - Entity
Mut - Provides mutable access to a single entity and all of its components.
- Entity
Ref - A read-only reference to a particular
Entity
and all of its components. - Entity
World Mut - A mutable reference to a particular
Entity
, and the entire world. This is essentially a performance-optimized(Entity, &mut World)
tuple, which caches theEntityLocation
to reduce duplicate lookups. - Filtered
Entity Mut - Provides mutable access to a single entity and some of its components defined by the contained
Access
. - Filtered
Entity Ref - Provides read-only access to a single entity and some of its components defined by the contained
Access
. - Occupied
Entry - A view into an occupied entry in a
EntityWorldMut
. It is part of theEntry
enum. - OnAdd
- Trigger emitted when a component is added to an entity.
- OnInsert
- Trigger emitted when a component is inserted on to to an entity.
- OnRemove
- Trigger emitted when a component is removed from an entity.
- Spawn
Batch Iter - An iterator that spawns a series of entities and returns the ID of each spawned entity.
- Vacant
Entry - A view into a vacant entry in a
EntityWorldMut
. It is part of theEntry
enum. - World
- Stores and exposes operations on entities, components, resources, and their associated metadata.
- WorldId
- A unique identifier for a
World
.
Enums§
- Entry
- A view into a single entity and component in a world, which may either be vacant or occupied.
Constants§
- ON_ADD
- Internal components used by bevy with a fixed component id.
Constants are used to skip
TypeId
lookups in hot paths.ComponentId
forOnAdd
- ON_
INSERT ComponentId
forOnInsert
- ON_
REMOVE ComponentId
forOnRemove