Expand description
use bevy::prelude::*;
to import common components, bundles, and plugins.
Modules§
- Adaptors used by the Curve API for transforming and combining curves together.
- Core data structures to be used internally in Curve implementations, encapsulating storage and access patterns for reuse.
- This module holds traits related to extracting derivatives from curves. In applications, the derivatives of interest are chiefly the first and second; in this module, these are provided by the traits
CurveWithDerivative
andCurveWithTwoDerivatives
. - Module containing different easing functions to control the transition between two values and the
EasingCurve
struct to make use of them. - Iterable curves, which sample in the form of an iterator in order to support
Vec
-like output whose length cannot be known statically. - This mod re-exports the correct versions of floating-point operations with unspecified precision in the standard library depending on whether the
libm
crate feature is enabled. - Sample-interpolated curves constructed using the
Curve
API. - A contiguous growable array type with heap-allocated contents, written
Vec<T>
.
Macros§
- Returns a
SpawnRelatedBundle
that will insert theChildren
component, spawn aSpawnableList
of entities with given bundles that relate to theChildren
entity via theChildOf
component, and reserve space in theChildren
for each spawned entity. - Constructs an event at the debug level.
- Call
debug!
once per call site. - Constructs a span at the debug level.
- Constructs an event at the error level.
- Call
error!
once per call site. - Constructs a span at the error level.
- Creates a
String
using interpolation of runtime expressions. - Constructs an event at the info level.
- Call
info!
once per call site. - Constructs a span at the info level.
- Call some expression only once per call site.
- Returns a
SpawnRelatedBundle
that will insert the givenRelationshipTarget
, spawn aSpawnableList
of entities with given bundles that relate to theRelationshipTarget
entity via theRelationshipTarget::Relationship
component, and reserve space in theRelationshipTarget
for each spawned entity. - Constructs an event at the trace level.
- Call
trace!
once per call site. - Constructs a span at the trace level.
- Creates a
Vec
containing the arguments. - Constructs an event at the warn level.
- Call
warn!
once per call site. - Constructs a span at the warn level.
Structs§
- The
GizmoConfigGroup
used for debug visualizations ofAabb
components on entities - A filter on a component that only retains results the first time after they have been added.
- A primitive shape formed by the region between two circles, also known as a ring.
- The
AnyOf
query parameter fetches entities with any of the component types included in T. App
is the primary API for writing user applications. It automates the setup of a standard lifecycle and provides interface glue for plugins.- A
Resource
storingTypeRegistry
for type registrations relevant to a whole app. - A special
System
that instructs the executor to callSystem::apply_deferred
on the systems that have run but not applied theirDeferred
system parameters (likeCommands
) or other system buffers. - A primitive representing an arc between two points on a circle.
- Filter that selects entities with an
A
for an asset that changed after the system last ran, whereA
is a component that implementsAsAssetId
. - Provides “asset” loading and processing functionality. An
Asset
is a “runtime value” that is loaded from anAssetSource
, which can be something like a filesystem, a network, etc. - Loads and tracks the state of
Asset
values from a configuredAssetReader
. This can be used to kick off new asset loads and retrieve their current load states. - Stores the position data of the input devices of type
T
. - A 2-dimensional
bool
vector mask. - A 3-dimensional
bool
vector mask. - A 4-dimensional
bool
vector mask. - A 3-dimensional SIMD vector mask.
- A 4-dimensional SIMD vector mask.
- A pointer type that uniquely owns a heap allocation of type
T
. - A polygon with a variable number of vertices, allocated on the heap in a
Box<[Vec2]>
. - A series of connected line segments in 2D space, allocated on the heap in a
Box<[Vec2]>
. - A series of connected line segments in 3D space, allocated on the heap in a
Box<[Vec3]>
. - A “press-able” input of type
T
. - The defining
Component
for camera entities, storing information about how and what to render through this camera. - A 2D capsule primitive, also known as a stadium or pill shape.
- A 3D capsule primitive centered on the origin A three-dimensional capsule is defined as a surface at a distance (radius) from a line
- The curve that results from chaining one curve with another. The second curve is effectively reparametrized so that its start is at the end of the first.
- A filter on a component that only retains results the first time after they have been added or mutably dereferenced.
- Stores the parent entity of this child entity with this component.
- Tracks which entities are children of this parent entity.
- A circle primitive, representing the set of points some distance from the origin
- A primitive representing a circular sector: a pie slice of a circle.
- A primitive representing a circular segment: the area enclosed by the arc of a circle and its chord (the line between its endpoints).
- A
Resource
that stores the color that is used to clear the screen between frames. - A cone primitive centered on the midpoint between the tip of the cone and the center of its base.
- A conical frustum primitive. A conical frustum can be created by slicing off a section of a cone.
- A curve with a constant value over its domain.
- The curve that results from chaining two curves.
- A convex polygon with
N
vertices. - A spline interpolated continuously across the nearest four control points. The curve does not necessarily pass through any of the control points.
- A spline composed of a single cubic Bezier curve.
- A spline interpolated continuously across the nearest four control points, with the position of the curve specified at every control point and the tangents computed automatically. The associated
CubicCurve
has one segment between each pair of adjacent control points. - A collection of
CubicSegment
s chained into a single parametric curve. It is aCurve
with domain[0, N]
, whereN
is its number of segments. - A spline interpolated continuously between the nearest two control points, with the position and velocity of the curve specified at both control points. This curve passes through all control points, with the specified velocity which includes direction and parametric speed.
- Non-uniform Rational B-Splines (NURBS) are a powerful generalization of the
CubicBSpline
which can represent a much more diverse class of curves (like perfect circles and ellipses). - A segment of a cubic curve, used to hold precomputed coefficients for fast interpolation. It is a
Curve
with domain[0, 1]
. - A cuboid primitive, which is like a cube, except that the x, y, and z dimensions are not required to be the same.
- A curve that has been reparametrized by another curve, using that curve to transform the sample times before sampling. Curves of this type are produced by
CurveExt::reparametrize_by_curve
. - A cylinder primitive centered on the origin
- The default gizmo config group.
- This plugin group will add all the default plugins for a Bevy application:
- A
SystemParam
that stores a buffer which gets applied to theWorld
duringApplyDeferred
. This is used internally byCommands
to deferWorld
mutations. - A normalized vector pointing in a direction in 2D space
- A normalized vector pointing in a direction in 3D space
- A normalized SIMD vector pointing in a direction in 3D space.
- Helper utility to update
TextureAtlasLayout
on the fly. - A
Curve
that is defined by - An ellipse primitive, which is like a circle, but the width and height can be different
- Lightweight identifier of an entity.
- A list of commands that will be run to modify an
Entity
. - Provides mutable access to a single entity and all of its components.
- A read-only reference to a particular
Entity
and all of its components. - A mutable reference to a particular
Entity
, and the entire world. - The data core of a curve derived from evenly-spaced samples. The intention is to use this in addition to explicit or inferred interpolation information in user-space in order to implement curves using
domain
andsample_with
. - Mutably reads events of type
T
keeping track of which events have already been read by each system allowing multiple systems to read the same events. Ideal for chains of systems that all want to modify the same events. - 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
. - Schedule which extract data from the main world and inserts it into the render world.
- A 3D shape representing an extruded 2D
base_shape
. - Runs first in the schedule.
- The fixed timestep game clock following virtual time.
- Runs first in the
FixedMain
schedule. - The schedule that runs last in
FixedMain
- The schedule that runs after the
FixedUpdate
schedule, for reacting to changes made in the main update logic. - The schedule that contains logic that must run before
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. - The curve that results from repeating a curve forever.
- A curve defined by a function together with a fixed domain.
- Stores a connected gamepad’s metadata such as the name and its
GamepadButton
andGamepadAxis
. - Gamepad settings component.
- A component that draws the gizmos of a
GizmoAsset
. - A collection of gizmos.
- A struct that stores configuration for gizmos.
- A struct that stores configuration for gizmos.
- A
SystemParam
for drawing gizmos. GlobalTransform
is an affine transformation from entity-local coordinates to worldspace coordinates.- A curve that is the graph of another curve over its parameter space. Curves of this type are produced by
CurveExt::graph
. - Returns a bool that describes if an entity has the component
T
. - Color in Hue-Saturation-Lightness (HSL) color space with alpha. Further information on this color model can be found on Wikipedia.
- Color in Hue-Saturation-Value (HSV) color space with alpha. Further information on this color model can be found on Wikipedia.
- Color in Hue-Whiteness-Blackness (HWB) color space with alpha. Further information on this color model can be found on Wikipedia.
- A rectangle defined by two opposite corners.
- A 2-dimensional vector.
- A 3-dimensional vector.
- A 4-dimensional vector.
- Adds the
Image
as an asset and makes sure that they are extracted and prepared for the GPU. - A
SystemInput
type which denotes that aSystem
receives a mutable reference to a value of typeT
from its caller. - A
SystemInput
type which denotes that aSystem
receives a read-only reference to a value of typeT
from its caller. - An unbounded plane in 3D space. It forms a separating surface through the origin, stretching infinitely far
- Whether or not an entity is visible in the hierarchy. This will not be accurate until
VisibilityPropagate
runs in thePostUpdate
schedule. - A nonempty closed interval, possibly unbounded in either direction.
- An isometry in two dimensions, representing a rotation followed by a translation. This can often be useful for expressing relative positions and transformations from one position to another.
- An isometry in three dimensions, representing a rotation followed by a translation. This can often be useful for expressing relative positions and transformations from one position to another.
- Color in LAB color space, with alpha
- Runs last in the schedule.
- Color in LCH color space, with alpha
- An infinite line going through the origin along a direction in 2D space.
- An infinite line going through the origin along a direction in 3D space.
- A curve that has had its domain changed by a linear reparameterization (stretching and scaling). Curves of this type are produced by
CurveExt::reparametrize_linear
. - Linear RGB color with alpha.
- A system local
SystemParam
. - The schedule that contains the app logic that is evaluated each tick of
App::update()
. - A curve whose samples are defined by mapping samples from another curve through a given function. Curves of this type are produced by
CurveExt::map
. - A 2x2 column major matrix.
- A 3x3 column major matrix.
- A 4x4 column major matrix.
- A 3x3 column major matrix.
- A 3D object made out of vertices representing triangles, lines, or points, with “attribute” values for each vertex.
- A component for 2D meshes. Requires a
MeshMaterial2d
to be rendered, commonly using aColorMaterial
. - A component for 3D meshes. Requires a
MeshMaterial3d
to be rendered, commonly using aStandardMaterial
. - This plugin group will add the minimal plugins for a Bevy application:
- Controls the morph targets for all child
Mesh3d
entities. In most cases,MorphWeights
should be considered the “source of truth” when writing morph targets for meshes. However you can choose to write childMeshMorphWeights
if your situation requires more granularity. Just note that if you setMorphWeights
, it will overwrite childMeshMorphWeights
values. - Unique mutable borrow of an entity’s component or of a resource.
- Component used to identify an entity. Stores a hash for faster comparisons.
- Convenient query for giving a human friendly name to an entity.
- Shared borrow of a non-
Send
resource. - A dummy type that is
!Send
, to force systems to run on the main thread. - Unique borrow of a non-
Send
resource. - Color in Oklab color space, with alpha
- Color in Oklch color space, with alpha
- Trigger emitted when a component is inserted onto an entity that does not already have that component. Runs before
OnInsert
. Seecrate::component::ComponentHooks::on_add
for more information. - Trigger emitted when a component is inserted, regardless of whether or not the entity already had that component. Runs after
OnAdd
, if it ran. Seecrate::component::ComponentHooks::on_insert
for more information. - Trigger emitted when a component is removed from an entity, and runs before the component is removed, so you can still access the component data. See
crate::component::ComponentHooks::on_remove
for more information. - Trigger emitted when a component is inserted onto an entity that already has that component. Runs before the value is replaced, so you can still access the original component data. See
crate::component::ComponentHooks::on_replace
for more information. - A filter that tests if any of the given filters apply.
- Project a 3D space onto a 2D surface using parallel lines, i.e., unlike
PerspectiveProjection
, the size of objects remains the same regardless of their distance to the camera. - 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. - A 3D camera projection in which distant objects appear smaller than close objects.
- The curve that results from chaining a curve with its reversed version. The transition point is guaranteed to make no jump.
- An unbounded plane in 2D space. It forms a separating surface through the origin, stretching infinitely far
- A bounded plane in 3D space. It forms a surface starting from the origin with a defined height and width.
- A polygon with N vertices.
- A series of connected line segments in 2D space.
- A series of connected line segments in 3D space.
- System parameter that works very much like
Query
except it always contains at least one matching entity. - The schedule that runs once after
Startup
. - The schedule that contains logic that must run after
Update
. For example, synchronizing “local transforms” in a hierarchy to “global” absolute transforms. This enables thePostUpdate
transform-sync system to react to “local transform” changes inUpdate
without theUpdate
systems needing to know about (or add scheduler dependencies for) the “global transform sync system”. - The schedule that runs before
Startup
. - The schedule that contains logic that must run before
Update
. For example, a system that reads raw keyboard input OS events into anEvents
resource. This enables systems inUpdate
to consume the events from theEvents
resource without actually knowing about (or taking a direct scheduler dependency on) the “os-level keyboard event system”. - A quaternion representing an orientation.
- Builder struct to create
QueryState
instances at runtime. - A collection of
RationalSegment
s chained into a single parametric curve. It is aCurve
with domain[0, N]
, whereN
is the number of segments. - A segment of a rational cubic curve, used to hold precomputed coefficients for fast interpolation. It is a
Curve
with domain[0, 1]
. - An infinite half-line starting at
origin
and going indirection
in 2D space. - An infinite half-line starting at
origin
and going indirection
in 3D space. - Real time clock representing elapsed wall clock time.
- A rectangle defined by two opposite corners.
- A rectangle primitive, which is like a square, except that the width and height can be different
- 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
trait of a type. - A struct used to provide the default value of a type.
- A struct used to deserialize reflected instances of a type.
- Type data that represents the
FromReflect
trait and allows it to be used dynamically. - A struct used to operate on the reflected
FromWorld
trait of a type. - A struct used to operate on reflected
Resource
of a type. - A struct used to serialize reflected instances of a type.
- A polygon centered on the origin where all vertices lie on a circle, equally far apart.
- A
SystemParam
that yields entities that had theirT
Component
removed or have been despawned with it. - A curve whose sample space is mapped onto that of some base curve’s before sampling. Curves of this type are produced by
CurveExt::reparametrize
. - The curve that results from repeating a curve
N
times. - Shared borrow of a
Resource
. - Unique mutable borrow of a
Resource
. - The curve that results from reversing another.
- A rhombus primitive, also known as a diamond shape. A four sided polygon, centered on the origin, where opposite sides are parallel but without requiring right angles.
- A counterclockwise 2D rotation.
- Runs the
FixedMain
schedule in a loop according until all relevant elapsed time has been “consumed”. - A curve that is defined by neighbor interpolation over a set of evenly-spaced samples, interpolated automatically using a particularly well-behaved interpolation.
- A curve that is defined by explicit neighbor interpolation over a set of evenly-spaced samples.
- A collection of systems, and the metadata and executor needed to run them in a certain order under certain conditions.
- A line segment defined by two endpoints in 2D space.
- A line segment defined by two endpoints in 3D space.
- A shader, as defined by its
ShaderSource
andShaderStage
This is an “unprocessed” shader. It can contain preprocessor directives. - System parameter that provides access to single entity’s components, much like
Query::single
/Query::single_mut
. - A wrapper over a
Bundle
indicating that an entity should be spawned with thatBundle
. This is intended to be used for hierarchical spawning via traits likeSpawnableList
andSpawnRelated
. - The schedule that contains scene spawning.
- A sphere primitive, representing the set of all points some distance from the origin
- Non-linear standard RGB with alpha.
- The schedule that runs once when the app starts.
- A UTF-8–encoded, growable string.
- A secondary application with its own
World
. These can run independently of each other. - Helper for configuring and creating the default task pools. For end-users who want full control, set up
TaskPoolPlugin
- A tetrahedron primitive.
- An index into a
TextureAtlasLayout
, which corresponds to a specific section of a texture. - A builder which is used to create a texture atlas from many individual sprites.
- Stores a map used to lookup the position of a texture in a
TextureAtlas
. This can be used to either use and look up a specific section of a texture, or animate frame-by-frame as a sprite sheet. - Stores a mapping from sub texture handles to the related area index.
- A generic clock resource that tracks how much it has advanced since its previous update and since its creation.
- Tracks elapsed time. Enters the finished state once
duration
is reached. - A torus primitive, often representing a ring or donut shape The set of points some distance from a circle centered at the origin
- A touch input event.
- A collection of
Touch
es. - Describe the position of an entity. If the entity has a parent, the position is relative to its parent position.
- System parameter for computing up-to-date
GlobalTransform
s. - The base plugin for handling
Transform
components - An optimization for transform propagation. This ZST marker component uses change detection to mark all entities of the hierarchy as “dirty” if any of their descendants have a changed
Transform
. If this component is not markedis_changed()
, propagation will halt. - A triangle in 2D space
- A 3D triangle primitive.
- Type containing triggered
Event
information for a given run of anObserver
. This contains theEvent
data itself. If it was triggered for a specificEntity
, it includes that as well. It also contains event propagation information. SeeTrigger::propagate
for more information. - A rectangle defined by two opposite corners.
- A 2-dimensional vector.
- A 3-dimensional vector.
- A 4-dimensional vector.
- The data core of a curve defined by unevenly-spaced samples or keyframes. The intention is to use this in concert with implicitly or explicitly-defined interpolation in user-space in order to implement the curve interface using
domain
andsample_with
. - A curve that is defined by interpolation over unevenly spaced samples, interpolated automatically using a particularly well-behaved interpolation.
- A curve that is defined by interpolation over unevenly spaced samples with explicit interpolation.
- The schedule that contains any app logic that must run once per render frame. For most gameplay logic, consider using
FixedUpdate
instead. - A contiguous growable array type, written as
Vec<T>
, short for ‘vector’. - A 2-dimensional vector.
- A 3-dimensional vector.
- A 4-dimensional vector.
- A 3-dimensional vector.
- Algorithmically-computed indication of whether an entity is visible and should be extracted for rendering.
- The virtual game clock representing game time.
- 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.
- CIE 1931 color space, also known as XYZ, with an alpha channel.
- A curve that combines the output data from two constituent curves into a tuple output. Curves of this type are produced by
CurveExt::zip
.
Enums§
- Sets how a material’s base color alpha channel is used for transparency.
- Events that occur for a specific loaded
Asset
, such as “value changed” events and “dependency” events. - Controls whether or not assets are pre-processed before being loaded.
- An error indicating that an end-to-end composition couldn’t be performed because of malformed inputs.
- For a camera, specifies the color used to clear the viewport before rendering.
- An enumerated type that can represent any of the color types in this crate.
- An error that happens when creating a
ConvexPolygon
. - Error during construction of
CubicNurbs
- Curve functions over the unit interval, commonly used for easing transitions.
- Euler rotation sequences.
- Represents gamepad input types that are mapped in the range [-1.0, 1.0].
- Represents gamepad input types that are mapped in the range [0.0, 1.0].
- An enum configuring how line joints will be drawn.
- An enum used to configure the style of gizmo lines, similar to CSS line-style
- Error returned if a hex string could not be parsed as a color.
- Configuration options for the
EaseFunction::Steps
curves. This closely replicates the CSS step function specification. - The key code of a
KeyboardInput
. - An error indicating that a linear reparameterization couldn’t be performed because of malformed inputs.
- A button on a mouse device.
- Component for configuring the number of samples for Multi-Sample Anti-Aliasing for a
Camera
. - An error indicating that a ping ponging of a curve couldn’t be performed because of malformed inputs.
- Component that defines how to compute a
Camera
’s projection matrix. - An error indicating that a repetition of a curve couldn’t be performed because of malformed inputs.
- An error indicating that a resampling operation could not be performed because of malformed inputs.
- An error indicating that a reversion of a curve couldn’t be performed because of malformed inputs.
- 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. - An error that occurs when loading a texture.
- Specifies
Timer
behavior. - The type of torus determined by the minor and major radii
- Set enum for the systems relating to transform propagation
- User indication of whether an entity is visible. Propagates down the entity hierarchy.
- The winding order for a set of points
Constants§
- apply_
deferred Deprecated SeeApplyDeferred
.
Traits§
- Methods for manipulating alpha values.
- A extension trait adding
App::init_gizmo_group
andApp::insert_gizmo_config
. - Declares that this type is an asset, which can be loaded and managed by the
AssetServer
and stored inAssets
collections. - Adds asset-related builder methods to
App
. - Collection of methods similar to the built-in parenting methods on
EntityWorldMut
andEntityCommands
, but preserving each entity’sGlobalTransform
. - The
Bundle
trait enables insertion and removal ofComponent
s from an entity. - Trait with methods for converting colors to non-color types
- Trait with methods for converting colors to packed non-color types
- A
World
mutation. - 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.
- A trait for types that contain an
Entity
. - Implement this on cubic splines that can generate a cubic curve from their spline parameters.
- A trait for a type that can represent values of type
T
parametrized over a fixed interval. - Extension trait implemented by curves, allowing access to a number of adaptors and convenience methods.
- Extension trait implemented by curves, allowing access to generic resampling methods as well as those based on stable interpolation.
- Implement this on cubic splines that can generate a cyclic cubic curve from their spline parameters.
- Types that can read change detection information. This change detection is controlled by
DetectChangesMut
types such asResMut
. - Types that implement reliable change detection.
- An extension trait for methods for working with assets directly from a
World
. - A type whose values can be eased between.
- A command which gets executed for a given
Entity
. - Something that “happens” and might be read / observed by app logic.
- A trait that enables types to be dynamically constructed from reflected data.
- Creates an instance of the type this trait is implemented for using data from the supplied
World
. - A convenience trait which combines fetching and downcasting of struct fields.
- A trait which allows nested
Reflect
values to be retrieved with path strings. - A convenience trait which combines fetching and downcasting of tuple struct fields.
- A trait used to create gizmo configs groups.
- A trait for rendering 2D geometric primitives (
P
) withGizmoBuffer
. - A trait for rendering 3D geometric primitives (
P
) withGizmoBuffer
. - Trait for returning a grayscale color of a provided lightness.
- Trait for manipulating the hue of a color.
- Types that can convert into a
ScheduleConfigs
. - Conversion trait to turn something into a
System
. - Types that can be converted into a
SystemSet
. - Methods for changing the luminance of a color. Note that these methods are not guaranteed to produce consistent results across color spaces, but will be within a given space.
- A trait for getting measurements of 2D shapes
- A trait for getting measurements of 3D shapes
- A trait used to build
Mesh
es from a configuration - A trait for shapes that can be turned into a
Mesh
. - Linear interpolation of two colors within a given color space.
- The foundational trait of
bevy_reflect
, used for accessing and modifying data dynamically. - A collection of Bevy app logic and configuration.
- Combines multiple
Plugin
s into a single unit. - A marker trait for 2D primitives
- A marker trait for 3D primitives
- Implement this on cubic splines that can generate a rational cubic curve from their spline parameters.
System
types that do not modify theWorld
when run. This is implemented for any systems whose parameters all implementReadOnlySystemParam
.- A core trait of
bevy_reflect
, used for downcasting to concrete types. - Something that can be interpreted as a reflection path in
GetPath
. - A
Component
containing the collection of entities that relate to thisEntity
via the associatedRelationship
type. See theRelationship
documentation for more information. - A type that can be inserted into a
World
as a singleton. - Trait for manipulating the saturation of a color.
- Exposes methods to uniformly sample a variety of primitive shapes.
- A type with a natural interpolation that provides strong subdivision guarantees.
- A trait used to power struct-like operations via reflection.
- An ECS system that can be added to a
Schedule
- Trait for types that can be used as input to
System
s. - A builder that can create a
SystemParam
. - A trait implemented for all functions that can be used as
System
s. - Types that identify logical groups of systems.
- A generalization of
Clone
to borrowed data. - A trait for converting a value to a
String
. - A trait for point transformation methods.
- A trait used to power tuple struct-like operations via reflection.
- A static accessor to type paths and names.
Functions§
- A
Condition
-satisfying system that returnstrue
if there are any entity with a component of the given type removed. - A
Condition
-satisfying system that returnstrue
if there are any entities that match the givenQueryFilter
. - A
Condition
-satisfying system that returnstrue
if there are any entities with the given component type. - Creates a 2-dimensional
bool
vector mask. - Creates a 3-dimensional
bool
vector mask. - Creates a 4-dimensional
bool
vector mask. - Creates a 3-dimensional
bool
vector mask. - Creates a 4-dimensional
bool
vector mask. - Generates a
Condition
that returns true when the passed one changes. - Generates a
Condition
that returns true when the result of the passed one went from false to true since the last time this was called. - An ergonomic abbreviation for
Default::default()
to make initializing structs easier. - Creates a 2-dimensional vector.
- Creates a 3-dimensional vector.
- Creates a 4-dimensional vector.
- Creates a 2x2 matrix from two column vectors.
- Creates a 3x3 matrix from three column vectors.
- Creates a 4x4 matrix from four column vectors.
- Creates a 3x3 matrix from three column vectors.
- Generates a
Condition
that inverses the result of passed one. - A
Condition
-satisfying system that returnstrue
if there are any new events of the given type since it was last called. - Creates a quaternion from
x
,y
,z
andw
values. - A
Condition
-satisfying system that returnstrue
if the resource of the given type has been added since the condition was last checked. - A
Condition
-satisfying system that returnstrue
if the resource of the given type has had its value changed since the condition was last checked. - A
Condition
-satisfying system that returnstrue
if the resource of the given type has had its value changed since the condition was last checked. - A
Condition
-satisfying system that returnstrue
if the resource exists. - A
Condition
-satisfying system 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
. - A
Condition
-satisfying system that returnstrue
if the resource of the given type has been removed since the condition was last checked. - A
Condition
-satisfying system that returnstrue
on the first time the condition is run and false every time after. - Creates a 2-dimensional vector.
- Creates a 3-dimensional vector.
- Creates a 4-dimensional vector.
- Creates a 2-dimensional vector.
- Creates a 3-dimensional vector.
- Creates a 4-dimensional vector.
- Creates a 3-dimensional vector.
Type Aliases§
- A type alias over
RelatedSpawner
used to spawn child entities containing aChildOf
relationship. - A type alias over
RelatedSpawnerCommands
used to spawn child entities containing aChildOf
relationship. - A result type for use in fallible systems, commands and observers.
Attribute Macros§
- A macro that automatically generates type data for traits, which their implementors can then register.
Derive Macros§
- Derives the
FromReflect
trait. - Implements the
GizmoConfigGroup
trait for a gizmo config group type. - The main derive macro used by
bevy_reflect
for deriving itsReflect
trait. - Derive macro generating an impl of the trait
SystemSet
. - Derives the
TypePath
trait, providing a stable alternative to [std::any::type_name
].