4bca7f1b6d
# Objective Rework / build on #17043 to simplify the implementation. #17043 should be merged first, and the diff from this PR will get much nicer after it is merged (this PR is net negative LOC). ## Solution 1. Command and EntityCommand have been vastly simplified. No more marker components. Just one function. 2. Command and EntityCommand are now generic on the return type. This enables result-less commands to exist, and allows us to statically distinguish between fallible and infallible commands, which allows us to skip the "error handling overhead" for cases that don't need it. 3. There are now only two command queue variants: `queue` and `queue_fallible`. `queue` accepts commands with no return type. `queue_fallible` accepts commands that return a Result (specifically, one that returns an error that can convert to `bevy_ecs::result::Error`). 4. I've added the concept of the "default error handler", which is used by `queue_fallible`. This is a simple direct call to the `panic()` error handler by default. Users that want to override this can enable the `configurable_error_handler` cargo feature, then initialize the GLOBAL_ERROR_HANDLER value on startup. This is behind a flag because there might be minor overhead with `OnceLock` and I'm guessing this will be a niche feature. We can also do perf testing with OnceLock if someone really wants it to be used unconditionally, but I don't personally feel the need to do that. 5. I removed the "temporary error handler" on Commands (and all code associated with it). It added more branching, made Commands bigger / more expensive to initialize (note that we construct it at high frequencies / treat it like a pointer type), made the code harder to follow, and introduced a bunch of additional functions. We instead rely on the new default error handler used in `queue_fallible` for most things. In the event that a custom handler is required, `handle_error_with` can be used. 6. EntityCommand now _only_ supports functions that take `EntityWorldMut` (and all existing entity commands have been ported). Removing the marker component from EntityCommand hinged on this change, but I strongly believe this is for the best anyway, as this sets the stage for more efficient batched entity commands. 7. I added `EntityWorldMut::resource` and the other variants for more ergonomic resource access on `EntityWorldMut` (removes the need for entity.world_scope, which also incurs entity-lookup overhead). ## Open Questions 1. I believe we could merge `queue` and `queue_fallible` into a single `queue` which accepts both fallible and infallible commands (via the introduction of a `QueueCommand` trait). Is this desirable?
165 lines
5.1 KiB
TOML
165 lines
5.1 KiB
TOML
[package]
|
|
name = "bevy_ecs"
|
|
version = "0.16.0-dev"
|
|
edition = "2021"
|
|
description = "Bevy Engine's entity component system"
|
|
homepage = "https://bevyengine.org"
|
|
repository = "https://github.com/bevyengine/bevy"
|
|
license = "MIT OR Apache-2.0"
|
|
keywords = ["ecs", "game", "bevy"]
|
|
categories = ["game-engines", "data-structures"]
|
|
rust-version = "1.83.0"
|
|
|
|
[features]
|
|
default = ["std", "bevy_reflect", "async_executor"]
|
|
|
|
# Functionality
|
|
|
|
## Enables multithreading support. Schedules will attempt to run systems on
|
|
## multiple threads whenever possible.
|
|
multi_threaded = ["bevy_tasks/multi_threaded", "dep:arrayvec"]
|
|
|
|
## Adds serialization support through `serde`.
|
|
serialize = ["dep:serde", "bevy_utils/serde"]
|
|
|
|
## Adds runtime reflection support using `bevy_reflect`.
|
|
bevy_reflect = ["dep:bevy_reflect"]
|
|
|
|
## Extends reflection support to functions.
|
|
reflect_functions = ["bevy_reflect", "bevy_reflect/functions"]
|
|
|
|
## Use the configurable global error handler as the default error handler
|
|
configurable_error_handler = []
|
|
|
|
# Debugging Features
|
|
|
|
## Enables `tracing` integration, allowing spans and other metrics to be reported
|
|
## through that framework.
|
|
trace = ["std", "dep:tracing"]
|
|
|
|
## Enables a more detailed set of traces which may be noisy if left on by default.
|
|
detailed_trace = ["trace"]
|
|
|
|
## Provides system stepping support, allowing them to be paused, stepped, and
|
|
## other debug operations which can help with diagnosing certain behaviors.
|
|
bevy_debug_stepping = []
|
|
|
|
## Provides more detailed tracking of the cause of various effects within the ECS.
|
|
## This will often provide more detailed error messages.
|
|
track_location = []
|
|
|
|
# Executor Backend
|
|
|
|
## Uses `async-executor` as a task execution backend.
|
|
## This backend is incompatible with `no_std` targets.
|
|
async_executor = ["dep:bevy_tasks", "std", "bevy_tasks/async_executor"]
|
|
|
|
## Uses `edge-executor` as a task execution backend.
|
|
## Use this instead of `async-executor` if working on a `no_std` target.
|
|
edge_executor = ["dep:bevy_tasks", "bevy_tasks/edge_executor"]
|
|
|
|
# Platform Compatibility
|
|
|
|
## Allows access to the `std` crate. Enabling this feature will prevent compilation
|
|
## on `no_std` targets, but provides access to certain additional features on
|
|
## supported platforms.
|
|
std = [
|
|
"bevy_reflect?/std",
|
|
"bevy_tasks/std",
|
|
"bevy_utils/std",
|
|
"bitflags/std",
|
|
"concurrent-queue/std",
|
|
"disqualified/alloc",
|
|
"fixedbitset/std",
|
|
"indexmap/std",
|
|
"serde?/std",
|
|
"nonmax/std",
|
|
"arrayvec?/std",
|
|
"log/std",
|
|
]
|
|
|
|
## `critical-section` provides the building blocks for synchronization primitives
|
|
## on all platforms, including `no_std`.
|
|
critical-section = [
|
|
"dep:critical-section",
|
|
"bevy_tasks?/critical-section",
|
|
"portable-atomic?/critical-section",
|
|
]
|
|
|
|
## `portable-atomic` provides additional platform support for atomic types and
|
|
## operations, even on targets without native support.
|
|
portable-atomic = [
|
|
"dep:portable-atomic",
|
|
"dep:portable-atomic-util",
|
|
"bevy_tasks?/portable-atomic",
|
|
"concurrent-queue/portable-atomic",
|
|
"spin/portable_atomic",
|
|
]
|
|
|
|
[dependencies]
|
|
bevy_ptr = { path = "../bevy_ptr", version = "0.16.0-dev" }
|
|
bevy_reflect = { path = "../bevy_reflect", version = "0.16.0-dev", default-features = false, optional = true }
|
|
bevy_tasks = { path = "../bevy_tasks", version = "0.16.0-dev", default-features = false, optional = true }
|
|
bevy_utils = { path = "../bevy_utils", version = "0.16.0-dev", default-features = false, features = [
|
|
"alloc",
|
|
] }
|
|
bevy_ecs_macros = { path = "macros", version = "0.16.0-dev" }
|
|
|
|
bitflags = { version = "2.3", default-features = false }
|
|
concurrent-queue = { version = "2.5.0", default-features = false }
|
|
disqualified = { version = "1.0", default-features = false }
|
|
fixedbitset = { version = "0.5", default-features = false }
|
|
serde = { version = "1", default-features = false, features = [
|
|
"alloc",
|
|
], optional = true }
|
|
thiserror = { version = "2", default-features = false }
|
|
derive_more = { version = "1", default-features = false, features = [
|
|
"from",
|
|
"display",
|
|
"into",
|
|
"as_ref",
|
|
] }
|
|
nonmax = { version = "0.5", default-features = false }
|
|
arrayvec = { version = "0.7.4", default-features = false, optional = true }
|
|
smallvec = { version = "1", features = ["union"] }
|
|
indexmap = { version = "2.5.0", default-features = false }
|
|
variadics_please = { version = "1.1", default-features = false }
|
|
critical-section = { version = "1.2.0", optional = true }
|
|
portable-atomic = { version = "1", default-features = false, features = [
|
|
"fallback",
|
|
], optional = true }
|
|
portable-atomic-util = { version = "0.2.4", features = [
|
|
"alloc",
|
|
], optional = true }
|
|
spin = { version = "0.9.8", default-features = false, features = [
|
|
"spin_mutex",
|
|
"rwlock",
|
|
] }
|
|
tracing = { version = "0.1", default-features = false, optional = true }
|
|
log = { version = "0.4", default-features = false }
|
|
bumpalo = "3"
|
|
|
|
[dev-dependencies]
|
|
rand = "0.8"
|
|
static_assertions = "1.1.0"
|
|
serde_test = "1.0"
|
|
|
|
[[example]]
|
|
name = "events"
|
|
path = "examples/events.rs"
|
|
|
|
[[example]]
|
|
name = "resources"
|
|
path = "examples/resources.rs"
|
|
|
|
[[example]]
|
|
name = "change_detection"
|
|
path = "examples/change_detection.rs"
|
|
|
|
[lints]
|
|
workspace = true
|
|
|
|
[package.metadata.docs.rs]
|
|
rustdoc-args = ["-Zunstable-options", "--generate-link-to-definition"]
|
|
all-features = true
|