bitECS icon indicating copy to clipboard operation
bitECS copied to clipboard

defineQuery documentation.

Open dannyfritz opened this issue 4 years ago • 2 comments

The defineQuery documentation is pretty lacking currently. I see in code that there are query modifiers for Not, Or, Changed, Any, All, and None. Some explanation of what these do or how to use them would be appreciated in the API.md file.

https://github.com/NateTheGreatt/bitECS/blob/eebaea52009c38eb9c6a78449ee8aa7ab3dacc79/src/Query.js#L8-L14

https://github.com/NateTheGreatt/bitECS/blob/master/docs/API.md#defineQuery

I am also willing to contribute a PR for this documentation if this is work that should be done and can be done by an outsider.

dannyfritz avatar Oct 04 '21 01:10 dannyfritz

i've been undecided on leaving defineSystem around. the only thing it does is return world, implicitly. any thoughts here?

as for Any, All, and None, these are not fully implemented yet. just some preparations in-place at the moment. i have some stashed changes here that i'll be able to give some attention very soon!

NateTheGreatt avatar Oct 04 '21 03:10 NateTheGreatt

i've been undecided on leaving defineSystem around. the only thing it does is return world, implicitly. any thoughts here?

as for Any, All, and None, these are not fully implemented yet. just some preparations in-place at the moment. i have some stashed changes here that i'll be able to give some attention very soon!

Ah sorry, I actually meant defineQuery.

I'm not sure what the point of defineSystem is unless you plan to do something special in the future. I think this is usually how automatic parallelization is done.

dannyfritz avatar Oct 04 '21 03:10 dannyfritz