-
Notifications
You must be signed in to change notification settings - Fork 0
docs(Tina/ecs): remove forEach #2
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
Open
RigidStudios
wants to merge
1
commit into
main
Choose a base branch
from
remove-foreach
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+27
−10
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -19,13 +19,13 @@ import { Position, Velocity, Acceleration } from './components'; | |
|
|
||
| const world = new World({...}); | ||
| const query = world.createQuery(Position, ANY(Velocity, NOT(Acceleration))); | ||
| query.forEach(entityId => { | ||
| query.items().forEach((entityId) => { | ||
| // ... | ||
| }); | ||
| }) | ||
|
|
||
| // or | ||
|
|
||
| for (const entityId of query) { | ||
| for (const entityId of query.iter()) { | ||
| // ... | ||
| } | ||
| ``` | ||
|
|
@@ -56,30 +56,47 @@ This function is not typically used directly but is used internally by the world | |
|
|
||
|
|
||
|
|
||
| ### :material-function-variant: **`#!typescript public forEach(callback: (entityId: EntityId) => void): void`** { #forEach data-toc-label='forEach' } | ||
| ### :material-function-variant: **`#!typescript public items(): void`** { #forEach data-toc-label='items' } | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Items and iter are not equivalent. |
||
|
|
||
| Runs a callback for each entity that matches the query. | ||
|
|
||
| If the callback returns `false`, the iteration will stop, and no other entities in the query will be iterated over. | ||
|
|
||
| #### Usage: | ||
| ```typescript | ||
| query.forEach(entityId => { | ||
| let items: query.items() | ||
| ``` | ||
|
|
||
| #### Returns | ||
|
|
||
| `#!typescript Array<EntityId>` | ||
|
|
||
| : An array of all the entity IDs for matching entities of this query. | ||
|
|
||
| ### :material-function-variant: **`#!typescript public *iter(): Generator<EntityId>`** { #markdown data-toc-label='*iter' } | ||
|
|
||
| #### Usage: | ||
| ```typescript | ||
| for (const entityId of query.iter()) { | ||
| // ... | ||
| }); | ||
| } | ||
| ``` | ||
|
|
||
| #### Parameters | ||
| `#!typescript callback: (entityId: EntityId) => boolean | void` | ||
| #### Returns | ||
|
|
||
| `#!typescript Generator<EntityId>` | ||
|
|
||
| : A Generator of all the entity IDs for matching entities of this query. | ||
|
|
||
| --- | ||
|
|
||
| : The callback ran for each entity in the query. | ||
|
|
||
|
|
||
| ## Query Helper Functions | ||
|
|
||
| Below are a set of helper functions that can be used to create queries. | ||
|
|
||
| These functions are used in conjunction with the [`#!typescript createQuery()`](../world/#createQuery "createQuery()") method, and should not be used directly. | ||
| These functions are used in conjunction with the [`#!typescript world.createQuery()`](../world/#createQuery "createQuery()") method, and should not be used directly. | ||
|
|
||
| ### :material-function-variant: **`#!typescript ALL(...components: Array<RawQuery | AnyComponent>): RawQuery`** { #all data-toc-label='ALL' } | ||
|
|
||
|
|
||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should swap the order of these;
const entityId of query.iter()should come first as I know the syntax is not desired, but it will (for now) be the way we should be doing it for most cases.