forestia/bevy
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Small Docs PR for Deferred Worlds (#18384)

Browse Source 
# Objective

I was looking over a PR yesterday, and got confused by the docs on
deferred world. I thought I would add a little more detail to the struct
in order to clarify it a little.

## Solution

Document some more about deferred worlds.
This commit is contained in:
Carter Weinberg 2025-03-18 16:30:49 -04:00 committed by GitHub
parent 5ab0456f61
commit 821f6fa0dd
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 2 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
crates/bevy_ecs/src/world/deferred_world.rs
View File

@ -20,6 +20,8 @@ use super::{unsafe_world_cell::UnsafeWorldCell, Mut, World, ON_INSERT, ON_REPLAC
/// A [`World`] reference that disallows structural ECS changes. /// A [`World`] reference that disallows structural ECS changes.
/// This includes initializing resources, registering components or spawning entities. /// This includes initializing resources, registering components or spawning entities.
///
/// This means that in order to add entities, for example, you will need to use commands instead of the world directly.
pub struct DeferredWorld<'w> { pub struct DeferredWorld<'w> {
// SAFETY: Implementors must not use this reference to make structural changes // SAFETY: Implementors must not use this reference to make structural changes
world: UnsafeWorldCell<'w>, world: UnsafeWorldCell<'w>,