mirror of
https://github.com/Ukendio/jecs.git
synced 2025-04-25 09:30:03 +00:00
Merge branch 'main' of https://github.com/Ukendio/jecs into patch
This commit is contained in:
Ukendio
commit
ea89be96c2
29 changed files with 4536 additions and 1314 deletions
6
.github/workflows/release.yaml
vendored
6
.github/workflows/release.yaml
vendored
|
|
@ -49,9 +49,7 @@ jobs:
|
||||||
- name: Create Release
|
- name: Create Release
|
||||||
uses: softprops/action-gh-release@v1
|
uses: softprops/action-gh-release@v1
|
||||||
with:
|
with:
|
||||||
name: Matter ${{ github.ref_name }}
|
name: Jecs ${{ github.ref_name }}
|
||||||
body: |
|
|
||||||
Matter ${{ github.ref_name }} is now available!
|
|
||||||
files: |
|
files: |
|
||||||
jecs.rbxm
|
jecs.rbxm
|
||||||
|
|
||||||
|
|
@ -70,4 +68,4 @@ jobs:
|
||||||
run: wally login --token ${{ secrets.WALLY_AUTH_TOKEN }}
|
run: wally login --token ${{ secrets.WALLY_AUTH_TOKEN }}
|
||||||
|
|
||||||
- name: Publish
|
- name: Publish
|
||||||
run: wally publish
|
run: wally publish
|
||||||
|
|
|
||||||
4
.gitignore
vendored
4
.gitignore
vendored
|
|
@ -46,6 +46,10 @@ Packages
|
||||||
wally.lock
|
wally.lock
|
||||||
WallyPatches
|
WallyPatches
|
||||||
|
|
||||||
|
# Typescript
|
||||||
|
/node_modules
|
||||||
|
/include
|
||||||
|
|
||||||
# Misc
|
# Misc
|
||||||
roblox.toml
|
roblox.toml
|
||||||
sourcemap.json
|
sourcemap.json
|
||||||
|
|
|
||||||
120
CHANGELOG.md
Normal file
120
CHANGELOG.md
Normal file
|
|
@ -0,0 +1,120 @@
|
||||||
|
# Jecs Changelog
|
||||||
|
|
||||||
|
All notable changes to this project will be documented in this file.
|
||||||
|
|
||||||
|
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]
|
||||||
|
|
||||||
|
### 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
|
||||||
|
|
||||||
|
### Fixed
|
||||||
|
- 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
|
||||||
|
|
||||||
|
### Added
|
||||||
|
|
||||||
|
- Added observers
|
||||||
|
- Added an arm to query `query:without()` for chaining invariants.
|
||||||
|
|
||||||
|
### Changed
|
||||||
|
- Separates ranges for components and entity IDs.
|
||||||
|
- IDs created with `world:component()` will promote array lookups rather than map lookups in the `componentIndex` which is a significant boost
|
||||||
|
|
||||||
|
- 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
|
||||||
|
|
||||||
|
### Changed
|
||||||
|
- Optimized the creation of the query
|
||||||
|
- It will now finds the smallest archetype map to iterate over
|
||||||
|
- Optimized the query iterator
|
||||||
|
- It will now populates iterator with columns for faster indexing
|
||||||
|
|
||||||
|
- Renamed the insertion method from world:add to world:set to better reflect what it does.
|
||||||
|
|
||||||
|
## [0.0.0-prototype.rc.2] - 2024-04-23
|
||||||
|
- Initial release
|
||||||
|
|
||||||
|
[unreleased]: https://github.com/ukendio/jecs/compare/v0.0.0.0-prototype.rc.2...HEAD
|
||||||
|
[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
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
21
LICENSE
Normal file
21
LICENSE
Normal file
|
|
@ -0,0 +1,21 @@
|
||||||
|
MIT License
|
||||||
|
|
||||||
|
Copyright (c) 2024 jecs authors
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
in the Software without restriction, including without limitation the rights
|
||||||
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
copies of the Software, and to permit persons to whom the Software is
|
||||||
|
furnished to do so, subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in all
|
||||||
|
copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||||
|
SOFTWARE.
|
||||||
|
|
@ -12,7 +12,7 @@ Just an ECS
|
||||||
jecs is a stupidly fast Entity Component System (ECS).
|
jecs is a stupidly fast Entity Component System (ECS).
|
||||||
|
|
||||||
- Entity Relationships as first class citizens
|
- Entity Relationships as first class citizens
|
||||||
- Iterate 350,000 entities at 60 frames per second
|
- Iterate 500,000 entities at 60 frames per second
|
||||||
- Type-safe [Luau](https://luau-lang.org/) API
|
- Type-safe [Luau](https://luau-lang.org/) API
|
||||||
- Zero-dependency package
|
- Zero-dependency package
|
||||||
- Optimized for column-major operations
|
- Optimized for column-major operations
|
||||||
|
|
@ -31,7 +31,7 @@ local Name = world:component()
|
||||||
local function parent(entity)
|
local function parent(entity)
|
||||||
return world:target(entity, ChildOf)
|
return world:target(entity, ChildOf)
|
||||||
end
|
end
|
||||||
local function name(entity)
|
local function getName(entity)
|
||||||
return world:get(entity, Name)
|
return world:get(entity, Name)
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|
@ -58,7 +58,7 @@ end
|
||||||
-- sara is the child of alice
|
-- sara is the child of alice
|
||||||
```
|
```
|
||||||
|
|
||||||
125 archetypes, 4 random components queried.
|
21,000 entities 125 archetypes 4 random components queried.
|
||||||
|
|
||||||
Can be found under /benches/query.lua
|
Can be found under /benches/query.lua
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -15,7 +15,7 @@
|
||||||
"$path": "lib"
|
"$path": "lib"
|
||||||
},
|
},
|
||||||
"rgb": {
|
"rgb": {
|
||||||
"$path": "rgb.lua"
|
"$path": "rgb.luau"
|
||||||
},
|
},
|
||||||
"benches": {
|
"benches": {
|
||||||
"$path": "benches"
|
"$path": "benches"
|
||||||
|
|
|
||||||
|
|
@ -54,8 +54,9 @@ return {
|
||||||
|
|
||||||
Functions = {
|
Functions = {
|
||||||
Matter = function()
|
Matter = function()
|
||||||
for i = 1, 500 do
|
local e = newWorld:spawn()
|
||||||
newWorld:spawn(
|
for i = 1, 5000 do
|
||||||
|
newWorld:insert(e,
|
||||||
A1({ value = true }),
|
A1({ value = true }),
|
||||||
A2({ value = true }),
|
A2({ value = true }),
|
||||||
A3({ value = true }),
|
A3({ value = true }),
|
||||||
|
|
@ -71,7 +72,7 @@ return {
|
||||||
|
|
||||||
ECR = function()
|
ECR = function()
|
||||||
local e = registry2.create()
|
local e = registry2.create()
|
||||||
for i = 1, 500 do
|
for i = 1, 5000 do
|
||||||
registry2:set(e, B1, {value = false})
|
registry2:set(e, B1, {value = false})
|
||||||
registry2:set(e, B2, {value = false})
|
registry2:set(e, B2, {value = false})
|
||||||
registry2:set(e, B3, {value = false})
|
registry2:set(e, B3, {value = false})
|
||||||
|
|
@ -85,11 +86,8 @@ return {
|
||||||
|
|
||||||
|
|
||||||
Jecs = function()
|
Jecs = function()
|
||||||
|
|
||||||
local e = ecs:entity()
|
local e = ecs:entity()
|
||||||
|
for i = 1, 5000 do
|
||||||
for i = 1, 500 do
|
|
||||||
|
|
||||||
ecs:set(e, C1, {value = false})
|
ecs:set(e, C1, {value = false})
|
||||||
ecs:set(e, C2, {value = false})
|
ecs:set(e, C2, {value = false})
|
||||||
ecs:set(e, C3, {value = false})
|
ecs:set(e, C3, {value = false})
|
||||||
|
|
@ -101,23 +99,5 @@ return {
|
||||||
|
|
||||||
end
|
end
|
||||||
end,
|
end,
|
||||||
Mirror = function()
|
|
||||||
|
|
||||||
local e = ecs:entity()
|
|
||||||
|
|
||||||
for i = 1, 500 do
|
|
||||||
|
|
||||||
mcs:set(e, E1, {value = false})
|
|
||||||
mcs:set(e, E2, {value = false})
|
|
||||||
mcs:set(e, E3, {value = false})
|
|
||||||
mcs:set(e, E4, {value = false})
|
|
||||||
mcs:set(e, E5, {value = false})
|
|
||||||
mcs:set(e, E6, {value = false})
|
|
||||||
mcs:set(e, E7, {value = false})
|
|
||||||
mcs:set(e, E8, {value = false})
|
|
||||||
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
|
|
@ -3,8 +3,8 @@
|
||||||
|
|
||||||
local ReplicatedStorage = game:GetService("ReplicatedStorage")
|
local ReplicatedStorage = game:GetService("ReplicatedStorage")
|
||||||
local rgb = require(ReplicatedStorage.rgb)
|
local rgb = require(ReplicatedStorage.rgb)
|
||||||
local Matter = require(ReplicatedStorage.DevPackages.Matter)
|
local Matter = require(ReplicatedStorage.DevPackages["_Index"]["matter-ecs_matter@0.8.1"].matter)
|
||||||
local ecr = require(ReplicatedStorage.DevPackages.ecr)
|
local ecr = require(ReplicatedStorage.DevPackages["_Index"]["centau_ecr@0.8.0"].ecr)
|
||||||
local newWorld = Matter.World.new()
|
local newWorld = Matter.World.new()
|
||||||
|
|
||||||
local jecs = require(ReplicatedStorage.Lib)
|
local jecs = require(ReplicatedStorage.Lib)
|
||||||
|
|
@ -177,6 +177,13 @@ return {
|
||||||
end
|
end
|
||||||
end,
|
end,
|
||||||
|
|
||||||
|
Matter = function()
|
||||||
|
local matched = 0
|
||||||
|
for entityId, firstComponent in newWorld:query(A1, A4, A6, A8) do
|
||||||
|
matched += 1
|
||||||
|
end
|
||||||
|
end,
|
||||||
|
|
||||||
ECR = function()
|
ECR = function()
|
||||||
local matched = 0
|
local matched = 0
|
||||||
for entityId, firstComponent in registry2:view(B1, B4, B6, B8) do
|
for entityId, firstComponent in registry2:view(B1, B4, B6, B8) do
|
||||||
45
docs/api-types.md
Normal file
45
docs/api-types.md
Normal file
|
|
@ -0,0 +1,45 @@
|
||||||
|
# World
|
||||||
|
|
||||||
|
A World contains all ECS data
|
||||||
|
Games can have multiple worlds, although typically only one is necessary. These worlds are isolated from each other, meaning they donot share the same entities nor component IDs.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
# Entity
|
||||||
|
|
||||||
|
An unique id.
|
||||||
|
|
||||||
|
Entities consist out of a number unique to the entity in the lower 32 bits, and a counter used to track entity liveliness in the upper 32 bits. When an id is recycled, its generation count is increased. This causes recycled ids to be very large (>4 billion), which is normal.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
# QueryIter
|
||||||
|
|
||||||
|
A result from the `World:query` function.
|
||||||
|
|
||||||
|
Queries are used to iterate over entities that match against the set collection of components.
|
||||||
|
|
||||||
|
Calling it in a loop will allow iteration over the results.
|
||||||
|
|
||||||
|
```lua
|
||||||
|
for id, enemy, charge, model in world:query(Enemy, Charge, Model) do
|
||||||
|
-- Do something
|
||||||
|
end
|
||||||
|
```
|
||||||
|
|
||||||
|
### QueryIter.without
|
||||||
|
|
||||||
|
QueryIter.without(iter: QueryIter
|
||||||
|
...: [Entity](#Entity)): QueryIter
|
||||||
|
|
||||||
|
|
||||||
|
Create a new Query Iterator from the filter
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
world The world.
|
||||||
|
... The collection of components to filter archetypes against.
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
The new query iterator.
|
||||||
|
|
||||||
187
docs/api/world.md
Normal file
187
docs/api/world.md
Normal file
|
|
@ -0,0 +1,187 @@
|
||||||
|
# World
|
||||||
|
|
||||||
|
### World.new
|
||||||
|
|
||||||
|
World.new(): [World](../api-types.md#World)
|
||||||
|
|
||||||
|
Create a new world.
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
A new world
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### World.entity
|
||||||
|
|
||||||
|
World.entity(world: [World](../api-types.md#World)): [Entity](../api-types.md#Entity)
|
||||||
|
|
||||||
|
Creates an entity in the world.
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
A new entiity id
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### World.target
|
||||||
|
|
||||||
|
World.target(world: [World](../api-types.md#World),
|
||||||
|
entity: [Entity](../api-types.md#Entity),
|
||||||
|
rel: [Entity](../api-types.md#Entity)): [Entity](../api-types.md#Entity)
|
||||||
|
|
||||||
|
Get the target of a relationship.
|
||||||
|
|
||||||
|
This will return a target (second element of a pair) of the entity for the specified relationship.
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
world The world.
|
||||||
|
entity The entity.
|
||||||
|
rel The relationship between the entity and the target.
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
The first target for the relationship
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### World.add
|
||||||
|
|
||||||
|
World.add(world: [World](../api-types.md#World),
|
||||||
|
entity: [Entity](../api-types.md#Entity),
|
||||||
|
id: [Entity](../api-types.md#Entity)): [Entity](..#api-types.md#Entity)
|
||||||
|
|
||||||
|
Add a (component) id to an entity.
|
||||||
|
|
||||||
|
This operation adds a single (component) id to an entity.
|
||||||
|
If the entity already has the id, this operation will have no side effects.
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
world The world.
|
||||||
|
entity The entity.
|
||||||
|
id The id to add.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### World.remove
|
||||||
|
|
||||||
|
World.remove(world: [World](../api-types#World),
|
||||||
|
entity: [Entity](../api-types#Entity),
|
||||||
|
id: [Entity](../api-types#Entity)): [Entity](../api-types#Entity)
|
||||||
|
|
||||||
|
Remove a (component) id to an entity.
|
||||||
|
|
||||||
|
This operation removes a single (component) id to an entity.
|
||||||
|
If the entity already has the id, this operation will have no side effects.
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
world The world.
|
||||||
|
entity The entity.
|
||||||
|
id The id to add.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### World.get
|
||||||
|
|
||||||
|
World.get(world: [World](../api-types.md#World),
|
||||||
|
entity: [Entity](../api-types.md#Entity),
|
||||||
|
id: [Entity](../api-types.md#Entity)): any
|
||||||
|
|
||||||
|
Gets the component data.
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
world The world.
|
||||||
|
entity The entity.
|
||||||
|
id The id of component to get.
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
The component data, nil if the entity does not have the componnet.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### World.set
|
||||||
|
|
||||||
|
World.set(world: [World](../api-types.md#World),
|
||||||
|
entity: [Entity](../api-types.md#Entity),
|
||||||
|
id: [Entity](../api-types.md#Entity)
|
||||||
|
data: any)
|
||||||
|
|
||||||
|
Set the value of a component.
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
world The world.
|
||||||
|
entity The entity.
|
||||||
|
id The id of the componment set.
|
||||||
|
data The data to the component.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### World.query
|
||||||
|
|
||||||
|
World.query(world: [World](../api-types.md#World),
|
||||||
|
...: [Entity](../api-types.mdEntity)): [QueryIter](../api-types.md#QueryIter)
|
||||||
|
|
||||||
|
Create a QueryIter from the list of filters.
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
world The world.
|
||||||
|
... The collection of components to match entities against.
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
The query iterator.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
# Pair
|
||||||
|
|
||||||
|
### pair
|
||||||
|
|
||||||
|
pair(first: [Entity](../api-types#Entity), second: [Entity](../api-types#Entity)): [Entity](../api-types#Entity)
|
||||||
|
|
||||||
|
Creates a composite key.
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
first The first element.
|
||||||
|
second The second element.
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
The pair of the two elements
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### IS_PAIR
|
||||||
|
|
||||||
|
jecs.IS_PAIR(id: [Entity](../api-types#Entity)): boolean
|
||||||
|
|
||||||
|
Creates a composite key.
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
id The id to check.
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
If id is a pair.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
# Constants
|
||||||
|
|
||||||
|
### OnAdd
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### OnRemove
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### Rest
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### OnSet
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### Wildcard
|
||||||
|
|
||||||
|
Matches any id, returns all matches.
|
||||||
19
docs/tutorials/quick-start/getting-started.md
Normal file
19
docs/tutorials/quick-start/getting-started.md
Normal file
|
|
@ -0,0 +1,19 @@
|
||||||
|
# Getting Started
|
||||||
|
This section will provide a walk through setting up your development environment and a quick overview of the different features and concepts in Jecs with short examples.
|
||||||
|
|
||||||
|
## Installing Jecs
|
||||||
|
|
||||||
|
To use Jecs, you will need to add the library to your project's source folder.
|
||||||
|
|
||||||
|
## Installing as standalone
|
||||||
|
Head over to the [Releases](https://github.com/ukendio/jecs/releases/latest) page and install the rbxm file.
|
||||||
|
|
||||||
|
|
||||||
|
## Installing with Wally
|
||||||
|
Jecs is available as a package on [wally.run](https://wally.run/package/ukendio/jecs)
|
||||||
|
|
||||||
|
Add it to your project's Wally.toml like this:
|
||||||
|
```toml
|
||||||
|
[dependencies]
|
||||||
|
jecs = "0.1.0" # Make sure this is the latest version
|
||||||
|
```
|
||||||
BIN
docs/tutorials/quick-start/rbxm.png
Normal file
BIN
docs/tutorials/quick-start/rbxm.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 34 KiB |
BIN
image-3.png
BIN
image-3.png
Binary file not shown.
|
Before Width: | Height: | Size: 121 KiB After Width: | Height: | Size: 76 KiB |
938
lib/init.lua
938
lib/init.lua
|
|
@ -1,938 +0,0 @@
|
||||||
--!optimize 2
|
|
||||||
--!native
|
|
||||||
--!strict
|
|
||||||
--draft 4
|
|
||||||
|
|
||||||
type i53 = number
|
|
||||||
type i24 = number
|
|
||||||
|
|
||||||
type Ty = {i53}
|
|
||||||
type ArchetypeId = number
|
|
||||||
|
|
||||||
type Column = {any}
|
|
||||||
|
|
||||||
type Archetype = {
|
|
||||||
id: number,
|
|
||||||
edges: {
|
|
||||||
[i53]: {
|
|
||||||
add: Archetype,
|
|
||||||
remove: Archetype,
|
|
||||||
},
|
|
||||||
},
|
|
||||||
types: Ty,
|
|
||||||
type: string | number,
|
|
||||||
entities: {number},
|
|
||||||
columns: {Column},
|
|
||||||
records: {},
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
type Record = {
|
|
||||||
archetype: Archetype,
|
|
||||||
row: number,
|
|
||||||
dense: i24,
|
|
||||||
componentRecord: ArchetypeMap
|
|
||||||
}
|
|
||||||
|
|
||||||
type EntityIndex = {dense: {[i24]: i53}, sparse: {[i53]: Record}}
|
|
||||||
|
|
||||||
type ArchetypeRecord = number
|
|
||||||
--[[
|
|
||||||
TODO:
|
|
||||||
{
|
|
||||||
index: number,
|
|
||||||
count: number,
|
|
||||||
column: number
|
|
||||||
}
|
|
||||||
|
|
||||||
]]
|
|
||||||
|
|
||||||
type ArchetypeMap = {
|
|
||||||
cache: {[number]: ArchetypeRecord},
|
|
||||||
first: ArchetypeMap,
|
|
||||||
second: ArchetypeMap,
|
|
||||||
parent: ArchetypeMap,
|
|
||||||
size: number
|
|
||||||
}
|
|
||||||
|
|
||||||
type ComponentIndex = {[i24]: ArchetypeMap}
|
|
||||||
|
|
||||||
type Archetypes = {[ArchetypeId]: Archetype}
|
|
||||||
|
|
||||||
type ArchetypeDiff = {
|
|
||||||
added: Ty,
|
|
||||||
removed: Ty,
|
|
||||||
}
|
|
||||||
|
|
||||||
local FLAGS_PAIR = 0x8
|
|
||||||
local HI_COMPONENT_ID = 256
|
|
||||||
local ON_ADD = HI_COMPONENT_ID + 1
|
|
||||||
local ON_REMOVE = HI_COMPONENT_ID + 2
|
|
||||||
local ON_SET = HI_COMPONENT_ID + 3
|
|
||||||
local WILDCARD = HI_COMPONENT_ID + 4
|
|
||||||
local REST = HI_COMPONENT_ID + 5
|
|
||||||
|
|
||||||
local ECS_ID_FLAGS_MASK = 0x10
|
|
||||||
local ECS_ENTITY_MASK = bit32.lshift(1, 24)
|
|
||||||
local ECS_GENERATION_MASK = bit32.lshift(1, 16)
|
|
||||||
|
|
||||||
local function addFlags(isPair: boolean)
|
|
||||||
local typeFlags = 0x0
|
|
||||||
|
|
||||||
if isPair then
|
|
||||||
typeFlags = bit32.bor(typeFlags, FLAGS_PAIR) -- HIGHEST bit in the ID.
|
|
||||||
end
|
|
||||||
if false then
|
|
||||||
typeFlags = bit32.bor(typeFlags, 0x4) -- Set the second flag to true
|
|
||||||
end
|
|
||||||
if false then
|
|
||||||
typeFlags = bit32.bor(typeFlags, 0x2) -- Set the third flag to true
|
|
||||||
end
|
|
||||||
if false then
|
|
||||||
typeFlags = bit32.bor(typeFlags, 0x1) -- LAST BIT in the ID.
|
|
||||||
end
|
|
||||||
|
|
||||||
return typeFlags
|
|
||||||
end
|
|
||||||
|
|
||||||
local function ECS_COMBINE(source: number, target: number): i53
|
|
||||||
local e = source * 2^28 + target * ECS_ID_FLAGS_MASK
|
|
||||||
return e
|
|
||||||
end
|
|
||||||
|
|
||||||
local function ECS_IS_PAIR(e: number)
|
|
||||||
return (e % 2^4) // FLAGS_PAIR ~= 0
|
|
||||||
end
|
|
||||||
|
|
||||||
function separate(entity: number)
|
|
||||||
local _typeFlags = entity % 0x10
|
|
||||||
entity //= ECS_ID_FLAGS_MASK
|
|
||||||
return entity // ECS_ENTITY_MASK, entity % ECS_GENERATION_MASK, _typeFlags
|
|
||||||
end
|
|
||||||
|
|
||||||
-- HIGH 24 bits LOW 24 bits
|
|
||||||
local function ECS_GENERATION(e: i53)
|
|
||||||
e //= 0x10
|
|
||||||
return e % ECS_GENERATION_MASK
|
|
||||||
end
|
|
||||||
|
|
||||||
-- SECOND
|
|
||||||
local function ECS_ENTITY_T_LO(e: i53)
|
|
||||||
e //= 0x10
|
|
||||||
return e // ECS_ENTITY_MASK
|
|
||||||
end
|
|
||||||
|
|
||||||
local function ECS_GENERATION_INC(e: i53)
|
|
||||||
local id, generation, flags = separate(e)
|
|
||||||
|
|
||||||
return ECS_COMBINE(id, generation + 1) + flags
|
|
||||||
end
|
|
||||||
|
|
||||||
-- FIRST gets the high ID
|
|
||||||
local function ECS_ENTITY_T_HI(entity: i53): i24
|
|
||||||
entity //= 0x10
|
|
||||||
local first = entity % ECS_ENTITY_MASK
|
|
||||||
return first
|
|
||||||
end
|
|
||||||
|
|
||||||
local function ECS_PAIR(pred: number, obj: number)
|
|
||||||
local first
|
|
||||||
local second: number = WILDCARD
|
|
||||||
|
|
||||||
if pred == WILDCARD then
|
|
||||||
first = obj
|
|
||||||
elseif obj == WILDCARD then
|
|
||||||
first = pred
|
|
||||||
else
|
|
||||||
first = obj
|
|
||||||
second = ECS_ENTITY_T_LO(pred)
|
|
||||||
end
|
|
||||||
|
|
||||||
return ECS_COMBINE(
|
|
||||||
ECS_ENTITY_T_LO(first), second) + addFlags(--[[isPair]] true)
|
|
||||||
end
|
|
||||||
|
|
||||||
local function getAlive(entityIndex: EntityIndex, id: i24)
|
|
||||||
local entityId = entityIndex.dense[id]
|
|
||||||
local record = entityIndex.sparse[entityIndex.dense[id]]
|
|
||||||
if not record then
|
|
||||||
error(id.." is not alive")
|
|
||||||
end
|
|
||||||
return entityId
|
|
||||||
end
|
|
||||||
|
|
||||||
-- ECS_PAIR_FIRST, gets the relationship target / obj / HIGH bits
|
|
||||||
local function ECS_PAIR_RELATION(entityIndex, e)
|
|
||||||
assert(ECS_IS_PAIR(e))
|
|
||||||
return getAlive(entityIndex, ECS_ENTITY_T_HI(e))
|
|
||||||
end
|
|
||||||
|
|
||||||
-- ECS_PAIR_SECOND gets the relationship / pred / LOW bits
|
|
||||||
local function ECS_PAIR_OBJECT(entityIndex, e)
|
|
||||||
assert(ECS_IS_PAIR(e))
|
|
||||||
return getAlive(entityIndex, ECS_ENTITY_T_LO(e))
|
|
||||||
end
|
|
||||||
|
|
||||||
local function nextEntityId(entityIndex, index: i24): i53
|
|
||||||
local id = ECS_COMBINE(index, 0)
|
|
||||||
entityIndex.sparse[id] = {
|
|
||||||
dense = index
|
|
||||||
} :: Record
|
|
||||||
entityIndex.dense[index] = id
|
|
||||||
|
|
||||||
return id
|
|
||||||
end
|
|
||||||
|
|
||||||
local function transitionArchetype(
|
|
||||||
entityIndex: EntityIndex,
|
|
||||||
to: Archetype,
|
|
||||||
destinationRow: i24,
|
|
||||||
from: Archetype,
|
|
||||||
sourceRow: i24
|
|
||||||
)
|
|
||||||
local columns = from.columns
|
|
||||||
local sourceEntities = from.entities
|
|
||||||
local destinationEntities = to.entities
|
|
||||||
local destinationColumns = to.columns
|
|
||||||
local tr = to.records
|
|
||||||
local types = from.types
|
|
||||||
|
|
||||||
for i, column in columns do
|
|
||||||
-- Retrieves the new column index from the source archetype's record from each component
|
|
||||||
-- We have to do this because the columns are tightly packed and indexes may not correspond to each other.
|
|
||||||
local targetColumn = destinationColumns[tr[types[i]]]
|
|
||||||
|
|
||||||
-- Sometimes target column may not exist, e.g. when you remove a component.
|
|
||||||
if targetColumn then
|
|
||||||
targetColumn[destinationRow] = column[sourceRow]
|
|
||||||
end
|
|
||||||
-- If the entity is the last row in the archetype then swapping it would be meaningless.
|
|
||||||
local last = #column
|
|
||||||
if sourceRow ~= last then
|
|
||||||
-- Swap rempves columns to ensure there are no holes in the archetype.
|
|
||||||
column[sourceRow] = column[last]
|
|
||||||
end
|
|
||||||
column[last] = nil
|
|
||||||
end
|
|
||||||
|
|
||||||
local sparse = entityIndex.sparse
|
|
||||||
local movedAway = #sourceEntities
|
|
||||||
|
|
||||||
-- Move the entity from the source to the destination archetype.
|
|
||||||
-- Because we have swapped columns we now have to update the records
|
|
||||||
-- corresponding to the entities' rows that were swapped.
|
|
||||||
local e1 = sourceEntities[sourceRow]
|
|
||||||
local e2 = sourceEntities[movedAway]
|
|
||||||
|
|
||||||
if sourceRow ~= movedAway then
|
|
||||||
sourceEntities[sourceRow] = e2
|
|
||||||
end
|
|
||||||
|
|
||||||
sourceEntities[movedAway] = nil
|
|
||||||
destinationEntities[destinationRow] = e1
|
|
||||||
|
|
||||||
local record1 = sparse[e1]
|
|
||||||
local record2 = sparse[e2]
|
|
||||||
|
|
||||||
record1.row = destinationRow
|
|
||||||
record2.row = sourceRow
|
|
||||||
end
|
|
||||||
|
|
||||||
local function archetypeAppend(entity: number, archetype: Archetype): number
|
|
||||||
local entities = archetype.entities
|
|
||||||
local length = #entities + 1
|
|
||||||
entities[length] = entity
|
|
||||||
return length
|
|
||||||
end
|
|
||||||
|
|
||||||
local function newEntity(entityId: i53, record: Record, archetype: Archetype)
|
|
||||||
local row = archetypeAppend(entityId, archetype)
|
|
||||||
record.archetype = archetype
|
|
||||||
record.row = row
|
|
||||||
return record
|
|
||||||
end
|
|
||||||
|
|
||||||
local function moveEntity(entityIndex, entityId: i53, record: Record, to: Archetype)
|
|
||||||
local sourceRow = record.row
|
|
||||||
local from = record.archetype
|
|
||||||
local destinationRow = archetypeAppend(entityId, to)
|
|
||||||
transitionArchetype(entityIndex, to, destinationRow, from, sourceRow)
|
|
||||||
record.archetype = to
|
|
||||||
record.row = destinationRow
|
|
||||||
end
|
|
||||||
|
|
||||||
local function hash(arr): string | number
|
|
||||||
return table.concat(arr, "_")
|
|
||||||
end
|
|
||||||
|
|
||||||
local function ensureComponentRecord(componentIndex: ComponentIndex, archetypeId, componentId, i): ArchetypeMap
|
|
||||||
local archetypesMap = componentIndex[componentId]
|
|
||||||
|
|
||||||
if not archetypesMap then
|
|
||||||
archetypesMap = {size = 0, cache = {}, first = {}, second = {}} :: ArchetypeMap
|
|
||||||
componentIndex[componentId] = archetypesMap
|
|
||||||
end
|
|
||||||
|
|
||||||
archetypesMap.cache[archetypeId] = i
|
|
||||||
archetypesMap.size += 1
|
|
||||||
|
|
||||||
return archetypesMap
|
|
||||||
end
|
|
||||||
|
|
||||||
local function ECS_ID_IS_WILDCARD(e)
|
|
||||||
assert(ECS_IS_PAIR(e))
|
|
||||||
local first = ECS_ENTITY_T_HI(e)
|
|
||||||
local second = ECS_ENTITY_T_LO(e)
|
|
||||||
return first == WILDCARD or second == WILDCARD
|
|
||||||
end
|
|
||||||
|
|
||||||
|
|
||||||
local function archetypeOf(world: any, types: {i24}, prev: Archetype?): Archetype
|
|
||||||
local ty = hash(types)
|
|
||||||
|
|
||||||
local id = world.nextArchetypeId + 1
|
|
||||||
world.nextArchetypeId = id
|
|
||||||
|
|
||||||
local length = #types
|
|
||||||
local columns = table.create(length)
|
|
||||||
local componentIndex = world.componentIndex
|
|
||||||
|
|
||||||
local records = {}
|
|
||||||
for i, componentId in types do
|
|
||||||
ensureComponentRecord(componentIndex, id, componentId, i)
|
|
||||||
records[componentId] = i
|
|
||||||
if ECS_IS_PAIR(componentId) then
|
|
||||||
local relation = ECS_PAIR_RELATION(world.entityIndex, componentId)
|
|
||||||
local object = ECS_PAIR_OBJECT(world.entityIndex, componentId)
|
|
||||||
|
|
||||||
local idr_r = ECS_PAIR(relation, WILDCARD)
|
|
||||||
ensureComponentRecord(
|
|
||||||
componentIndex, id, idr_r, i)
|
|
||||||
records[idr_r] = i
|
|
||||||
|
|
||||||
local idr_t = ECS_PAIR(WILDCARD, object)
|
|
||||||
ensureComponentRecord(
|
|
||||||
componentIndex, id, idr_t, i)
|
|
||||||
records[idr_t] = i
|
|
||||||
end
|
|
||||||
columns[i] = {}
|
|
||||||
end
|
|
||||||
|
|
||||||
local archetype = {
|
|
||||||
columns = columns;
|
|
||||||
edges = {};
|
|
||||||
entities = {};
|
|
||||||
id = id;
|
|
||||||
records = records;
|
|
||||||
type = ty;
|
|
||||||
types = types;
|
|
||||||
}
|
|
||||||
world.archetypeIndex[ty] = archetype
|
|
||||||
world.archetypes[id] = archetype
|
|
||||||
|
|
||||||
return archetype
|
|
||||||
end
|
|
||||||
|
|
||||||
local World = {}
|
|
||||||
World.__index = World
|
|
||||||
function World.new()
|
|
||||||
local self = setmetatable({
|
|
||||||
archetypeIndex = {};
|
|
||||||
archetypes = {} :: Archetypes;
|
|
||||||
componentIndex = {} :: ComponentIndex;
|
|
||||||
entityIndex = {
|
|
||||||
dense = {},
|
|
||||||
sparse = {}
|
|
||||||
} :: EntityIndex;
|
|
||||||
hooks = {
|
|
||||||
[ON_ADD] = {};
|
|
||||||
};
|
|
||||||
nextArchetypeId = 0;
|
|
||||||
nextComponentId = 0;
|
|
||||||
nextEntityId = 0;
|
|
||||||
ROOT_ARCHETYPE = (nil :: any) :: Archetype;
|
|
||||||
}, World)
|
|
||||||
self.ROOT_ARCHETYPE = archetypeOf(self, {})
|
|
||||||
return self
|
|
||||||
end
|
|
||||||
|
|
||||||
function World.component(world: World)
|
|
||||||
local componentId = world.nextComponentId + 1
|
|
||||||
if componentId > HI_COMPONENT_ID then
|
|
||||||
-- IDs are partitioned into ranges because component IDs are not nominal,
|
|
||||||
-- so it needs to error when IDs intersect into the entity range.
|
|
||||||
error("Too many components, consider using world:entity() instead to create components.")
|
|
||||||
end
|
|
||||||
world.nextComponentId = componentId
|
|
||||||
return nextEntityId(world.entityIndex, componentId)
|
|
||||||
end
|
|
||||||
|
|
||||||
function World.entity(world: World)
|
|
||||||
local entityId = world.nextEntityId + 1
|
|
||||||
world.nextEntityId = entityId
|
|
||||||
return nextEntityId(world.entityIndex, entityId + REST)
|
|
||||||
end
|
|
||||||
|
|
||||||
-- TODO:
|
|
||||||
-- should have an additional `index` parameter which selects the nth target
|
|
||||||
-- this is important when an entity can have multiple relationships with the same target
|
|
||||||
function World.target(world: World, entity: i53, relation: i24): i24?
|
|
||||||
local entityIndex = world.entityIndex
|
|
||||||
local record = entityIndex.sparse[entity]
|
|
||||||
local archetype = record.archetype
|
|
||||||
if not archetype then
|
|
||||||
return nil
|
|
||||||
end
|
|
||||||
local componentRecord = world.componentIndex[ECS_PAIR(relation, WILDCARD)]
|
|
||||||
if not componentRecord then
|
|
||||||
return nil
|
|
||||||
end
|
|
||||||
|
|
||||||
local archetypeRecord = componentRecord.cache[archetype.id]
|
|
||||||
if not archetypeRecord then
|
|
||||||
return nil
|
|
||||||
end
|
|
||||||
|
|
||||||
return ECS_PAIR_OBJECT(entityIndex, archetype.types[archetypeRecord])
|
|
||||||
end
|
|
||||||
|
|
||||||
-- should reuse this logic in World.set instead of swap removing in transition archetype
|
|
||||||
local function destructColumns(columns, count, row)
|
|
||||||
if row == count then
|
|
||||||
for _, column in columns do
|
|
||||||
column[count] = nil
|
|
||||||
end
|
|
||||||
else
|
|
||||||
for _, column in columns do
|
|
||||||
column[row] = column[count]
|
|
||||||
column[count] = nil
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
local function archetypeDelete(world: World, id: i53)
|
|
||||||
local componentIndex = world.componentIndex
|
|
||||||
local archetypesMap = componentIndex[id]
|
|
||||||
local archetypes = world.archetypes
|
|
||||||
if archetypesMap then
|
|
||||||
for archetypeId in archetypesMap.cache do
|
|
||||||
for _, entity in archetypes[archetypeId].entities do
|
|
||||||
world:remove(entity, id)
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
componentIndex[id] = nil
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
function World.delete(world: World, entityId: i53)
|
|
||||||
local record = world.entityIndex.sparse[entityId]
|
|
||||||
if not record then
|
|
||||||
return
|
|
||||||
end
|
|
||||||
local entityIndex = world.entityIndex
|
|
||||||
local sparse, dense = entityIndex.sparse, entityIndex.dense
|
|
||||||
local archetype = record.archetype
|
|
||||||
local row = record.row
|
|
||||||
|
|
||||||
archetypeDelete(world, entityId)
|
|
||||||
-- TODO: should traverse linked )component records to pairs including entityId
|
|
||||||
archetypeDelete(world, ECS_PAIR(entityId, WILDCARD))
|
|
||||||
archetypeDelete(world, ECS_PAIR(WILDCARD, entityId))
|
|
||||||
|
|
||||||
if archetype then
|
|
||||||
local entities = archetype.entities
|
|
||||||
local last = #entities
|
|
||||||
|
|
||||||
if row ~= last then
|
|
||||||
local entityToMove = entities[last]
|
|
||||||
dense[record.dense] = entityToMove
|
|
||||||
sparse[entityToMove] = record
|
|
||||||
end
|
|
||||||
|
|
||||||
entities[row], entities[last] = entities[last], nil
|
|
||||||
|
|
||||||
local columns = archetype.columns
|
|
||||||
|
|
||||||
destructColumns(columns, last, row)
|
|
||||||
end
|
|
||||||
|
|
||||||
sparse[entityId] = nil
|
|
||||||
dense[#dense] = nil
|
|
||||||
end
|
|
||||||
|
|
||||||
export type World = typeof(World.new())
|
|
||||||
|
|
||||||
local function ensureArchetype(world: World, types, prev)
|
|
||||||
if #types < 1 then
|
|
||||||
return world.ROOT_ARCHETYPE
|
|
||||||
end
|
|
||||||
|
|
||||||
local ty = hash(types)
|
|
||||||
local archetype = world.archetypeIndex[ty]
|
|
||||||
if archetype then
|
|
||||||
return archetype
|
|
||||||
end
|
|
||||||
|
|
||||||
return archetypeOf(world, types, prev)
|
|
||||||
end
|
|
||||||
|
|
||||||
local function findInsert(types: {i53}, toAdd: i53)
|
|
||||||
for i, id in types do
|
|
||||||
if id == toAdd then
|
|
||||||
return -1
|
|
||||||
end
|
|
||||||
if id > toAdd then
|
|
||||||
return i
|
|
||||||
end
|
|
||||||
end
|
|
||||||
return #types + 1
|
|
||||||
end
|
|
||||||
|
|
||||||
local function findArchetypeWith(world: World, node: Archetype, componentId: i53)
|
|
||||||
local types = node.types
|
|
||||||
-- Component IDs are added incrementally, so inserting and sorting
|
|
||||||
-- them each time would be expensive. Instead this insertion sort can find the insertion
|
|
||||||
-- point in the types array.
|
|
||||||
|
|
||||||
local destinationType = table.clone(node.types)
|
|
||||||
local at = findInsert(types, componentId)
|
|
||||||
if at == -1 then
|
|
||||||
-- If it finds a duplicate, it just means it is the same archetype so it can return it
|
|
||||||
-- directly instead of needing to hash types for a lookup to the archetype.
|
|
||||||
return node
|
|
||||||
end
|
|
||||||
table.insert(destinationType, at, componentId)
|
|
||||||
|
|
||||||
return ensureArchetype(world, destinationType, node)
|
|
||||||
end
|
|
||||||
|
|
||||||
local function ensureEdge(archetype: Archetype, componentId: i53)
|
|
||||||
local edges = archetype.edges
|
|
||||||
local edge = edges[componentId]
|
|
||||||
if not edge then
|
|
||||||
edge = {} :: any
|
|
||||||
edges[componentId] = edge
|
|
||||||
end
|
|
||||||
return edge
|
|
||||||
end
|
|
||||||
|
|
||||||
local function archetypeTraverseAdd(world: World, componentId: i53, from: Archetype): Archetype
|
|
||||||
from = from or world.ROOT_ARCHETYPE
|
|
||||||
|
|
||||||
local edge = ensureEdge(from, componentId)
|
|
||||||
local add = edge.add
|
|
||||||
if not add then
|
|
||||||
-- Save an edge using the component ID to the archetype to allow
|
|
||||||
-- faster traversals to adjacent archetypes.
|
|
||||||
add = findArchetypeWith(world, from, componentId)
|
|
||||||
edge.add = add :: never
|
|
||||||
end
|
|
||||||
|
|
||||||
return add
|
|
||||||
end
|
|
||||||
|
|
||||||
function World.add(world: World, entityId: i53, componentId: i53)
|
|
||||||
local entityIndex = world.entityIndex
|
|
||||||
local record = entityIndex.sparse[entityId]
|
|
||||||
local from = record.archetype
|
|
||||||
local to = archetypeTraverseAdd(world, componentId, from)
|
|
||||||
if from and not (from == world.ROOT_ARCHETYPE) then
|
|
||||||
moveEntity(entityIndex, entityId, record, to)
|
|
||||||
else
|
|
||||||
if #to.types > 0 then
|
|
||||||
newEntity(entityId, record, to)
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
-- Symmetric like `World.add` but idempotent
|
|
||||||
function World.set(world: World, entityId: i53, componentId: i53, data: unknown)
|
|
||||||
local record = world.entityIndex.sparse[entityId]
|
|
||||||
local from = record.archetype
|
|
||||||
local to = archetypeTraverseAdd(world, componentId, from)
|
|
||||||
|
|
||||||
if from == to then
|
|
||||||
-- If the archetypes are the same it can avoid moving the entity
|
|
||||||
-- and just set the data directly.
|
|
||||||
local archetypeRecord = to.records[componentId]
|
|
||||||
from.columns[archetypeRecord][record.row] = data
|
|
||||||
-- Should fire an OnSet event here.
|
|
||||||
return
|
|
||||||
end
|
|
||||||
|
|
||||||
if from then
|
|
||||||
-- If there was a previous archetype, then the entity needs to move the archetype
|
|
||||||
moveEntity(world.entityIndex, entityId, record, to)
|
|
||||||
else
|
|
||||||
if #to.types > 0 then
|
|
||||||
-- When there is no previous archetype it should create the archetype
|
|
||||||
newEntity(entityId, record, to)
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
local archetypeRecord = to.records[componentId]
|
|
||||||
to.columns[archetypeRecord][record.row] = data
|
|
||||||
end
|
|
||||||
|
|
||||||
local function archetypeTraverseRemove(world: World, componentId: i53, from: Archetype): Archetype
|
|
||||||
local edge = ensureEdge(from, componentId)
|
|
||||||
|
|
||||||
local remove = edge.remove
|
|
||||||
if not remove then
|
|
||||||
local to = table.clone(from.types)
|
|
||||||
local at = table.find(to, componentId)
|
|
||||||
if not at then
|
|
||||||
return from
|
|
||||||
end
|
|
||||||
table.remove(to, at)
|
|
||||||
remove = ensureArchetype(world, to, from)
|
|
||||||
edge.remove = remove :: never
|
|
||||||
end
|
|
||||||
|
|
||||||
return remove
|
|
||||||
end
|
|
||||||
|
|
||||||
function World.remove(world: World, entityId: i53, componentId: i53)
|
|
||||||
local entityIndex = world.entityIndex
|
|
||||||
local record = entityIndex.sparse[entityId]
|
|
||||||
local sourceArchetype = record.archetype
|
|
||||||
local destinationArchetype = archetypeTraverseRemove(world, componentId, sourceArchetype)
|
|
||||||
|
|
||||||
if sourceArchetype and not (sourceArchetype == destinationArchetype) then
|
|
||||||
moveEntity(entityIndex, entityId, record, destinationArchetype)
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
-- Keeping the function as small as possible to enable inlining
|
|
||||||
local function get(record: Record, componentId: i24)
|
|
||||||
local archetype = record.archetype
|
|
||||||
if not archetype then
|
|
||||||
return nil
|
|
||||||
end
|
|
||||||
|
|
||||||
local archetypeRecord = archetype.records[componentId]
|
|
||||||
|
|
||||||
if not archetypeRecord then
|
|
||||||
return nil
|
|
||||||
end
|
|
||||||
|
|
||||||
return archetype.columns[archetypeRecord][record.row]
|
|
||||||
end
|
|
||||||
|
|
||||||
function World.get(world: World, entityId: i53, a: i53, b: i53?, c: i53?, d: i53?, e: i53?)
|
|
||||||
local id = entityId
|
|
||||||
local record = world.entityIndex.sparse[id]
|
|
||||||
if not record then
|
|
||||||
return nil
|
|
||||||
end
|
|
||||||
|
|
||||||
local va = get(record, a)
|
|
||||||
|
|
||||||
if b == nil then
|
|
||||||
return va
|
|
||||||
elseif c == nil then
|
|
||||||
return va, get(record, b)
|
|
||||||
elseif d == nil then
|
|
||||||
return va, get(record, b), get(record, c)
|
|
||||||
elseif e == nil then
|
|
||||||
return va, get(record, b), get(record, c), get(record, d)
|
|
||||||
else
|
|
||||||
error("args exceeded")
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
local function noop() end
|
|
||||||
local function iterNoop(_self: Query, ...: i53): () -> (number, ...any)
|
|
||||||
return noop :: any
|
|
||||||
end
|
|
||||||
|
|
||||||
local EmptyQuery
|
|
||||||
EmptyQuery = {
|
|
||||||
__iter = iterNoop,
|
|
||||||
next = noop,
|
|
||||||
patch = noop,
|
|
||||||
without = function()
|
|
||||||
return EmptyQuery
|
|
||||||
end
|
|
||||||
}
|
|
||||||
|
|
||||||
EmptyQuery.__index = EmptyQuery
|
|
||||||
setmetatable(EmptyQuery, EmptyQuery)
|
|
||||||
|
|
||||||
export type Query = typeof(EmptyQuery)
|
|
||||||
|
|
||||||
local function replace(row, columns, ...)
|
|
||||||
for i, column in columns do
|
|
||||||
column[row] = select(i, ...)
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
function World.query(world: World, ...): Query
|
|
||||||
-- breaking?
|
|
||||||
if (...) == nil then
|
|
||||||
error("Missing components")
|
|
||||||
end
|
|
||||||
|
|
||||||
local compatibleArchetypes = {}
|
|
||||||
local length = 0
|
|
||||||
|
|
||||||
local components = {...}
|
|
||||||
local archetypes = world.archetypes
|
|
||||||
local queryLength = #components
|
|
||||||
|
|
||||||
local firstArchetypeMap
|
|
||||||
local componentIndex = world.componentIndex
|
|
||||||
|
|
||||||
for _, componentId in components do
|
|
||||||
local map = componentIndex[componentId]
|
|
||||||
if not map then
|
|
||||||
return EmptyQuery
|
|
||||||
end
|
|
||||||
|
|
||||||
if firstArchetypeMap == nil or map.size < firstArchetypeMap.size then
|
|
||||||
firstArchetypeMap = map
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
for id in firstArchetypeMap.cache do
|
|
||||||
local archetype = archetypes[id]
|
|
||||||
local archetypeRecords = archetype.records
|
|
||||||
|
|
||||||
local indices = {}
|
|
||||||
local skip = false
|
|
||||||
|
|
||||||
for i, componentId in components do
|
|
||||||
local index = archetypeRecords[componentId]
|
|
||||||
if not index then
|
|
||||||
skip = true
|
|
||||||
break
|
|
||||||
end
|
|
||||||
-- index should be index.offset
|
|
||||||
indices[i] = index
|
|
||||||
end
|
|
||||||
|
|
||||||
if skip then
|
|
||||||
continue
|
|
||||||
end
|
|
||||||
|
|
||||||
length += 1
|
|
||||||
compatibleArchetypes[length] = {
|
|
||||||
archetype = archetype,
|
|
||||||
indices = indices
|
|
||||||
}
|
|
||||||
end
|
|
||||||
|
|
||||||
local lastArchetype, compatibleArchetype = next(compatibleArchetypes)
|
|
||||||
if not lastArchetype then
|
|
||||||
return EmptyQuery
|
|
||||||
end
|
|
||||||
|
|
||||||
local preparedQuery = {}
|
|
||||||
preparedQuery.__index = preparedQuery
|
|
||||||
|
|
||||||
function preparedQuery:without(...)
|
|
||||||
local withoutComponents = {...}
|
|
||||||
for i = #compatibleArchetypes, 1, -1 do
|
|
||||||
local archetype = compatibleArchetypes[i].archetype
|
|
||||||
local records = archetype.records
|
|
||||||
local shouldRemove = false
|
|
||||||
|
|
||||||
for _, componentId in withoutComponents do
|
|
||||||
if records[componentId] then
|
|
||||||
shouldRemove = true
|
|
||||||
break
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
if shouldRemove then
|
|
||||||
table.remove(compatibleArchetypes, i)
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
lastArchetype, compatibleArchetype = next(compatibleArchetypes)
|
|
||||||
if not lastArchetype then
|
|
||||||
return EmptyQuery
|
|
||||||
end
|
|
||||||
|
|
||||||
return self
|
|
||||||
end
|
|
||||||
|
|
||||||
local lastRow
|
|
||||||
local queryOutput = {}
|
|
||||||
|
|
||||||
|
|
||||||
function preparedQuery:patch(fn: any)
|
|
||||||
for _, compatibleArchetype in compatibleArchetypes do
|
|
||||||
local archetype = compatibleArchetype.archetype
|
|
||||||
local tr = compatibleArchetype.indices
|
|
||||||
local columns = archetype.columns
|
|
||||||
|
|
||||||
for row in archetype.entities do
|
|
||||||
if queryLength == 1 then
|
|
||||||
local a = columns[tr[1]]
|
|
||||||
local pa = fn(a[row])
|
|
||||||
|
|
||||||
a[row] = pa
|
|
||||||
elseif queryLength == 2 then
|
|
||||||
local a = columns[tr[1]]
|
|
||||||
local b = columns[tr[2]]
|
|
||||||
|
|
||||||
a[row], b[row] = fn(a[row], b[row])
|
|
||||||
elseif queryLength == 3 then
|
|
||||||
local a = columns[tr[1]]
|
|
||||||
local b = columns[tr[2]]
|
|
||||||
local c = columns[tr[3]]
|
|
||||||
|
|
||||||
a[row], b[row], c[row] = fn(a[row], b[row], c[row])
|
|
||||||
elseif queryLength == 4 then
|
|
||||||
local a = columns[tr[1]]
|
|
||||||
local b = columns[tr[2]]
|
|
||||||
local c = columns[tr[3]]
|
|
||||||
local d = columns[tr[4]]
|
|
||||||
|
|
||||||
a[row], b[row], c[row], d[row] = fn(
|
|
||||||
a[row], b[row], c[row], d[row])
|
|
||||||
else
|
|
||||||
for i = 1, queryLength do
|
|
||||||
queryOutput[i] = columns[tr[i]][row]
|
|
||||||
end
|
|
||||||
replace(row, columns, fn(unpack(queryOutput)))
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
local function iter()
|
|
||||||
local archetype = compatibleArchetype.archetype
|
|
||||||
local row: number = next(archetype.entities, lastRow) :: number
|
|
||||||
while row == nil do
|
|
||||||
lastArchetype, compatibleArchetype = next(compatibleArchetypes, lastArchetype)
|
|
||||||
if lastArchetype == nil then
|
|
||||||
return
|
|
||||||
end
|
|
||||||
archetype = compatibleArchetype.archetype
|
|
||||||
row = next(archetype.entities, row) :: number
|
|
||||||
end
|
|
||||||
lastRow = row
|
|
||||||
|
|
||||||
local entityId = archetype.entities[row :: number]
|
|
||||||
local columns = archetype.columns
|
|
||||||
local tr = compatibleArchetype.indices
|
|
||||||
|
|
||||||
if queryLength == 1 then
|
|
||||||
return entityId, columns[tr[1]][row]
|
|
||||||
elseif queryLength == 2 then
|
|
||||||
return entityId, columns[tr[1]][row], columns[tr[2]][row]
|
|
||||||
elseif queryLength == 3 then
|
|
||||||
return entityId, columns[tr[1]][row], columns[tr[2]][row], columns[tr[3]][row]
|
|
||||||
elseif queryLength == 4 then
|
|
||||||
return entityId, columns[tr[1]][row], columns[tr[2]][row], columns[tr[3]][row], columns[tr[4]][row]
|
|
||||||
elseif queryLength == 5 then
|
|
||||||
return entityId,
|
|
||||||
columns[tr[1]][row],
|
|
||||||
columns[tr[2]][row],
|
|
||||||
columns[tr[3]][row],
|
|
||||||
columns[tr[4]][row],
|
|
||||||
columns[tr[5]][row]
|
|
||||||
elseif queryLength == 6 then
|
|
||||||
return entityId,
|
|
||||||
columns[tr[1]][row],
|
|
||||||
columns[tr[2]][row],
|
|
||||||
columns[tr[3]][row],
|
|
||||||
columns[tr[4]][row],
|
|
||||||
columns[tr[5]][row],
|
|
||||||
columns[tr[6]][row]
|
|
||||||
elseif queryLength == 7 then
|
|
||||||
return entityId,
|
|
||||||
columns[tr[1]][row],
|
|
||||||
columns[tr[2]][row],
|
|
||||||
columns[tr[3]][row],
|
|
||||||
columns[tr[4]][row],
|
|
||||||
columns[tr[5]][row],
|
|
||||||
columns[tr[6]][row],
|
|
||||||
columns[tr[7]][row]
|
|
||||||
elseif queryLength == 8 then
|
|
||||||
return entityId,
|
|
||||||
columns[tr[1]][row],
|
|
||||||
columns[tr[2]][row],
|
|
||||||
columns[tr[3]][row],
|
|
||||||
columns[tr[4]][row],
|
|
||||||
columns[tr[5]][row],
|
|
||||||
columns[tr[6]][row],
|
|
||||||
columns[tr[7]][row],
|
|
||||||
columns[tr[8]][row]
|
|
||||||
end
|
|
||||||
|
|
||||||
for i in components do
|
|
||||||
queryOutput[i] = columns[tr[i]][row]
|
|
||||||
end
|
|
||||||
|
|
||||||
return entityId, unpack(queryOutput, 1, queryLength)
|
|
||||||
end
|
|
||||||
|
|
||||||
function preparedQuery:__iter()
|
|
||||||
return iter
|
|
||||||
end
|
|
||||||
|
|
||||||
function preparedQuery:next()
|
|
||||||
return iter()
|
|
||||||
end
|
|
||||||
|
|
||||||
return setmetatable({}, preparedQuery) :: any
|
|
||||||
end
|
|
||||||
|
|
||||||
function World.__iter(world: World): () -> (number?, unknown?)
|
|
||||||
local dense = world.entityIndex.dense
|
|
||||||
local sparse = world.entityIndex.sparse
|
|
||||||
local last
|
|
||||||
|
|
||||||
return function()
|
|
||||||
local lastEntity, entityId = next(dense, last)
|
|
||||||
if not lastEntity then
|
|
||||||
return
|
|
||||||
end
|
|
||||||
last = lastEntity
|
|
||||||
|
|
||||||
local record = sparse[entityId]
|
|
||||||
local archetype = record.archetype
|
|
||||||
if not archetype then
|
|
||||||
-- Returns only the entity id as an entity without data should not return
|
|
||||||
-- data and allow the user to get an error if they don't handle the case.
|
|
||||||
return entityId
|
|
||||||
end
|
|
||||||
|
|
||||||
local row = record.row
|
|
||||||
local types = archetype.types
|
|
||||||
local columns = archetype.columns
|
|
||||||
local entityData = {}
|
|
||||||
for i, column in columns do
|
|
||||||
-- We use types because the key should be the component ID not the column index
|
|
||||||
entityData[types[i]] = column[row]
|
|
||||||
end
|
|
||||||
|
|
||||||
return entityId, entityData
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
return table.freeze({
|
|
||||||
World = World;
|
|
||||||
|
|
||||||
OnAdd = ON_ADD;
|
|
||||||
OnRemove = ON_REMOVE;
|
|
||||||
OnSet = ON_SET;
|
|
||||||
Wildcard = WILDCARD,
|
|
||||||
w = WILDCARD,
|
|
||||||
Rest = REST,
|
|
||||||
|
|
||||||
IS_PAIR = ECS_IS_PAIR,
|
|
||||||
ECS_ID = ECS_ENTITY_T_LO,
|
|
||||||
ECS_PAIR = ECS_PAIR,
|
|
||||||
ECS_GENERATION_INC = ECS_GENERATION_INC,
|
|
||||||
ECS_GENERATION = ECS_GENERATION,
|
|
||||||
ECS_PAIR_RELATION = ECS_PAIR_RELATION,
|
|
||||||
ECS_PAIR_OBJECT = ECS_PAIR_OBJECT,
|
|
||||||
|
|
||||||
pair = ECS_PAIR,
|
|
||||||
getAlive = getAlive,
|
|
||||||
})
|
|
||||||
186
mkdocs.yml
Normal file
186
mkdocs.yml
Normal file
|
|
@ -0,0 +1,186 @@
|
||||||
|
site_name: Jecs
|
||||||
|
site_url: jecs.github.io/jecs
|
||||||
|
repo_name: ukendio/jecs
|
||||||
|
repo_url: https://github.com/ukendio/jecs
|
||||||
|
|
||||||
|
extra:
|
||||||
|
version:
|
||||||
|
provider: mike
|
||||||
|
|
||||||
|
theme:
|
||||||
|
name: material
|
||||||
|
custom_dir: docs/assets/overrides
|
||||||
|
logo: assets/logo
|
||||||
|
favicon: assets/logo-dark.svg
|
||||||
|
palette:
|
||||||
|
- media: "(prefers-color-scheme: dark)"
|
||||||
|
scheme: fusiondoc-dark
|
||||||
|
toggle:
|
||||||
|
icon: octicons/sun-24
|
||||||
|
title: Switch to light theme
|
||||||
|
- media: "(prefers-color-scheme: light)"
|
||||||
|
scheme: fusiondoc-light
|
||||||
|
toggle:
|
||||||
|
icon: octicons/moon-24
|
||||||
|
title: Switch to dark theme
|
||||||
|
font:
|
||||||
|
text: Plus Jakarta Sans
|
||||||
|
code: JetBrains Mono
|
||||||
|
features:
|
||||||
|
- navigation.tabs
|
||||||
|
- navigation.top
|
||||||
|
- navigation.sections
|
||||||
|
- navigation.instant
|
||||||
|
- navigation.indexes
|
||||||
|
- search.suggest
|
||||||
|
- search.highlight
|
||||||
|
icon:
|
||||||
|
repo: octicons/mark-github-16
|
||||||
|
|
||||||
|
extra_css:
|
||||||
|
- assets/theme/fusiondoc.css
|
||||||
|
- assets/theme/colours.css
|
||||||
|
- assets/theme/code.css
|
||||||
|
- assets/theme/paragraph.css
|
||||||
|
- assets/theme/page.css
|
||||||
|
- assets/theme/admonition.css
|
||||||
|
- assets/theme/404.css
|
||||||
|
- assets/theme/api-reference.css
|
||||||
|
- assets/theme/dev-tools.css
|
||||||
|
|
||||||
|
extra_javascript:
|
||||||
|
- assets/scripts/smooth-scroll.js
|
||||||
|
|
||||||
|
nav:
|
||||||
|
- Home: index.md
|
||||||
|
- Tutorials:
|
||||||
|
- Get Started: tutorials/index.md
|
||||||
|
- Installing Fusion: tutorials/get-started/installing-fusion.md
|
||||||
|
- Developer Tools: tutorials/get-started/developer-tools.md
|
||||||
|
- Getting Help: tutorials/get-started/getting-help.md
|
||||||
|
- Fundamentals:
|
||||||
|
- Scopes: tutorials/fundamentals/scopes.md
|
||||||
|
- Values: tutorials/fundamentals/values.md
|
||||||
|
- Observers: tutorials/fundamentals/observers.md
|
||||||
|
- Computeds: tutorials/fundamentals/computeds.md
|
||||||
|
- Tables:
|
||||||
|
- ForValues: tutorials/tables/forvalues.md
|
||||||
|
- ForKeys: tutorials/tables/forkeys.md
|
||||||
|
- ForPairs: tutorials/tables/forpairs.md
|
||||||
|
- Animation:
|
||||||
|
- Tweens: tutorials/animation/tweens.md
|
||||||
|
- Springs: tutorials/animation/springs.md
|
||||||
|
- Roblox:
|
||||||
|
- Hydration: tutorials/roblox/hydration.md
|
||||||
|
- New Instances: tutorials/roblox/new-instances.md
|
||||||
|
- Parenting: tutorials/roblox/parenting.md
|
||||||
|
- Events: tutorials/roblox/events.md
|
||||||
|
- Change Events: tutorials/roblox/change-events.md
|
||||||
|
- Outputs: tutorials/roblox/outputs.md
|
||||||
|
- References: tutorials/roblox/references.md
|
||||||
|
- Best Practices:
|
||||||
|
- Components: tutorials/best-practices/components.md
|
||||||
|
- Instance Handling: tutorials/best-practices/instance-handling.md
|
||||||
|
- Callbacks: tutorials/best-practices/callbacks.md
|
||||||
|
- State: tutorials/best-practices/state.md
|
||||||
|
- Sharing Values: tutorials/best-practices/sharing-values.md
|
||||||
|
- Error Safety: tutorials/best-practices/error-safety.md
|
||||||
|
- Optimisation: tutorials/best-practices/optimisation.md
|
||||||
|
|
||||||
|
- Examples:
|
||||||
|
- Home: examples/index.md
|
||||||
|
- Cookbook:
|
||||||
|
- examples/cookbook/index.md
|
||||||
|
- Player List: examples/cookbook/player-list.md
|
||||||
|
- Animated Computed: examples/cookbook/animated-computed.md
|
||||||
|
- Fetch Data From Server: examples/cookbook/fetch-data-from-server.md
|
||||||
|
- Light & Dark Theme: examples/cookbook/light-and-dark-theme.md
|
||||||
|
- Button Component: examples/cookbook/button-component.md
|
||||||
|
- Loading Spinner: examples/cookbook/loading-spinner.md
|
||||||
|
- Drag & Drop: examples/cookbook/drag-and-drop.md
|
||||||
|
- API Reference:
|
||||||
|
- api-reference/index.md
|
||||||
|
- General:
|
||||||
|
- Errors: api-reference/general/errors.md
|
||||||
|
- Types:
|
||||||
|
- Contextual: api-reference/general/types/contextual.md
|
||||||
|
- Version: api-reference/general/types/version.md
|
||||||
|
- Members:
|
||||||
|
- Contextual: api-reference/general/members/contextual.md
|
||||||
|
- Safe: api-reference/general/members/safe.md
|
||||||
|
- version: api-reference/general/members/version.md
|
||||||
|
- Memory:
|
||||||
|
- Types:
|
||||||
|
- Scope: api-reference/memory/types/scope.md
|
||||||
|
- ScopedObject: api-reference/memory/types/scopedobject.md
|
||||||
|
- Task: api-reference/memory/types/task.md
|
||||||
|
- Members:
|
||||||
|
- deriveScope: api-reference/memory/members/derivescope.md
|
||||||
|
- doCleanup: api-reference/memory/members/docleanup.md
|
||||||
|
- scoped: api-reference/memory/members/scoped.md
|
||||||
|
- State:
|
||||||
|
- Types:
|
||||||
|
- UsedAs: api-reference/state/types/usedas.md
|
||||||
|
- Computed: api-reference/state/types/computed.md
|
||||||
|
- Dependency: api-reference/state/types/dependency.md
|
||||||
|
- Dependent: api-reference/state/types/dependent.md
|
||||||
|
- For: api-reference/state/types/for.md
|
||||||
|
- Observer: api-reference/state/types/observer.md
|
||||||
|
- StateObject: api-reference/state/types/stateobject.md
|
||||||
|
- Use: api-reference/state/types/use.md
|
||||||
|
- Value: api-reference/state/types/value.md
|
||||||
|
- Members:
|
||||||
|
- Computed: api-reference/state/members/computed.md
|
||||||
|
- ForKeys: api-reference/state/members/forkeys.md
|
||||||
|
- ForPairs: api-reference/state/members/forpairs.md
|
||||||
|
- ForValues: api-reference/state/members/forvalues.md
|
||||||
|
- Observer: api-reference/state/members/observer.md
|
||||||
|
- peek: api-reference/state/members/peek.md
|
||||||
|
- Value: api-reference/state/members/value.md
|
||||||
|
- Roblox:
|
||||||
|
- Types:
|
||||||
|
- Child: api-reference/roblox/types/child.md
|
||||||
|
- PropertyTable: api-reference/roblox/types/propertytable.md
|
||||||
|
- SpecialKey: api-reference/roblox/types/specialkey.md
|
||||||
|
- Members:
|
||||||
|
- Attribute: api-reference/roblox/members/attribute.md
|
||||||
|
- AttributeChange: api-reference/roblox/members/attributechange.md
|
||||||
|
- AttributeOut: api-reference/roblox/members/attributeout.md
|
||||||
|
- Children: api-reference/roblox/members/children.md
|
||||||
|
- Hydrate: api-reference/roblox/members/hydrate.md
|
||||||
|
- New: api-reference/roblox/members/new.md
|
||||||
|
- OnChange: api-reference/roblox/members/onchange.md
|
||||||
|
- OnEvent: api-reference/roblox/members/onevent.md
|
||||||
|
- Out: api-reference/roblox/members/out.md
|
||||||
|
- Ref: api-reference/roblox/members/ref.md
|
||||||
|
- Animation:
|
||||||
|
- Types:
|
||||||
|
- Animatable: api-reference/animation/types/animatable.md
|
||||||
|
- Spring: api-reference/animation/types/spring.md
|
||||||
|
- Tween: api-reference/animation/types/tween.md
|
||||||
|
- Members:
|
||||||
|
- Tween: api-reference/animation/members/tween.md
|
||||||
|
- Spring: api-reference/animation/members/spring.md
|
||||||
|
- Extras:
|
||||||
|
- Home: extras/index.md
|
||||||
|
- Backgrounds: extras/backgrounds.md
|
||||||
|
- Brand Guidelines: extras/brand-guidelines.md
|
||||||
|
|
||||||
|
markdown_extensions:
|
||||||
|
- admonition
|
||||||
|
- attr_list
|
||||||
|
- meta
|
||||||
|
- md_in_html
|
||||||
|
- pymdownx.superfences
|
||||||
|
- pymdownx.betterem
|
||||||
|
- pymdownx.details
|
||||||
|
- pymdownx.tabbed:
|
||||||
|
alternate_style: true
|
||||||
|
- pymdownx.inlinehilite
|
||||||
|
- toc:
|
||||||
|
permalink: true
|
||||||
|
- pymdownx.highlight:
|
||||||
|
guess_lang: false
|
||||||
|
- pymdownx.emoji:
|
||||||
|
emoji_index: !!python/name:materialx.emoji.twemoji
|
||||||
|
emoji_generator: !!python/name:materialx.emoji.to_svg
|
||||||
2199
package-lock.json
generated
Normal file
2199
package-lock.json
generated
Normal file
File diff suppressed because it is too large
Load diff
43
package.json
Normal file
43
package.json
Normal file
|
|
@ -0,0 +1,43 @@
|
||||||
|
{
|
||||||
|
"name": "@rbxts/jecs",
|
||||||
|
"version": "0.1.0",
|
||||||
|
"description": "Stupidly fast Entity Component System",
|
||||||
|
"main": "lib/init.lua",
|
||||||
|
"repository": {
|
||||||
|
"type": "git",
|
||||||
|
"url": "https://github.com/ukendio/jecs.git"
|
||||||
|
},
|
||||||
|
"scripts": {
|
||||||
|
"build": "rbxtsc",
|
||||||
|
"watch": "rbxtsc -w",
|
||||||
|
"prepublishOnly": "npm run build"
|
||||||
|
},
|
||||||
|
"keywords": [],
|
||||||
|
"author": "Ukendio",
|
||||||
|
"contributors": [
|
||||||
|
"Ukendio",
|
||||||
|
"EncodedVenom"
|
||||||
|
],
|
||||||
|
"homepage": "https://github.com/ukendio/jecs",
|
||||||
|
"license": "MIT",
|
||||||
|
"types": "lib/index.d.ts",
|
||||||
|
"files": [
|
||||||
|
"lib/"
|
||||||
|
],
|
||||||
|
"publishConfig": {
|
||||||
|
"access": "public"
|
||||||
|
},
|
||||||
|
"devDependencies": {
|
||||||
|
"@rbxts/compiler-types": "^2.3.0-types.1",
|
||||||
|
"@rbxts/types": "^1.0.781",
|
||||||
|
"@typescript-eslint/eslint-plugin": "^5.8.0",
|
||||||
|
"@typescript-eslint/parser": "^5.8.0",
|
||||||
|
"eslint": "^8.5.0",
|
||||||
|
"eslint-config-prettier": "^8.3.0",
|
||||||
|
"eslint-plugin-prettier": "^4.0.0",
|
||||||
|
"eslint-plugin-roblox-ts": "^0.0.32",
|
||||||
|
"prettier": "^2.5.1",
|
||||||
|
"roblox-ts": "^2.3.0",
|
||||||
|
"typescript": "^5.4.2"
|
||||||
|
}
|
||||||
|
}
|
||||||
153
src/index.d.ts
vendored
Normal file
153
src/index.d.ts
vendored
Normal file
|
|
@ -0,0 +1,153 @@
|
||||||
|
type Query<T extends unknown[]> = {
|
||||||
|
without: (...components: Entity[]) => Query<T>;
|
||||||
|
} & IterableFunction<LuaTuple<[Entity, ...T]>>;
|
||||||
|
|
||||||
|
// Utility Types
|
||||||
|
export type Entity<T = unknown> = number & { __nominal_type_dont_use: T };
|
||||||
|
export type EntityType<T> = T extends Entity<infer A> ? A : never;
|
||||||
|
export type InferComponents<A extends Entity[]> = {
|
||||||
|
[K in keyof A]: EntityType<A[K]>;
|
||||||
|
};
|
||||||
|
type Nullable<T extends unknown[]> = {
|
||||||
|
[K in keyof T]: T[K] | undefined;
|
||||||
|
};
|
||||||
|
|
||||||
|
export class World {
|
||||||
|
/**
|
||||||
|
* Creates a new World
|
||||||
|
*/
|
||||||
|
constructor();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Creates a new entity
|
||||||
|
* @returns Entity
|
||||||
|
*/
|
||||||
|
entity(): Entity;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Creates a new entity located in the first 256 ids.
|
||||||
|
* These should be used for static components for fast access.
|
||||||
|
* @returns Entity<T>
|
||||||
|
*/
|
||||||
|
component<T = unknown>(): Entity<T>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Gets the target of a relationship. For example, when a user calls
|
||||||
|
* `world.target(id, ChildOf(parent))`, you will obtain the parent entity.
|
||||||
|
* @param id Entity
|
||||||
|
* @param relation The Relationship
|
||||||
|
* @returns The Parent Entity if it exists
|
||||||
|
*/
|
||||||
|
target(id: Entity, relation: Entity): Entity | undefined;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Deletes an entity and all its related components and relationships.
|
||||||
|
* @param id Entity to be destroyed
|
||||||
|
*/
|
||||||
|
delete(id: Entity): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Adds a component to the entity with no value
|
||||||
|
* @param id Target Entity
|
||||||
|
* @param component Component
|
||||||
|
*/
|
||||||
|
add<T>(id: Entity, component: Entity<T>): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Assigns a value to a component on the given entity
|
||||||
|
* @param id Target Entity
|
||||||
|
* @param component Target Component
|
||||||
|
* @param data Component Data
|
||||||
|
*/
|
||||||
|
set<T>(id: Entity, component: Entity<T>, data: T): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Removes a component from the given entity
|
||||||
|
* @param id Target Entity
|
||||||
|
* @param component Target Component
|
||||||
|
*/
|
||||||
|
remove(id: Entity, component: Entity): void;
|
||||||
|
|
||||||
|
// Manually typed out get since there is a hard limit.
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieves the value of one component. This value may be undefined.
|
||||||
|
* @param id Target Entity
|
||||||
|
* @param component Target Component
|
||||||
|
* @returns Data associated with the component if it exists
|
||||||
|
*/
|
||||||
|
get<A>(id: number, component: Entity<A>): A | undefined;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieves the value of two components. This value may be undefined.
|
||||||
|
* @param id Target Entity
|
||||||
|
* @param component Target Component 1
|
||||||
|
* @param component2 Target Component 2
|
||||||
|
* @returns Data associated with the components if it exists
|
||||||
|
*/
|
||||||
|
get<A, B>(
|
||||||
|
id: number,
|
||||||
|
component: Entity<A>,
|
||||||
|
component2: Entity<B>
|
||||||
|
): LuaTuple<Nullable<[A, B]>>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieves the value of three components. This value may be undefined.
|
||||||
|
* @param id Target Entity
|
||||||
|
* @param component Target Component 1
|
||||||
|
* @param component2 Target Component 2
|
||||||
|
* @param component3 Target Component 3
|
||||||
|
* @returns Data associated with the components if it exists
|
||||||
|
*/
|
||||||
|
get<A, B, C>(
|
||||||
|
id: number,
|
||||||
|
component: Entity<A>,
|
||||||
|
component2: Entity<B>,
|
||||||
|
component3: Entity<C>
|
||||||
|
): LuaTuple<Nullable<[A, B, C]>>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieves the value of four components. This value may be undefined.
|
||||||
|
* @param id Target Entity
|
||||||
|
* @param component Target Component 1
|
||||||
|
* @param component2 Target Component 2
|
||||||
|
* @param component3 Target Component 3
|
||||||
|
* @param component4 Target Component 4
|
||||||
|
* @returns Data associated with the components if it exists
|
||||||
|
*/
|
||||||
|
get<A, B, C, D>(
|
||||||
|
id: number,
|
||||||
|
component: Entity<A>,
|
||||||
|
component2: Entity<B>,
|
||||||
|
component3: Entity<C>,
|
||||||
|
component4: Entity<D>
|
||||||
|
): LuaTuple<Nullable<[A, B, C, D]>>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Searches the world for entities that match a given query
|
||||||
|
* @param components Queried Components
|
||||||
|
* @returns Iterable function
|
||||||
|
*/
|
||||||
|
query<T extends Entity[]>(...components: T): Query<InferComponents<T>>;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Creates a composite key.
|
||||||
|
* @param pred The first entity
|
||||||
|
* @param obj The second entity
|
||||||
|
* @returns The composite key
|
||||||
|
*/
|
||||||
|
export const pair: (pred: Entity, obj: Entity) => Entity;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Checks if the entity is a composite key
|
||||||
|
* @param e The entity to check
|
||||||
|
* @returns If the entity is a pair
|
||||||
|
*/
|
||||||
|
export const IS_PAIR: (e: Entity) => boolean;
|
||||||
|
|
||||||
|
export const OnAdd: Entity;
|
||||||
|
export const OnRemove: Entity;
|
||||||
|
export const OnSet: Entity;
|
||||||
|
export const Wildcard: Entity;
|
||||||
|
export const Rest: Entity;
|
||||||
1053
src/init.luau
Normal file
1053
src/init.luau
Normal file
File diff suppressed because it is too large
Load diff
339
tests/world.lua
339
tests/world.lua
|
|
@ -1,339 +0,0 @@
|
||||||
local testkit = require("../testkit")
|
|
||||||
local jecs = require("../lib/init")
|
|
||||||
local __ = jecs.Wildcard
|
|
||||||
local ECS_ID, ECS_GENERATION = jecs.ECS_ID, jecs.ECS_GENERATION
|
|
||||||
local ECS_GENERATION_INC = jecs.ECS_GENERATION_INC
|
|
||||||
local IS_PAIR = jecs.IS_PAIR
|
|
||||||
local ECS_PAIR = jecs.ECS_PAIR
|
|
||||||
local getAlive = jecs.getAlive
|
|
||||||
local ECS_PAIR_RELATION = jecs.ECS_PAIR_RELATION
|
|
||||||
local ECS_PAIR_OBJECT = jecs.ECS_PAIR_OBJECT
|
|
||||||
|
|
||||||
local TEST, CASE, CHECK, FINISH, SKIP = testkit.test()
|
|
||||||
local function CHECK_NO_ERR<T...>(s: string, fn: (T...) -> (), ...: T...)
|
|
||||||
local ok, err: string? = pcall(fn, ...)
|
|
||||||
|
|
||||||
if not CHECK(not ok, 2) then
|
|
||||||
local i = string.find(err :: string, " ")
|
|
||||||
assert(i)
|
|
||||||
local msg = string.sub(err :: string, i+1)
|
|
||||||
CHECK(msg == s, 2)
|
|
||||||
end
|
|
||||||
end
|
|
||||||
local N = 10
|
|
||||||
|
|
||||||
TEST("world", function()
|
|
||||||
do CASE "should be iterable"
|
|
||||||
local world = jecs.World.new()
|
|
||||||
local A = world:component()
|
|
||||||
local B = world:component()
|
|
||||||
local eA = world:entity()
|
|
||||||
world:set(eA, A, true)
|
|
||||||
local eB = world:entity()
|
|
||||||
world:set(eB, B, true)
|
|
||||||
local eAB = world:entity()
|
|
||||||
world:set(eAB, A, true)
|
|
||||||
world:set(eAB, B, true)
|
|
||||||
|
|
||||||
local count = 0
|
|
||||||
for id, data in world do
|
|
||||||
count += 1
|
|
||||||
if id == eA then
|
|
||||||
CHECK(data[A] == true)
|
|
||||||
CHECK(data[B] == nil)
|
|
||||||
elseif id == eB then
|
|
||||||
CHECK(data[A] == nil)
|
|
||||||
CHECK(data[B] == true)
|
|
||||||
elseif id == eAB then
|
|
||||||
CHECK(data[A] == true)
|
|
||||||
CHECK(data[B] == true)
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
-- components are registered in the entity index as well
|
|
||||||
-- so this test has to add 2 to account for them
|
|
||||||
CHECK(count == 3 + 2)
|
|
||||||
end
|
|
||||||
|
|
||||||
do CASE "should query all matching entities"
|
|
||||||
local world = jecs.World.new()
|
|
||||||
local A = world:component()
|
|
||||||
local B = world:component()
|
|
||||||
|
|
||||||
local entities = {}
|
|
||||||
for i = 1, N do
|
|
||||||
local id = world:entity()
|
|
||||||
|
|
||||||
world:set(id, A, true)
|
|
||||||
if i > 5 then world:set(id, B, true) end
|
|
||||||
entities[i] = id
|
|
||||||
end
|
|
||||||
|
|
||||||
for id in world:query(A) do
|
|
||||||
table.remove(entities, CHECK(table.find(entities, id)))
|
|
||||||
end
|
|
||||||
|
|
||||||
CHECK(#entities == 0)
|
|
||||||
|
|
||||||
end
|
|
||||||
|
|
||||||
do CASE "should query all matching entities when irrelevant component is removed"
|
|
||||||
local world = jecs.World.new()
|
|
||||||
local A = world:component()
|
|
||||||
local B = world:component()
|
|
||||||
local C = world:component()
|
|
||||||
|
|
||||||
local entities = {}
|
|
||||||
for i = 1, N do
|
|
||||||
local id = world:entity()
|
|
||||||
|
|
||||||
-- specifically put them in disorder to track regression
|
|
||||||
-- https://github.com/Ukendio/jecs/pull/15
|
|
||||||
world:set(id, B, true)
|
|
||||||
world:set(id, A, true)
|
|
||||||
if i > 5 then world:remove(id, B) end
|
|
||||||
entities[i] = id
|
|
||||||
end
|
|
||||||
|
|
||||||
local added = 0
|
|
||||||
for id in world:query(A) do
|
|
||||||
added += 1
|
|
||||||
table.remove(entities, CHECK(table.find(entities, id)))
|
|
||||||
end
|
|
||||||
|
|
||||||
CHECK(added == N)
|
|
||||||
end
|
|
||||||
|
|
||||||
do CASE "should query all entities without B"
|
|
||||||
local world = jecs.World.new()
|
|
||||||
local A = world:component()
|
|
||||||
local B = world:component()
|
|
||||||
|
|
||||||
local entities = {}
|
|
||||||
for i = 1, N do
|
|
||||||
local id = world:entity()
|
|
||||||
|
|
||||||
world:set(id, A, true)
|
|
||||||
if i < 5 then
|
|
||||||
entities[i] = id
|
|
||||||
else
|
|
||||||
world:set(id, B, true)
|
|
||||||
end
|
|
||||||
|
|
||||||
end
|
|
||||||
|
|
||||||
for id in world:query(A):without(B) do
|
|
||||||
table.remove(entities, CHECK(table.find(entities, id)))
|
|
||||||
end
|
|
||||||
|
|
||||||
CHECK(#entities == 0)
|
|
||||||
|
|
||||||
end
|
|
||||||
|
|
||||||
do CASE "should allow setting components in arbitrary order"
|
|
||||||
local world = jecs.World.new()
|
|
||||||
|
|
||||||
local Health = world:entity()
|
|
||||||
local Poison = world:component()
|
|
||||||
|
|
||||||
local id = world:entity()
|
|
||||||
world:set(id, Poison, 5)
|
|
||||||
world:set(id, Health, 50)
|
|
||||||
|
|
||||||
CHECK(world:get(id, Poison) == 5)
|
|
||||||
end
|
|
||||||
|
|
||||||
do CASE "should allow deleting components"
|
|
||||||
local world = jecs.World.new()
|
|
||||||
|
|
||||||
local Health = world:entity()
|
|
||||||
local Poison = world:component()
|
|
||||||
|
|
||||||
local id = world:entity()
|
|
||||||
world:set(id, Poison, 5)
|
|
||||||
world:set(id, Health, 50)
|
|
||||||
local id1 = world:entity()
|
|
||||||
world:set(id1, Poison, 500)
|
|
||||||
world:set(id1, Health, 50)
|
|
||||||
|
|
||||||
world:delete(id)
|
|
||||||
|
|
||||||
CHECK(world:get(id, Poison) == nil)
|
|
||||||
CHECK(world:get(id, Health) == nil)
|
|
||||||
CHECK(world:get(id1, Poison) == 500)
|
|
||||||
CHECK(world:get(id1, Health) == 50)
|
|
||||||
|
|
||||||
end
|
|
||||||
|
|
||||||
do CASE "should allow remove that doesn't exist on entity"
|
|
||||||
local world = jecs.World.new()
|
|
||||||
|
|
||||||
local Health = world:entity()
|
|
||||||
local Poison = world:component()
|
|
||||||
|
|
||||||
local id = world:entity()
|
|
||||||
world:set(id, Health, 50)
|
|
||||||
world:remove(id, Poison)
|
|
||||||
|
|
||||||
CHECK(world:get(id, Poison) == nil)
|
|
||||||
CHECK(world:get(id, Health) == 50)
|
|
||||||
end
|
|
||||||
|
|
||||||
do CASE "should increment generation"
|
|
||||||
local world = jecs.World.new()
|
|
||||||
local e = world:entity()
|
|
||||||
CHECK(ECS_ID(e) == 1 + jecs.Rest)
|
|
||||||
CHECK(getAlive(world.entityIndex, ECS_ID(e)) == e)
|
|
||||||
CHECK(ECS_GENERATION(e) == 0) -- 0
|
|
||||||
e = ECS_GENERATION_INC(e)
|
|
||||||
CHECK(ECS_GENERATION(e) == 1) -- 1
|
|
||||||
end
|
|
||||||
|
|
||||||
do CASE "should get alive from index in the dense array"
|
|
||||||
local world = jecs.World.new()
|
|
||||||
local _e = world:entity()
|
|
||||||
local e2 = world:entity()
|
|
||||||
local e3 = world:entity()
|
|
||||||
|
|
||||||
CHECK(IS_PAIR(world:entity()) == false)
|
|
||||||
|
|
||||||
local pair = ECS_PAIR(e2, e3)
|
|
||||||
CHECK(IS_PAIR(pair) == true)
|
|
||||||
CHECK(ECS_PAIR_RELATION(world.entityIndex, pair) == e2)
|
|
||||||
CHECK(ECS_PAIR_OBJECT(world.entityIndex, pair) == e3)
|
|
||||||
end
|
|
||||||
|
|
||||||
do CASE "should allow querying for relations"
|
|
||||||
local world = jecs.World.new()
|
|
||||||
local Eats = world:entity()
|
|
||||||
local Apples = world:entity()
|
|
||||||
local bob = world:entity()
|
|
||||||
|
|
||||||
world:set(bob, ECS_PAIR(Eats, Apples), true)
|
|
||||||
for e, bool in world:query(ECS_PAIR(Eats, Apples)) do
|
|
||||||
CHECK(e == bob)
|
|
||||||
CHECK(bool)
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
do CASE "should allow wildcards in queries"
|
|
||||||
local world = jecs.World.new()
|
|
||||||
local Eats = world:entity()
|
|
||||||
local Apples = world:entity()
|
|
||||||
local bob = world:entity()
|
|
||||||
|
|
||||||
world:set(bob, ECS_PAIR(Eats, Apples), "bob eats apples")
|
|
||||||
|
|
||||||
local w = jecs.Wildcard
|
|
||||||
for e, data in world:query(ECS_PAIR(Eats, w)) do
|
|
||||||
CHECK(e == bob)
|
|
||||||
CHECK(data == "bob eats apples")
|
|
||||||
end
|
|
||||||
for e, data in world:query(ECS_PAIR(w, Apples)) do
|
|
||||||
CHECK(e == bob)
|
|
||||||
CHECK(data == "bob eats apples")
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
do CASE "should match against multiple pairs"
|
|
||||||
local world = jecs.World.new()
|
|
||||||
local Eats = world:entity()
|
|
||||||
local Apples = world:entity()
|
|
||||||
local Oranges =world:entity()
|
|
||||||
local bob = world:entity()
|
|
||||||
local alice = world:entity()
|
|
||||||
|
|
||||||
world:set(bob, ECS_PAIR(Eats, Apples), "bob eats apples")
|
|
||||||
world:set(alice, ECS_PAIR(Eats, Oranges), "alice eats oranges")
|
|
||||||
|
|
||||||
local w = jecs.Wildcard
|
|
||||||
local count = 0
|
|
||||||
for e, data in world:query(ECS_PAIR(Eats, w)) do
|
|
||||||
count += 1
|
|
||||||
if e == bob then
|
|
||||||
CHECK(data == "bob eats apples")
|
|
||||||
else
|
|
||||||
CHECK(data == "alice eats oranges")
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
CHECK(count == 2)
|
|
||||||
count = 0
|
|
||||||
|
|
||||||
for e, data in world:query(ECS_PAIR(w, Apples)) do
|
|
||||||
count += 1
|
|
||||||
CHECK(data == "bob eats apples")
|
|
||||||
end
|
|
||||||
CHECK(count == 1)
|
|
||||||
end
|
|
||||||
|
|
||||||
do CASE "should only relate alive entities"
|
|
||||||
|
|
||||||
local world = jecs.World.new()
|
|
||||||
local Eats = world:entity()
|
|
||||||
local Apples = world:entity()
|
|
||||||
local Oranges = world:entity()
|
|
||||||
local bob = world:entity()
|
|
||||||
local alice = world:entity()
|
|
||||||
|
|
||||||
world:set(bob, Apples, "apples")
|
|
||||||
world:set(bob, ECS_PAIR(Eats, Apples), "bob eats apples")
|
|
||||||
world:set(alice, ECS_PAIR(Eats, Oranges), "alice eats oranges")
|
|
||||||
|
|
||||||
world:delete(Apples)
|
|
||||||
local Wildcard = jecs.Wildcard
|
|
||||||
|
|
||||||
local count = 0
|
|
||||||
for _, data in world:query(ECS_PAIR(Wildcard, Apples)) do
|
|
||||||
count += 1
|
|
||||||
end
|
|
||||||
|
|
||||||
world:delete(ECS_PAIR(Eats, Apples))
|
|
||||||
|
|
||||||
CHECK(count == 0)
|
|
||||||
CHECK(world:get(bob, ECS_PAIR(Eats, Apples)) == nil)
|
|
||||||
end
|
|
||||||
|
|
||||||
do CASE "should error when setting invalid pair"
|
|
||||||
local world = jecs.World.new()
|
|
||||||
local Eats = world:entity()
|
|
||||||
local Apples = world:entity()
|
|
||||||
local bob = world:entity()
|
|
||||||
|
|
||||||
world:delete(Apples)
|
|
||||||
|
|
||||||
CHECK_NO_ERR("Apples should be dead", function()
|
|
||||||
world:set(bob, ECS_PAIR(Eats, Apples), "bob eats apples")
|
|
||||||
end)
|
|
||||||
end
|
|
||||||
|
|
||||||
do CASE "should find target for ChildOf"
|
|
||||||
local world = jecs.World.new()
|
|
||||||
|
|
||||||
local ChildOf = world:component()
|
|
||||||
local Name = world:component()
|
|
||||||
|
|
||||||
local function parent(entity)
|
|
||||||
return world:target(entity, ChildOf)
|
|
||||||
end
|
|
||||||
|
|
||||||
local bob = world:entity()
|
|
||||||
local alice = world:entity()
|
|
||||||
local sara = world:entity()
|
|
||||||
|
|
||||||
world:add(bob, ECS_PAIR(ChildOf, alice))
|
|
||||||
world:set(bob, Name, "bob")
|
|
||||||
world:add(sara, ECS_PAIR(ChildOf, alice))
|
|
||||||
world:set(sara, Name, "sara")
|
|
||||||
CHECK(parent(bob) == alice) -- O(1)
|
|
||||||
|
|
||||||
local count = 0
|
|
||||||
for _, name in world:query(Name, ECS_PAIR(ChildOf, alice)) do
|
|
||||||
print(name)
|
|
||||||
count += 1
|
|
||||||
end
|
|
||||||
CHECK(count == 2)
|
|
||||||
end
|
|
||||||
end)
|
|
||||||
|
|
||||||
FINISH()
|
|
||||||
457
tests/world.luau
Normal file
457
tests/world.luau
Normal file
|
|
@ -0,0 +1,457 @@
|
||||||
|
local jecs = require("../lib/init")
|
||||||
|
local testkit = require("../testkit")
|
||||||
|
local __ = jecs.Wildcard
|
||||||
|
local ECS_ID, ECS_GENERATION = jecs.ECS_ID, jecs.ECS_GENERATION
|
||||||
|
local ECS_GENERATION_INC = jecs.ECS_GENERATION_INC
|
||||||
|
local IS_PAIR = jecs.IS_PAIR
|
||||||
|
local ECS_PAIR = jecs.ECS_PAIR
|
||||||
|
local getAlive = jecs.getAlive
|
||||||
|
local ECS_PAIR_RELATION = jecs.ECS_PAIR_RELATION
|
||||||
|
local ECS_PAIR_OBJECT = jecs.ECS_PAIR_OBJECT
|
||||||
|
|
||||||
|
local TEST, CASE, CHECK, FINISH, SKIP = testkit.test()
|
||||||
|
local function CHECK_NO_ERR<T...>(s: string, fn: (T...) -> (), ...: T...)
|
||||||
|
local ok, err: string? = pcall(fn, ...)
|
||||||
|
|
||||||
|
if not CHECK(not ok, 2) then
|
||||||
|
local i = string.find(err :: string, " ")
|
||||||
|
assert(i)
|
||||||
|
local msg = string.sub(err :: string, i + 1)
|
||||||
|
CHECK(msg == s, 2)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
local N = 10
|
||||||
|
|
||||||
|
type World = jecs.WorldShim
|
||||||
|
|
||||||
|
TEST("world", function()
|
||||||
|
do CASE("should find every component id")
|
||||||
|
local world = jecs.World.new() :: World
|
||||||
|
local A = world:component()
|
||||||
|
local B = world:component()
|
||||||
|
world:entity()
|
||||||
|
world:entity()
|
||||||
|
world:entity()
|
||||||
|
|
||||||
|
local count = 0
|
||||||
|
for componentId in world:query(jecs.Component) do
|
||||||
|
if componentId ~= A and componentId ~= B then
|
||||||
|
error("found entity")
|
||||||
|
end
|
||||||
|
count += 1
|
||||||
|
end
|
||||||
|
|
||||||
|
CHECK(count == 2)
|
||||||
|
end
|
||||||
|
|
||||||
|
do CASE("should remove its components")
|
||||||
|
local world = jecs.World.new() :: World
|
||||||
|
local A = world:component()
|
||||||
|
local B = world:component()
|
||||||
|
|
||||||
|
local e = world:entity()
|
||||||
|
|
||||||
|
world:set(e, A, true)
|
||||||
|
world:set(e, B, true)
|
||||||
|
|
||||||
|
CHECK(world:get(e, A))
|
||||||
|
CHECK(world:get(e, B))
|
||||||
|
|
||||||
|
world:clear(e)
|
||||||
|
CHECK(world:get(e, A) == nil)
|
||||||
|
CHECK(world:get(e, B) == nil)
|
||||||
|
|
||||||
|
end
|
||||||
|
|
||||||
|
do CASE("iterator should not drain the query")
|
||||||
|
local world = jecs.World.new() :: World
|
||||||
|
local A = world:component()
|
||||||
|
local B = world:component()
|
||||||
|
local eA = world:entity()
|
||||||
|
world:set(eA, A, true)
|
||||||
|
local eB = world:entity()
|
||||||
|
world:set(eB, B, true)
|
||||||
|
local eAB = world:entity()
|
||||||
|
world:set(eAB, A, true)
|
||||||
|
world:set(eAB, B, true)
|
||||||
|
|
||||||
|
local q = world:query(A)
|
||||||
|
|
||||||
|
local i = 0
|
||||||
|
local j = 0
|
||||||
|
for _ in q do
|
||||||
|
i+=1
|
||||||
|
end
|
||||||
|
for _ in q do
|
||||||
|
j+=1
|
||||||
|
end
|
||||||
|
CHECK(i == j)
|
||||||
|
end
|
||||||
|
|
||||||
|
do CASE("should be able to get next results")
|
||||||
|
local world = jecs.World.new() :: World
|
||||||
|
world:component()
|
||||||
|
local A = world:component()
|
||||||
|
local B = world:component()
|
||||||
|
local eA = world:entity()
|
||||||
|
world:set(eA, A, true)
|
||||||
|
local eB = world:entity()
|
||||||
|
world:set(eB, B, true)
|
||||||
|
local eAB = world:entity()
|
||||||
|
world:set(eAB, A, true)
|
||||||
|
world:set(eAB, B, true)
|
||||||
|
|
||||||
|
local q = world:query(A)
|
||||||
|
|
||||||
|
local e, data = q:next()
|
||||||
|
while e do
|
||||||
|
CHECK(
|
||||||
|
if e == eA then data == true
|
||||||
|
elseif e == eAB then data == true
|
||||||
|
else false
|
||||||
|
)
|
||||||
|
e, data = q:next()
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
do CASE("should query all matching entities")
|
||||||
|
local world = jecs.World.new()
|
||||||
|
local A = world:component()
|
||||||
|
local B = world:component()
|
||||||
|
|
||||||
|
local entities = {}
|
||||||
|
for i = 1, N do
|
||||||
|
local id = world:entity()
|
||||||
|
|
||||||
|
world:set(id, A, true)
|
||||||
|
if i > 5 then
|
||||||
|
world:set(id, B, true)
|
||||||
|
end
|
||||||
|
entities[i] = id
|
||||||
|
end
|
||||||
|
|
||||||
|
for id in world:query(A) do
|
||||||
|
table.remove(entities, CHECK(table.find(entities, id)))
|
||||||
|
end
|
||||||
|
|
||||||
|
CHECK(#entities == 0)
|
||||||
|
end
|
||||||
|
|
||||||
|
do CASE("should query all matching entities when irrelevant component is removed")
|
||||||
|
local world = jecs.World.new()
|
||||||
|
local A = world:component()
|
||||||
|
local B = world:component()
|
||||||
|
local C = world:component()
|
||||||
|
|
||||||
|
local entities = {}
|
||||||
|
for i = 1, N do
|
||||||
|
local id = world:entity()
|
||||||
|
|
||||||
|
-- specifically put them in disorder to track regression
|
||||||
|
-- https://github.com/Ukendio/jecs/pull/15
|
||||||
|
world:set(id, B, true)
|
||||||
|
world:set(id, A, true)
|
||||||
|
if i > 5 then
|
||||||
|
world:remove(id, B)
|
||||||
|
end
|
||||||
|
entities[i] = id
|
||||||
|
end
|
||||||
|
|
||||||
|
local added = 0
|
||||||
|
for id in world:query(A) do
|
||||||
|
added += 1
|
||||||
|
table.remove(entities, CHECK(table.find(entities, id)))
|
||||||
|
end
|
||||||
|
|
||||||
|
CHECK(added == N)
|
||||||
|
end
|
||||||
|
|
||||||
|
do CASE("should query all entities without B")
|
||||||
|
local world = jecs.World.new()
|
||||||
|
local A = world:component()
|
||||||
|
local B = world:component()
|
||||||
|
|
||||||
|
local entities = {}
|
||||||
|
for i = 1, N do
|
||||||
|
local id = world:entity()
|
||||||
|
|
||||||
|
world:set(id, A, true)
|
||||||
|
if i < 5 then
|
||||||
|
entities[i] = id
|
||||||
|
else
|
||||||
|
world:set(id, B, true)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
for id in world:query(A):without(B) do
|
||||||
|
table.remove(entities, CHECK(table.find(entities, id)))
|
||||||
|
end
|
||||||
|
|
||||||
|
CHECK(#entities == 0)
|
||||||
|
end
|
||||||
|
|
||||||
|
do CASE("should allow setting components in arbitrary order")
|
||||||
|
local world = jecs.World.new()
|
||||||
|
|
||||||
|
local Health = world:entity()
|
||||||
|
local Poison = world:component()
|
||||||
|
|
||||||
|
local id = world:entity()
|
||||||
|
world:set(id, Poison, 5)
|
||||||
|
world:set(id, Health, 50)
|
||||||
|
|
||||||
|
CHECK(world:get(id, Poison) == 5)
|
||||||
|
end
|
||||||
|
|
||||||
|
do CASE("should allow deleting components")
|
||||||
|
local world = jecs.World.new()
|
||||||
|
|
||||||
|
local Health = world:entity()
|
||||||
|
local Poison = world:component()
|
||||||
|
|
||||||
|
local id = world:entity()
|
||||||
|
world:set(id, Poison, 5)
|
||||||
|
world:set(id, Health, 50)
|
||||||
|
local id1 = world:entity()
|
||||||
|
world:set(id1, Poison, 500)
|
||||||
|
world:set(id1, Health, 50)
|
||||||
|
|
||||||
|
world:delete(id)
|
||||||
|
|
||||||
|
CHECK(world:get(id, Poison) == nil)
|
||||||
|
CHECK(world:get(id, Health) == nil)
|
||||||
|
CHECK(world:get(id1, Poison) == 500)
|
||||||
|
CHECK(world:get(id1, Health) == 50)
|
||||||
|
end
|
||||||
|
|
||||||
|
do CASE("should allow remove that doesn't exist on entity")
|
||||||
|
local world = jecs.World.new()
|
||||||
|
|
||||||
|
local Health = world:entity()
|
||||||
|
local Poison = world:component()
|
||||||
|
|
||||||
|
local id = world:entity()
|
||||||
|
world:set(id, Health, 50)
|
||||||
|
world:remove(id, Poison)
|
||||||
|
|
||||||
|
CHECK(world:get(id, Poison) == nil)
|
||||||
|
CHECK(world:get(id, Health) == 50)
|
||||||
|
end
|
||||||
|
|
||||||
|
do CASE("should increment generation")
|
||||||
|
local world = jecs.World.new()
|
||||||
|
local e = world:entity()
|
||||||
|
CHECK(ECS_ID(e) == 1 + jecs.Rest)
|
||||||
|
CHECK(getAlive(world.entityIndex, ECS_ID(e)) == e)
|
||||||
|
CHECK(ECS_GENERATION(e) == 0) -- 0
|
||||||
|
e = ECS_GENERATION_INC(e)
|
||||||
|
CHECK(ECS_GENERATION(e) == 1) -- 1
|
||||||
|
end
|
||||||
|
|
||||||
|
do CASE("should get alive from index in the dense array")
|
||||||
|
local world = jecs.World.new()
|
||||||
|
local _e = world:entity()
|
||||||
|
local e2 = world:entity()
|
||||||
|
local e3 = world:entity()
|
||||||
|
|
||||||
|
CHECK(IS_PAIR(world:entity()) == false)
|
||||||
|
|
||||||
|
local pair = ECS_PAIR(e2, e3)
|
||||||
|
CHECK(IS_PAIR(pair) == true)
|
||||||
|
|
||||||
|
CHECK(ECS_PAIR_RELATION(world.entityIndex, pair) == e2)
|
||||||
|
CHECK(ECS_PAIR_OBJECT(world.entityIndex, pair) == e3)
|
||||||
|
end
|
||||||
|
|
||||||
|
do CASE("should allow querying for relations")
|
||||||
|
local world = jecs.World.new()
|
||||||
|
local Eats = world:entity()
|
||||||
|
local Apples = world:entity()
|
||||||
|
local bob = world:entity()
|
||||||
|
|
||||||
|
world:set(bob, ECS_PAIR(Eats, Apples), true)
|
||||||
|
for e, bool in world:query(ECS_PAIR(Eats, Apples)) do
|
||||||
|
CHECK(e == bob)
|
||||||
|
CHECK(bool)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
do CASE("should allow wildcards in queries")
|
||||||
|
local world = jecs.World.new()
|
||||||
|
local Eats = world:entity()
|
||||||
|
local Apples = world:entity()
|
||||||
|
local bob = world:entity()
|
||||||
|
|
||||||
|
world:set(bob, ECS_PAIR(Eats, Apples), "bob eats apples")
|
||||||
|
|
||||||
|
local w = jecs.Wildcard
|
||||||
|
for e, data in world:query(ECS_PAIR(Eats, w)) do
|
||||||
|
CHECK(e == bob)
|
||||||
|
CHECK(data == "bob eats apples")
|
||||||
|
end
|
||||||
|
for e, data in world:query(ECS_PAIR(w, Apples)) do
|
||||||
|
CHECK(e == bob)
|
||||||
|
CHECK(data == "bob eats apples")
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
do CASE("should match against multiple pairs")
|
||||||
|
local world = jecs.World.new()
|
||||||
|
local Eats = world:entity()
|
||||||
|
local Apples = world:entity()
|
||||||
|
local Oranges = world:entity()
|
||||||
|
local bob = world:entity()
|
||||||
|
local alice = world:entity()
|
||||||
|
|
||||||
|
world:set(bob, ECS_PAIR(Eats, Apples), "bob eats apples")
|
||||||
|
world:set(alice, ECS_PAIR(Eats, Oranges), "alice eats oranges")
|
||||||
|
|
||||||
|
local w = jecs.Wildcard
|
||||||
|
local count = 0
|
||||||
|
for e, data in world:query(ECS_PAIR(Eats, w)) do
|
||||||
|
count += 1
|
||||||
|
if e == bob then
|
||||||
|
CHECK(data == "bob eats apples")
|
||||||
|
else
|
||||||
|
CHECK(data == "alice eats oranges")
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
CHECK(count == 2)
|
||||||
|
count = 0
|
||||||
|
|
||||||
|
for e, data in world:query(ECS_PAIR(w, Apples)) do
|
||||||
|
count += 1
|
||||||
|
CHECK(data == "bob eats apples")
|
||||||
|
end
|
||||||
|
CHECK(count == 1)
|
||||||
|
end
|
||||||
|
|
||||||
|
do CASE("should only relate alive entities")
|
||||||
|
|
||||||
|
local world = jecs.World.new()
|
||||||
|
local Eats = world:entity()
|
||||||
|
local Apples = world:entity()
|
||||||
|
local Oranges = world:entity()
|
||||||
|
local bob = world:entity()
|
||||||
|
local alice = world:entity()
|
||||||
|
|
||||||
|
world:set(bob, Apples, "apples")
|
||||||
|
world:set(bob, ECS_PAIR(Eats, Apples), "bob eats apples")
|
||||||
|
world:set(alice, ECS_PAIR(Eats, Oranges), "alice eats oranges")
|
||||||
|
|
||||||
|
world:delete(Apples)
|
||||||
|
local Wildcard = jecs.Wildcard
|
||||||
|
|
||||||
|
local count = 0
|
||||||
|
for _, data in world:query(ECS_PAIR(Wildcard, Apples)) do
|
||||||
|
count += 1
|
||||||
|
end
|
||||||
|
|
||||||
|
world:delete(ECS_PAIR(Eats, Apples))
|
||||||
|
|
||||||
|
CHECK(count == 0)
|
||||||
|
CHECK(world:get(bob, ECS_PAIR(Eats, Apples)) == nil)
|
||||||
|
end
|
||||||
|
|
||||||
|
do CASE("should error when setting invalid pair")
|
||||||
|
local world = jecs.World.new()
|
||||||
|
local Eats = world:entity()
|
||||||
|
local Apples = world:entity()
|
||||||
|
local bob = world:entity()
|
||||||
|
|
||||||
|
world:delete(Apples)
|
||||||
|
|
||||||
|
world:set(bob, ECS_PAIR(Eats, Apples), "bob eats apples")
|
||||||
|
end
|
||||||
|
|
||||||
|
do CASE("should find target for ChildOf")
|
||||||
|
local world = jecs.World.new()
|
||||||
|
local ChildOf = jecs.ChildOf
|
||||||
|
local pair = ECS_PAIR
|
||||||
|
|
||||||
|
local Name = world:component()
|
||||||
|
|
||||||
|
local bob = world:entity()
|
||||||
|
local alice = world:entity()
|
||||||
|
local sara = world:entity()
|
||||||
|
|
||||||
|
world:add(bob, pair(ChildOf, alice))
|
||||||
|
world:set(bob, Name, "bob")
|
||||||
|
world:add(sara, pair(ChildOf, alice))
|
||||||
|
world:set(sara, Name, "sara")
|
||||||
|
CHECK(world:parent(bob) == alice) -- O(1)
|
||||||
|
|
||||||
|
local count = 0
|
||||||
|
for _, name in world:query(Name, ECS_PAIR(ChildOf, alice)) do
|
||||||
|
count += 1
|
||||||
|
end
|
||||||
|
CHECK(count == 2)
|
||||||
|
end
|
||||||
|
|
||||||
|
do CASE "should be able to add/remove matching entity during iteration"
|
||||||
|
local world = jecs.World.new()
|
||||||
|
local Name = world:component()
|
||||||
|
for i = 1, 5 do
|
||||||
|
local e = world:entity()
|
||||||
|
world:set(e, Name, tostring(e))
|
||||||
|
end
|
||||||
|
local count = 0
|
||||||
|
for id, name in world:query(Name) do
|
||||||
|
count += 1
|
||||||
|
CHECK(id == tonumber(name))
|
||||||
|
|
||||||
|
world:remove(id, Name)
|
||||||
|
local e = world:entity()
|
||||||
|
world:set(e, Name, tostring(e))
|
||||||
|
end
|
||||||
|
CHECK(count == 5)
|
||||||
|
end
|
||||||
|
|
||||||
|
do CASE "should allow adding a matching entity during iteration"
|
||||||
|
local world = jecs.World.new()
|
||||||
|
local A = world:component()
|
||||||
|
local B = world:component()
|
||||||
|
|
||||||
|
local e1 = world:entity()
|
||||||
|
local e2 = world:entity()
|
||||||
|
world:add(e1, A)
|
||||||
|
world:add(e2, A)
|
||||||
|
world:add(e2, B)
|
||||||
|
|
||||||
|
local count = 0
|
||||||
|
for id in world:query(A) do
|
||||||
|
local e = world:entity()
|
||||||
|
world:add(e, A)
|
||||||
|
world:add(e, B)
|
||||||
|
count += 1
|
||||||
|
end
|
||||||
|
|
||||||
|
CHECK(count == 3)
|
||||||
|
end
|
||||||
|
|
||||||
|
|
||||||
|
do CASE "should not iterate same entity when adding component"
|
||||||
|
local world = jecs.World.new()
|
||||||
|
local A = world:component()
|
||||||
|
local B = world:component()
|
||||||
|
|
||||||
|
local e1 = world:entity()
|
||||||
|
local e2 = world:entity()
|
||||||
|
world:add(e1, A)
|
||||||
|
world:add(e2, A)
|
||||||
|
world:add(e2, B)
|
||||||
|
|
||||||
|
local count = 0
|
||||||
|
for id in world:query(A) do
|
||||||
|
world:add(id, B)
|
||||||
|
|
||||||
|
count += 1
|
||||||
|
end
|
||||||
|
|
||||||
|
print(count)
|
||||||
|
CHECK(count == 2)
|
||||||
|
end
|
||||||
|
end)
|
||||||
|
|
||||||
|
FINISH()
|
||||||
26
tsconfig.json
Normal file
26
tsconfig.json
Normal file
|
|
@ -0,0 +1,26 @@
|
||||||
|
{
|
||||||
|
"compilerOptions": {
|
||||||
|
// required
|
||||||
|
"allowSyntheticDefaultImports": true,
|
||||||
|
"downlevelIteration": true,
|
||||||
|
"jsx": "react",
|
||||||
|
"jsxFactory": "Roact.createElement",
|
||||||
|
"jsxFragmentFactory": "Roact.Fragment",
|
||||||
|
"module": "commonjs",
|
||||||
|
"moduleResolution": "Node",
|
||||||
|
"noLib": true,
|
||||||
|
"resolveJsonModule": true,
|
||||||
|
"strict": true,
|
||||||
|
"target": "ESNext",
|
||||||
|
"typeRoots": ["node_modules/@rbxts"],
|
||||||
|
|
||||||
|
// configurable
|
||||||
|
"rootDir": "lib",
|
||||||
|
"outDir": "out",
|
||||||
|
"baseUrl": "lib",
|
||||||
|
"incremental": true,
|
||||||
|
"tsBuildInfoFile": "out/tsconfig.tsbuildinfo",
|
||||||
|
|
||||||
|
"moduleDetection": "force"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -1,7 +1,8 @@
|
||||||
[package]
|
[package]
|
||||||
name = "ukendio/jecs"
|
name = "ukendio/jecs"
|
||||||
version = "0.1.0"
|
version = "0.2.1"
|
||||||
registry = "https://github.com/UpliftGames/wally-index"
|
registry = "https://github.com/UpliftGames/wally-index"
|
||||||
realm = "shared"
|
realm = "shared"
|
||||||
include = ["default.project.json", "lib/**", "lib", "wally.toml", "README.md"]
|
include = ["default.project.json", "src/**",
|
||||||
|
"src", "wally.toml", "README.md", "CHANGELOG.md"]
|
||||||
exclude = ["**"]
|
exclude = ["**"]
|
||||||
Loading…
Reference in a new issue