Repository navigation
Add optional component query filter - #365
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Objective
Introduces an optional ECS query filter that allows queries to return entities even when a selected component is absent.
Solution
Queries now distinguish between required and optional component descriptors. Optional components do not affect archetype matching and resolve to
undefinedwhen absent.Changes Made
Optionalquery filter andoptional()helper.QueryFilter.isRequired()for determining which components must exist in an archetype.Component | undefined.get(),single(),each(), andeachCombination().Why This Approach
This keeps the component selection order unchanged while allowing systems to access related components without creating separate queries for every component combination. The type transformation also ensures consumers handle potentially absent components safely.
Showcase
Before
Only entities containing both
PositionandVelocitymatched the query.After
Entities containing
Positionnow match regardless of whether they containVelocityor not.Migration Guide
No migration required.
Checklist