Mirrors/bevy
2
0
Fork 0
mirror of https://github.com/bevyengine/bevy synced 2024-11-22 04:33:37 +00:00
Code Issues Projects Releases Packages Wiki Activity

Add entity ID to expect() message (#2943)

Browse source 
Add the entity ID and generation to the expect() message of two
world accessors, to make it easier to debug use-after-free issues.
Coupled with e.g. bevy-inspector-egui which also displays the entity ID,
this makes it much easier to identify what entity is being misused.

# Objective

Make it easier to identity an entity being accessed after being deleted.

## Solution

Augment the error message of some `expect()` call with the entity ID and
generation. Combined with some external tool like `bevy-inspector-egui`, which
also displays the entity ID, this increases the chances to be able to identify
the entity, and therefore find the error that led to a use-after-despawn.
This commit is contained in:
Jerome Humbert 2021-10-10 23:04:05 +00:00
parent db013b664e
commit f4776f2ec4
1 changed files with 6 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
crates/bevy_ecs/src/world/mod.rs
View file

@ -197,7 +197,9 @@ impl World {
/// ```
#[inline]
pub fn entity(&self, entity: Entity) -> EntityRef {
self.get_entity(entity).expect("Entity does not exist")
// Lazily evaluate panic!() via unwrap_or_else() to avoid allocation unless failure
self.get_entity(entity)
.unwrap_or_else(|| panic!("Entity {:?} does not exist", entity))
}
/// Retrieves an [EntityMut] that exposes read and write operations for the given `entity`.
@ -223,7 +225,9 @@ impl World {
/// ```
#[inline]
pub fn entity_mut(&mut self, entity: Entity) -> EntityMut {
self.get_entity_mut(entity).expect("Entity does not exist")
// Lazily evaluate panic!() via unwrap_or_else() to avoid allocation unless failure
self.get_entity_mut(entity)
.unwrap_or_else(|| panic!("Entity {:?} does not exist", entity))
}
/// Returns an [EntityMut] for the given `entity` (if it exists) or spawns one if it doesn't exist.