Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve pbr example (confusing comment) #16996

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

mdickopp
Copy link
Contributor

Objective

After a recent fix for a panic in the pbr example (#16976), the code contains the following comment:

// This system relies on system parameters that are not available at start
// Ignore parameter failures so that it will run when possible
.add_systems(Update, environment_map_load_finish.never_param_warn())

However, this explanation is incorrect. EnvironmentMapLabel is available at start. The real issue is that it is no longer available once it has been removed by environment_map_load_finish.

Solution

  • Remove confusing/incorrect comment and never_param_warn().
  • Make Single<Entity, With<EnvironmentMapLabel>> optional in environment_map_load_finish, and check that the entity has not yet been despawned.

Since it is expected that an entity is no longer there once it has been despawned, it seems better to me to handle this case in environment_map_load_finish.

Testing

Ran cargo run --example pbr.

@BenjaminBrienen BenjaminBrienen added D-Trivial Nice and easy! A great choice to get started with Bevy A-ECS Entities, components, systems, and events C-Examples An addition or correction to our examples C-Code-Quality A section of code that is hard to understand or change S-Needs-Review Needs reviewer attention (from anyone!) to move forward A-Rendering Drawing game state to the screen and removed A-ECS Entities, components, systems, and events labels Dec 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-Rendering Drawing game state to the screen C-Code-Quality A section of code that is hard to understand or change C-Examples An addition or correction to our examples D-Trivial Nice and easy! A great choice to get started with Bevy S-Needs-Review Needs reviewer attention (from anyone!) to move forward
Projects
Status: No status
Development

Successfully merging this pull request may close these issues.

2 participants