From b69adecc1de16d5547104ff28736ffbb0261451a Mon Sep 17 00:00:00 2001 From: marked Date: Fri, 13 Jun 2025 02:11:47 +0200 Subject: [PATCH] Sync to upstream Jecs 0.6.1 (#12) Reviewed-on: https://git.devmarked.win/marked/jecs-pesde/pulls/12 --- .luaurc | 20 +-- CHANGELOG.md | 361 +++++++++++++++++++++---------------------------- README.md | 21 ++- jecs.luau | 129 +++++++++--------- pesde-rbx.toml | 2 +- pesde.lock | 2 +- pesde.toml | 2 +- 7 files changed, 254 insertions(+), 283 deletions(-) diff --git a/.luaurc b/.luaurc index f856eba..1d36832 100644 --- a/.luaurc +++ b/.luaurc @@ -1,10 +1,10 @@ -{ - "aliases": { - "jecs": "jecs", - "testkit": "tools/testkit", - "mirror": "mirror", - "tools": "tools", - "addons": "addons" - }, - "languageMode": "strict" -} +{ + "aliases": { + "jecs": "jecs", + "testkit": "tools/testkit", + "mirror": "mirror", + "tools": "tools", + "addons": "addons" + }, + "languageMode": "strict" +} diff --git a/CHANGELOG.md b/CHANGELOG.md index fa1d870..28a4d81 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,228 +1,177 @@ -# Jecs Changelog +# Changelog -All notable changes to this project will be documented in this file. +## Unreleased -The format is based on [Keep a Changelog][kac], and this project adheres to -[Semantic Versioning][semver]. - -[kac]: https://keepachangelog.com/en/1.1.0/ -[semver]: https://semver.org/spec/v2.0.0.html - -## [Unreleased] - -## [0.6.0] - 2025-05-10 - -- `[world]`: - - Added `world:range` to restrict entity range - - Changed `world:entity` to accept the overload to create an entity at the desired id - - Changed `world:clear` to also look through the component record for the cleared `ID` - - Removes the cleared ID from every entity that has it - - Changed entity ID layouts by putting the index in the lower bits, which should make every world function 1-5 nanoseconds faster - - Fixed `world:delete` not removing every pair with an unalive target - - Specifically happened when you had at least two pairs of different relations with multiple targets each -- `[hooks]`: - - Replaced `OnSet` with `OnChange` - - The former was used to detect emplace/move actions. Now the behaviour for `OnChange` is that it will run only when the value has changed - - Changed `OnAdd` to specifically run after the data has been set for non-zero-sized components. Also returns the value that the component was set to - - This should allow a more lenient window for modifying data - - Changed `OnRemove` to lazily lookup which archetype the entity will move to - - Can now have interior structural changes within `OnRemove` hooks - - Optimized `world:has` for both single component and multiple component presence. - - This comes at the cost that it cannot check the component presence for more than 4 components at a time. If this is important, consider calling to this function multiple times. - -## [0.5.0] - 2024-12-26 - -- `[world]`: - - Fixed `world:target` not giving adjacent pairs - - Added `world:each` to find entities with a specific Tag - - Added `world:children` to find children of entity -- `[query]`: - - Added `query:cached` - - Adds query cache that updates itself when an archetype matching the query gets created or deleted. -- `[luau]`: - - Changed how entities' types are inferred with user-defined type functions - - Changed `Pair` to return `Second` if `First` is a `Tag`; otherwise, returns `First`. - -## [0.4.0] - 2024-11-17 - -- `[world]`: - - Added recycling to `world:entity` - - If you see much larger entity ids, that is because its generation has been incremented -- `[query]`: - - Removed `query:drain` - - The default behaviour is simply to drain the iterator - - Removed `query:next` - - Just call the iterator function returned by `query:iter` directly if you want to get the next results - - Removed `query:replace` -- `[luau]`: - - Fixed `query:archetypes` not taking `self` - - Changed so that the `jecs.Pair` type now returns the first element's type so you won't need to typecast anymore. - -## [0.3.2] - 2024-10-01 - -- `[world]`: - - Changed `world:cleanup` to traverse a header type for graph edges. (Edit) - - Fixed a regression that occurred when you call `world:set` following a `world:remove` using the same component - - Remove explicit error in JECS_DEBUG for `world:target` when not applying an index parameter -- `[typescript]` : - - Fixed `world.set` with NoInfer - -## [0.3.1] - 2024-10-01 - -- `[world]`: - - Added an index parameter to `world:target` - - Added a way to change the components limit via `_G.JECS_HI_COMPONENT_ID` - - Set it to whatever number you want but try to make it as close to the number of components you will use as possible - - Make sure to set this before importing jecs or else it will not work - - Added debug mode, enable via setting `_G.JECS_DEBUG` to true - - Make sure to set this before importing jecs or else it will not work - - Added `world:cleanup` which is called to cleanup empty archetypes manually - - Changed `world:delete` to delete archetypes that are dependent on the passed entity - - Changed `world:delete` to delete entity's children before the entity to prevent cycles -- `[query]`: - - Fixed the iterator to not drain by default -- `[typescript]` - - Fixed entry point of the package.json file to be `src` rather than `src/init` - - Fixed `query.next` returning a query object whereas it would be expected to return a tuple containing the entity and the corresponding component values - - Exported `query.archetypes` - - Changed `pair` to return a number instead of an entity - - Preventing direct usage of a pair as an entity while still allowing it to be used as a component - - Exported built-in components `ChildOf` and `Name` - - Exported `world.parent` - -## [0.2.10] - 2024-09-07 - -- `[world]`: - - Improved performance for hooks - - Changed `world:set` to be idempotent when setting tags -- `[traits]`: - - Added cleanup condition `jecs.OnDelete` for when the entity or component is deleted - - Added cleanup action `jecs.Remove` which removes instances of the specified (component) id from all entities - - This is the default cleanup action - - Added component trait `jecs.Tag` which allows for zero-cost components used as tags - - Setting data to a component with this trait will do nothing -- `[luau]`: - - Exported `world:contains()` - - Exported `query:drain()` - - Exported `Query` - - Improved types for the hook `OnAdd`, `OnSet`, `OnRemove` - - Changed functions to accept any ID including pairs in type parameters - - Applies to `world:add()`, `world:set()`, `world:remove()`, `world:get()`, `world:has()` and `world:query()` - - New exported type `Id = Entity | Pair` - - Changed `world:contains()` to return a `boolean` instead of an entity which may or may not exist - - Fixed `world:has()` to take the correct parameters - -## [0.2.2] - 2024-07-07 - -### Added - -- Added `query:replace(function(...T) return ...U end)` for replacing components in place - - Method is fast pathed to replace the data to the components for each corresponding entity +## 0.6.1 ### Changed - -- Iterator now goes backwards instead to prevent common cases of iterator invalidation - -## [0.2.1] - 2024-07-06 - -### Added - -- Added `jecs.Component` built-in component which will be added to ids created with `world:component()`. - - Used to find every component id with `query(jecs.Component) - -## [0.2.0] - 2024-07-03 - -### Added - -- Added `world:parent(entity)` and `jecs.ChildOf` respectively as first class citizen for building parent-child relationships. - - Give a parent to an entity with `world:add($source, pair(ChildOf, $target))` - - Use `world:parent(entity)` to find the target of the relationship -- Added user-facing Luau types - -### Changed - -- Improved iteration speeds 20-40% by manually indexing rather than using `next()` :scream: - -## [0.1.1] - 2024-05-19 - -### Added - -- Added `world:clear(entity)` for removing the components to the corresponding entity -- Added Typescript Types - -## [0.1.0] - 2024-05-13 - -### Changed - -- Optimized iterator - -## [0.1.0-rc.6] - 2024-05-13 - -### Added - -- Added a `jecs.Wildcard` term - - it lets you query any partially matched pairs - -## [0.1.0-rc.5] - 2024-05-10 - -### Added - -- Added Entity relationships for creating logical connections between entities -- Added `world:__iter method` which allows for iteration over the whole world to get every entity - - used for reconciling whole worlds such as via replication, saving/loading, etc -- Added `world:add(entity, component)` which adds a component to the entity - - it is an idempotent function, so calling it twice and in any order should be fine +- Entity types now unions with numbers should allow for easier time casting while not causing regressing previous behaviours ### Fixed +- Fixed a critical bug with `(*, R)` pairs not being removed when `R` is deleted -- Fixed component overriding when in disorder - - Previously setting the components in different order results in it overriding component data because it incorrectly mapped the index of the column. So it took the index from the source archetype rather than the destination archetype - -## [0.0.0-prototype.rc.3] - 2024-05-01 +## 0.6.0 ### Added - -- Added observers -- Added an arm to query `query:without()` for chaining invariants. +- `World:range` to restrict entity range to allow for e.g. reserving ids `1000..5000` for clients and everything above that (5000+) for entities from the server. This makes it possible to receive ids from a server that don't have to be mapped to local ids. +- `jecs.component`, `jecs.tag` and `jecs.meta` for preregistering ids and their metadata before a world +- Overload to `World:entity` to create an entity at the desired id. ### Changed +- `World:clear` to remove the `ID` from every entity instead of the previous behaviour of removing all of the components on the entity. You should prefer deleting the entity instead for the previous behaviour. +- Entity ID layouts by putting the index in the lower bits, which should make every world function 1–5 nanoseconds faster. +- Hooks now pass the full component ID which is useful for pairs when you need both the relation and the target. +- Replaced `OnSet` with `OnChange`, which now only runs when the component ID was previously present on the entity. +- `OnAdd` now runs after the value has been set and also passes the component ID and the value. +- `OnRemove` now lazily looks up which archetype the entity will move to. This is meant to support interior structural changes within every hook. +- Optimized `world:has` for both single and multiple component presence. This comes at the cost that it cannot check the component presence for more than 4 components at a time. If this is important, consider calling this function multiple times. -- Separates ranges for components and entity IDs. +### Fixed +- `World:delete` not removing every pair with an unalive target. Specifically happened when you had at least two pairs of different relations with multiple targets each. - - IDs created with `world:component()` will promote array lookups rather than map lookups in the `component_index` which is a significant boost +## 0.5.0 -- No longer caches the column pointers directly and instead the column indices which stay persistent even when data is reallocated during swap-removals - - This was an issue with the iterator being invalidated when you move an entity to a different archetype. - -### Fixedhttps://github.com/Ukendio/jecs/releases/tag/v0.0.0-prototype.rc.3 - -- Fixed a bug where changing an existing component would be slow because it was always appending changing the row of the entity record - - The fix dramatically improves times where it is basically down to just the speed of setting a field in a table - -## [0.0.0-prototype.rc.2] - 2024-04-26 +### Added +- `World:each` to find entities with a specific Tag. +- `World:children` to find children of an entity. +- `Query:cached` to add a query cache that updates itself when an archetype matching the query gets created or deleted. ### Changed +- Inference of entities' types using user-defined type functions. +- `Pair` to return `Second` if `First` is a `Tag`; otherwise, returns `First`. -- Optimized the creation of the query - - It will now finds the smallest archetype map to iterate over -- Optimized the query iterator +### Fixed +- `World:target` not giving adjacent pairs. - - It will now populates iterator with columns for faster indexing +## 0.4.0 -- Renamed the insertion method from world:add to world:set to better reflect what it does. +### Added +- Recycling support to `world:entity` so reused entity IDs now increment generation. -## [0.0.0-prototype.rc.2] - 2024-04-23 +### Removed +- `Query:drain` +- `Query:next` +- `Query:replace` -- Initial release +### Changed +- `jecs.Pair` type in Luau now returns the first element's type to avoid manual typecasting. -[unreleased]: https://github.com/ukendio/jecs/compare/v0.0.0.0-prototype.rc.2...HEAD -[0.2.2]: https://github.com/ukendio/jecs/releases/tag/v0.2.2 -[0.2.1]: https://github.com/ukendio/jecs/releases/tag/v0.2.1 -[0.2.0]: https://github.com/ukendio/jecs/releases/tag/v0.2.0 -[0.1.1]: https://github.com/ukendio/jecs/releases/tag/v0.1.1 -[0.1.0]: https://github.com/ukendio/jecs/releases/tag/v0.1.0 -[0.1.0-rc.6]: https://github.com/ukendio/jecs/releases/tag/v0.1.0-rc.6 -[0.1.0-rc.5]: https://github.com/ukendio/jecs/releases/tag/v0.1.0-rc.5 -[0.0.0-prototype-rc.3]: https://github.com/ukendio/jecs/releases/tag/v0.0.0-prototype.rc.3 -[0.0.0-prototype.rc.2]: https://github.com/ukendio/jecs/releases/tag/v0.0.0-prototype.rc.2 -[0.0.0-prototype-rc.1]: https://github.com/ukendio/jecs/releases/tag/v0.0.0-prototype.rc.1 +### Fixed +- `Query:archetypes` now correctly takes `self`. + +## 0.3.2 - 2024-10-01 + +### Changed +- `World:cleanup` to traverse a header type for graph edges. + +### Fixed +- Regression when calling `World:set` after `World:remove` on the same component. +- Removed explicit error in `JECS_DEBUG` for `World:target` missing index. +- `World.set` type inference with `NoInfer` in TypeScript. + +## 0.3.1 - 2024-10-01 + +### Added +- Index parameter to `World:target`. +- Global config `_G.JECS_HI_COMPONENT_ID` to change component ID limit (must be set before importing JECS). +- Debug mode via `_G.JECS_DEBUG` (must be set before importing JECS). +- `world:cleanup` to manually clean up empty archetypes. + +### Changed +- `world:delete` now also deletes dependent archetypes and child entities. + +### Fixed +- `Query` iterator to not drain by default. +- TypeScript package entry to `src` instead of `src/init`. +- `Query.next` now returns expected result tuple in typescript. +- `pair` returns a number instead of entity to prevent misuse. +- Exported built-in components `ChildOf`, `Name`, and `world.parent`. + +## 0.2.10 + +### Added +- Trait `jecs.Tag` for zero-cost tag components. +- Cleanup conditions: `jecs.OnDelete`, `jecs.Remove`. + +### Changed +- `world:set` is now idempotent when setting tags. + +### Fixed +- Improved performance for hooks. +- Exported types and functions: `world:contains()`, `query:drain()`, `Query`. +- Hook types: `OnAdd`, `OnSet`, `OnRemove`. +- ID flexibility for `add`, `set`, `remove`, `get`, `has`, `query`. +- `world:contains()` now returns `boolean`. +- `world:has()` parameters now correct. + +## 0.2.2 + +### Added +- `query:replace(fn)` for in-place replacement of component values. + +### Changed +- Iterator now goes backwards to avoid invalidation during iteration. + +## 0.2.1 + +### Added +- Built-in `jecs.Component` used to find all component IDs. + +## 0.2.0 + +### Added +- `world:parent(entity)` and `jecs.ChildOf` for parent-child relationships. + +### Changed +- Iteration performance improved by 20–40% through manual indexing. + +## 0.1.1 + +### Added +- `world:clear(entity)` for removing all components from an entity. +- TypeScript types. + +## 0.1.0 + +### Changed +- Optimized iterator. + +## 0.1.0-rc.6 + +### Added +- `jecs.Wildcard` term to query partially matched pairs. + +## 0.1.0-rc.5 + +### Added +- Entity relationships. +- `world:__iter()` for full world iteration. +- `world:add(entity, component)` (idempotent). + +### Fixed +- Component overriding when set out of order. + +## 0.0.0-prototype.rc.3 + +### Added +- Observers. +- `query:without()` for invariant queries. + +### Changed +- Separate ID ranges for entities and components. +- Avoid caching pointers; cache stable column indices instead. + +### Fixed +- Slow component updates due to unnecessary row changes. + +## 0.0.0-prototype.rc.2 - 2024-04-26 + +### Changed +- Query now uses smallest archetype map. +- Optimized query iterator. +- Renamed `world:add` to `world:set`. + +## 0.0.0-prototype.rc.1 + +### Added +- Initial release. diff --git a/README.md b/README.md index d8e7df0..e5a0ade 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ Install with pesde @ `marked/jecs`

-[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg?style=for-the-badge)](LICENSE) [![Wally](https://img.shields.io/github/v/tag/ukendio/jecs?&style=for-the-badge)](https://wally.run/package/ukendio/jecs) +[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg?style=for-the-badge)](LICENSE) [![Wally](https://img.shields.io/github/v/tag/ukendio/jecs?&style=for-the-badge)](https://wally.run/package/ukendio/jecs) [![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/ukendio/jecs/unit-testing.yaml?&style=for-the-badge)](https://github.com/Ukendio/jecs/actions/workflows/unit-testing.yaml) Just a stupidly fast Entity Component System @@ -16,7 +16,22 @@ Just a stupidly fast Entity Component System - Zero-dependency package - Optimized for column-major operations - Cache friendly [archetype/SoA](https://ajmmertens.medium.com/building-an-ecs-2-archetypes-and-vectorization-fe21690805f9) storage -- Rigorously [unit tested](https://github.com/Ukendio/jecs/actions/workflows/ci.yaml) for stability +- Rigorously [unit tested](https://github.com/Ukendio/jecs/actions/workflows/unit-testing.yaml) for stability + +### Installation + +With [Wally](https://wally.run/): +```bash +jecs = "ukendio/jecs@0.6.0" # Inside wally.toml +``` +With [pesde](https://pesde.dev/): +```bash +pesde add wally#ukendio/jecs@0.6.0 +``` +With [npm](https://www.npmjs.com/package/@rbxts/jecs) ([roblox-ts](https://roblox-ts.com/)): +```bash +npm i @rbxts/jecs +``` ### Example @@ -59,6 +74,8 @@ end -- sara is the child of alice ``` +### Benchmarks + 21,000 entities 125 archetypes 4 random components queried. ![Queries](assets/image-3.png) Can be found under /benches/visual/query.luau diff --git a/jecs.luau b/jecs.luau index f705f0e..416bc1f 100644 --- a/jecs.luau +++ b/jecs.luau @@ -1,3 +1,4 @@ + --!optimize 2 --!native --!strict @@ -94,29 +95,31 @@ type ecs_world_t = { observable: Map>, } -local HI_COMPONENT_ID = _G.__JECS_HI_COMPONENT_ID or 256 -- stylua: ignore start -local EcsOnAdd = HI_COMPONENT_ID + 1 -local EcsOnRemove = HI_COMPONENT_ID + 2 -local EcsOnChange = HI_COMPONENT_ID + 3 -local EcsWildcard = HI_COMPONENT_ID + 4 -local EcsChildOf = HI_COMPONENT_ID + 5 -local EcsComponent = HI_COMPONENT_ID + 6 -local EcsOnDelete = HI_COMPONENT_ID + 7 -local EcsOnDeleteTarget = HI_COMPONENT_ID + 8 -local EcsDelete = HI_COMPONENT_ID + 9 -local EcsRemove = HI_COMPONENT_ID + 10 -local EcsName = HI_COMPONENT_ID + 11 -local EcsOnArchetypeCreate = HI_COMPONENT_ID + 12 -local EcsOnArchetypeDelete = HI_COMPONENT_ID + 13 -local EcsRest = HI_COMPONENT_ID + 14 -local ECS_ID_DELETE = 0b01 -local ECS_ID_IS_TAG = 0b10 -local ECS_ID_MASK = 0b00 +local ECS_ENTITY_MASK = bit32.lshift(1, 24) +local ECS_GENERATION_MASK = bit32.lshift(1, 16) +local ECS_PAIR_OFFSET = 2^48 -local ECS_ENTITY_MASK = bit32.lshift(1, 24) -local ECS_GENERATION_MASK = bit32.lshift(1, 16) +local ECS_ID_DELETE = 0b01 +local ECS_ID_IS_TAG = 0b10 +local ECS_ID_MASK = 0b00 + +local HI_COMPONENT_ID = 256 +local EcsOnAdd = HI_COMPONENT_ID + 1 +local EcsOnRemove = HI_COMPONENT_ID + 2 +local EcsOnChange = HI_COMPONENT_ID + 3 +local EcsWildcard = HI_COMPONENT_ID + 4 +local EcsChildOf = HI_COMPONENT_ID + 5 +local EcsComponent = HI_COMPONENT_ID + 6 +local EcsOnDelete = HI_COMPONENT_ID + 7 +local EcsOnDeleteTarget = HI_COMPONENT_ID + 8 +local EcsDelete = HI_COMPONENT_ID + 9 +local EcsRemove = HI_COMPONENT_ID + 10 +local EcsName = HI_COMPONENT_ID + 11 +local EcsOnArchetypeCreate = HI_COMPONENT_ID + 12 +local EcsOnArchetypeDelete = HI_COMPONENT_ID + 13 +local EcsRest = HI_COMPONENT_ID + 14 local NULL_ARRAY = table.freeze({}) :: Column local NULL = newproxy(false) @@ -168,7 +171,6 @@ end local function ECS_COMBINE(id: number, generation: number): i53 return id + (generation * ECS_ENTITY_MASK) end -local ECS_PAIR_OFFSET = 2^48 local function ECS_IS_PAIR(e: number): boolean return e > ECS_PAIR_OFFSET @@ -824,7 +826,7 @@ local function world_entity(world: ecs_world_t, entity: i53?): i53 return entity end end - return entity_index_new_id(entity_index, entity) + return entity_index_new_id(entity_index) end local function world_parent(world: ecs_world_t, entity: i53) @@ -1050,7 +1052,7 @@ local function world_remove(world: ecs_world_t, entity: i53, id: i53) end end -local function archetype_fast_delete_last(columns: { Column }, column_count: number, types: { i53 }, entity: i53) +local function archetype_fast_delete_last(columns: { Column }, column_count: number) for i, column in columns do if column ~= NULL_ARRAY then column[column_count] = nil @@ -1058,7 +1060,7 @@ local function archetype_fast_delete_last(columns: { Column }, column_count: num end end -local function archetype_fast_delete(columns: { Column }, column_count: number, row, types, entity) +local function archetype_fast_delete(columns: { Column }, column_count: number, row: number) for i, column in columns do if column ~= NULL_ARRAY then column[row] = column[column_count] @@ -1100,9 +1102,9 @@ local function archetype_delete(world: ecs_world_t, archetype: ecs_archetype_t, entities[last] = nil :: any if row == last then - archetype_fast_delete_last(columns, column_count, id_types, delete) + archetype_fast_delete_last(columns, column_count) else - archetype_fast_delete(columns, column_count, row, id_types, delete) + archetype_fast_delete(columns, column_count, row) end end @@ -1408,14 +1410,14 @@ local function world_delete(world: ecs_world_t, entity: i53) local tr = idr_r_archetype.records[rel] local tr_count = idr_r_archetype.counts[rel] local types = idr_r_archetype.types - for i = tr, tr_count do - ids[types[tr]] = true + for i = tr, tr + tr_count - 1 do + ids[types[i]] = true end + local n = #entities table.move(entities, 1, n, count + 1, children) count += n end - for _, child in children do for id in ids do world_remove(world, child, id) @@ -1933,6 +1935,9 @@ local function query_cached(query: ecs_query_data_t) local function on_delete_callback(archetype) local i = table.find(archetypes, archetype) :: number + if i == nil then + return + end local n = #archetypes archetypes[i] = archetypes[n] archetypes[n] = nil @@ -2521,8 +2526,8 @@ end World.new = world_new -export type Entity = { __T: T } -export type Id = { __T: T } +export type Entity = number | { __T: T } +export type Id = number | { __T: T } export type Pair = Id

type ecs_id_t = Id | Pair | Pair<"Tag", T> export type Item = (self: Query) -> (Entity, T...) @@ -2570,46 +2575,46 @@ export type World = { range: (self: World, range_begin: number, range_end: number?) -> (), --- Creates a new entity - entity: (self: World, id: Entity?) -> Entity, + entity: (self: World, id: Entity?) -> Entity, --- Creates a new entity located in the first 256 ids. --- These should be used for static components for fast access. component: (self: World) -> Entity, --- Gets the target of an relationship. For example, when a user calls --- `world:target(id, ChildOf(parent), 0)`, you will obtain the parent entity. - target: (self: World, id: Entity, relation: Id, index: number?) -> Entity?, + target: (self: World, id: Entity, relation: Id, index: number?) -> Entity?, --- Deletes an entity and all it's related components and relationships. - delete: (self: World, id: Entity) -> (), + delete: (self: World, id: Entity) -> (), --- Adds a component to the entity with no value - add: (self: World, id: Entity, component: Id) -> (), + add: (self: World, id: Entity, component: Id) -> (), --- Assigns a value to a component on the given entity - set: (self: World, id: Entity, component: Id, data: T) -> (), + set: (self: World, id: Entity, component: Id, data: a) -> (), cleanup: (self: World) -> (), -- Clears an entity from the world - clear: (self: World, id: Id) -> (), + clear: (self: World, id: Id) -> (), --- Removes a component from the given entity - remove: (self: World, id: Entity, component: Id) -> (), + remove: (self: World, id: Entity, component: Id) -> (), --- Retrieves the value of up to 4 components. These values may be nil. - get: ((self: World, id: Entity, Id) -> A?) - & ((self: World, id: Entity, Id, Id) -> (A?, B?)) - & ((self: World, id: Entity, Id, Id, Id) -> (A?, B?, C?)) - & (self: World, id: Entity, Id, Id, Id, Id) -> (A?, B?, C?, D?), + get: & ((World, Entity, Id) -> a?) + & ((World, Entity, Id, Id) -> (a?, b?)) + & ((World, Entity, Id, Id, Id) -> (a?, b?, c?)) + & ((World, Entity, Id, Id, Id, Id) -> (a?, b?, c?, d?)), --- Returns whether the entity has the ID. - has: ((World, Entity, A) -> boolean) - & ((World, Entity, A, B) -> boolean) - & ((World, Entity, A, B, C) -> boolean) - & (World, Entity, A, B, C, D) -> boolean, + has: ((World, Entity, Id) -> boolean) + & ((World, Entity, Id, Id) -> boolean) + & ((World, Entity, Id, Id, Id) -> boolean) + & (World, Entity, Id, Id, Id, Id) -> boolean, --- Get parent (target of ChildOf relationship) for entity. If there is no ChildOf relationship pair, it will return nil. - parent:(self: World, entity: Entity) -> Entity, + parent: (self: World, entity: Entity) -> Entity, --- Checks if the world contains the given entity - contains:(self: World, entity: Entity) -> boolean, + contains: (self: World, entity: Entity) -> boolean, --- Checks if the entity exists - exists: (self: World, entity: Entity) -> boolean, + exists: (self: World, entity: Entity) -> boolean, each: (self: World, id: Id) -> () -> Entity, @@ -2651,19 +2656,19 @@ return { meta = (ECS_META :: any) :: (id: Entity, id: Id, value: T) -> Entity, is_tag = (ecs_is_tag :: any) :: (World, Id) -> boolean, - OnAdd = EcsOnAdd :: Entity<(entity: Entity) -> ()>, - OnRemove = EcsOnRemove :: Entity<(entity: Entity) -> ()>, - OnChange = EcsOnChange :: Entity<(entity: Entity, data: any) -> ()>, - ChildOf = EcsChildOf :: Entity, - Component = EcsComponent :: Entity, - Wildcard = EcsWildcard :: Entity, - w = EcsWildcard :: Entity, - OnDelete = EcsOnDelete :: Entity, - OnDeleteTarget = EcsOnDeleteTarget :: Entity, - Delete = EcsDelete :: Entity, - Remove = EcsRemove :: Entity, - Name = EcsName :: Entity, - Rest = EcsRest :: Entity, + OnAdd = (EcsOnAdd :: any) :: Entity<(entity: Entity, id: Id, data: T) -> ()>, + OnRemove = (EcsOnRemove :: any) :: Entity<(entity: Entity, id: Id) -> ()>, + OnChange = (EcsOnChange :: any) :: Entity<(entity: Entity, id: Id, data: T) -> ()>, + ChildOf = (EcsChildOf :: any) :: Entity, + Component = (EcsComponent :: any) :: Entity, + Wildcard = (EcsWildcard :: any) :: Entity, + w = (EcsWildcard :: any) :: Entity, + OnDelete = (EcsOnDelete :: any) :: Entity, + OnDeleteTarget = (EcsOnDeleteTarget :: any) :: Entity, + Delete = (EcsDelete :: any) :: Entity, + Remove = (EcsRemove :: any) :: Entity, + Name = (EcsName :: any) :: Entity, + Rest = (EcsRest :: any) :: Entity, pair = (ECS_PAIR :: any) :: (first: Id

, second: Id) -> Pair, diff --git a/pesde-rbx.toml b/pesde-rbx.toml index d0520fc..546b39e 100644 --- a/pesde-rbx.toml +++ b/pesde-rbx.toml @@ -11,7 +11,7 @@ includes = [ license = "MIT" name = "marked/jecs" repository = "https://git.devmarked.win/marked/jecs-pesde" -version = "0.6.0" +version = "0.6.1" [indices] default = "https://github.com/pesde-pkg/index" diff --git a/pesde.lock b/pesde.lock index 91f9895..d67f8e4 100644 --- a/pesde.lock +++ b/pesde.lock @@ -2,5 +2,5 @@ # It is not intended for manual editing. format = 1 name = "marked/jecs" -version = "0.6.0" +version = "0.6.1" target = "luau" diff --git a/pesde.toml b/pesde.toml index ecf59dc..ca8559e 100644 --- a/pesde.toml +++ b/pesde.toml @@ -11,7 +11,7 @@ includes = [ license = "MIT" name = "marked/jecs" repository = "https://git.devmarked.win/marked/jecs-pesde" -version = "0.6.0" +version = "0.6.1" [indices] default = "https://github.com/pesde-pkg/index"