Sync to upstream Jecs 0.5.5-nightly.20250413T001101Z

Reviewed-on: #31

jecs/.luaurc

@@ -4,6 +4,7 @@
         "testkit": "tools/testkit",
         "mirror": "mirror",
         "tools": "tools",
+        "addons": "addons"
     },
     "languageMode": "strict"
 }

jecs/CHANGELOG.md

@@ -11,29 +11,48 @@ The format is based on [Keep a Changelog][kac], and this project adheres to
 ## [Unreleased]
 
 -   `[world]`:
-    -   16% faster `world:get`
+    -   Changed `world:clear` to also look through the component record for the cleared `ID`
-    -   `world:has` no longer typechecks components after the 8th one.
+        -   Removes the cleared ID from every entity that has it
--   `[typescript]`
+    -   Changed entity ID layouts by putting the index in the lower bits, which should make every world function 1-5 nanoseconds faster
+    -   Fixed `world:delete` not removing every pair with an unalive target
+        -   Specifically happened when you had at least two pairs of different relations with multiple targets each
+-   `[hooks]`:
+    -   Replaced `OnSet` with `OnChange`
+        -   The former was used to detect emplace/move actions. Now the behaviour for `OnChange` is that it will run only when the value has changed
+    -   Changed `OnAdd` to specifically run after the data has been set for non-zero-sized components. Also returns the value that the component was set to
+        -   This should allow a more lenient window for modifying data
+    -   Changed `OnRemove` to lazily lookup which archetype the entity will move to
+        -   Can now have interior structural changes within `OnRemove` hooks
+    -   Optimized `world:has` for both single component and multiple component presence.
+        -   This comes at the cost that it cannot check the component presence for more than 4 components at a time. If this is important, consider calling to this function multiple times.
 
-    -   Fixed Entity type to default to `undefined | unknown` instead of just `undefined`
+## [0.5.0] - 2024-12-26
 
+-   `[world]`:
+    -   Fixed `world:target` not giving adjacent pairs
+    -   Added `world:each` to find entities with a specific Tag
+    -   Added `world:children` to find children of entity
 -   `[query]`:
-    -   Fixed bug where `world:clear` did not invoke `jecs.OnRemove` hooks
+    -   Added `query:cached`
-    -   Changed `query.__iter` to drain on iteration
+        -   Adds query cache that updates itself when an archetype matching the query gets created or deleted.
-        -   It will initialize once wherever you left iteration off at last time
+-   `[luau]`:
-    -   Changed `query:iter` to restart the iterator
+    -   Changed how entities' types are inferred with user-defined type functions
-    -   Removed `query:drain` and `query:next`
+    -   Changed `Pair<First, Second>` to return `Second` if `First` is a `Tag`; otherwise, returns `First`.
-        -   If you want to get individual results outside of a for-loop, you need to call `query:iter` to initialize the iterator and then call the iterator function manually
+
-        ```lua
+## [0.4.0] - 2024-11-17
-        local it = world:query(A, B, C):iter()
+
-        local entity, a, b, c = it()
+-   `[world]`:
-        entity, a, b, c = it() -- get next results
+    -   Added recycling to `world:entity`
-        ```
+        -   If you see much larger entity ids, that is because its generation has been incremented
--   `[world`
+-   `[query]`:
-    -   Fixed a bug with `world:clear` not invoking `jecs.OnRemove` hooks
+    -   Removed `query:drain`
--   `[typescript]`:
+        -   The default behaviour is simply to drain the iterator
-    -   Changed pair to accept generics
+    -   Removed `query:next`
-    -   Improved handling of Tags
+        -   Just call the iterator function returned by `query:iter` directly if you want to get the next results
+    -   Removed `query:replace`
+-   `[luau]`:
+    -   Fixed `query:archetypes` not taking `self`
+    -   Changed so that the `jecs.Pair` type now returns the first element's type so you won't need to typecast anymore.
 
 ## [0.3.2] - 2024-10-01
 

jecs/addons/observers.luau

@@ -0,0 +1,156 @@
+local jecs = require("@jecs")
+
+type Observer<T...> = {
+	callback: (jecs.Entity) -> (),
+	query: jecs.Query<T...>,
+}
+
+export type PatchedWorld = jecs.World & {
+	added: (PatchedWorld, jecs.Id, (e: jecs.Entity, id: jecs.Id, value: any) -> ()) -> (),
+	removed: (PatchedWorld, jecs.Id, (e: jecs.Entity, id: jecs.Id) -> ()) -> (),
+	changed: (PatchedWorld, jecs.Id, (e: jecs.Entity, id: jecs.Id) -> ()) -> (),
+	observer: (PatchedWorld, Observer<any>) -> (),
+	monitor: (PatchedWorld, Observer<any>) -> (),
+}
+
+local function observers_new(world, description)
+	local query = description.query
+	local callback = description.callback
+	local terms = query.filter_with :: { jecs.Id }
+	if not terms then
+		local ids = query.ids
+		query.filter_with = ids
+		terms = ids
+	end
+
+	local entity_index = world.entity_index :: any
+	local function emplaced(entity: jecs.Entity)
+		local r = jecs.entity_index_try_get_fast(
+			entity_index, entity :: any)
+
+		if not r then
+			return
+		end
+
+		local archetype = r.archetype
+
+		if jecs.query_match(query, archetype) then
+			callback(entity)
+		end
+	end
+
+	for _, term in terms do
+		world:added(term, emplaced)
+		world:changed(term, emplaced)
+ 	end
+end
+
+local function monitors_new(world, description)
+	local query = description.query
+	local callback = description.callback
+	local terms = query.filter_with :: { jecs.Id }
+	if not terms then
+		local ids = query.ids
+		query.filter_with = ids
+		terms = ids
+	end
+
+	local entity_index = world.entity_index :: any
+	local function emplaced(entity: jecs.Entity)
+		local r = jecs.entity_index_try_get_fast(
+			entity_index, entity :: any)
+
+		if not r then
+			return
+		end
+
+		local archetype = r.archetype
+
+		if jecs.query_match(query, archetype) then
+			callback(entity, jecs.OnAdd)
+		end
+	end
+
+	local function removed(entity: jecs.Entity, component: jecs.Id)
+		local r = jecs.entity_index_try_get_fast(
+			entity_index, entity :: any)
+
+		if not r then
+			return
+		end
+
+		local archetype = r.archetype
+
+		if jecs.query_match(query, archetype) then
+			callback(entity, jecs.OnRemove)
+		end
+	end
+
+	for _, term in terms do
+		world:added(term, emplaced)
+		world:removed(term, removed)
+ 	end
+end
+
+local function observers_add(world: jecs.World & { [string]: any }): PatchedWorld
+	local signals = {
+		added = {},
+		emplaced = {},
+		removed = {}
+	}
+
+	world.added = function(_, component, fn)
+		local listeners = signals.added[component]
+		if not listeners then
+			listeners = {}
+			signals.added[component] = listeners
+			local idr = jecs.id_record_ensure(world, component)
+			idr.hooks.on_add = function(entity)
+				for _, listener in listeners do
+					listener(entity, component)
+				end
+			end
+		end
+		table.insert(listeners, fn)
+	end
+
+	world.changed = function(_, component, fn)
+		local listeners = signals.emplaced[component]
+		if not listeners then
+			listeners = {}
+			signals.emplaced[component] = listeners
+			local idr = jecs.id_record_ensure(world, component)
+			idr.hooks.on_change = function(entity, value)
+				for _, listener in listeners do
+					listener(entity, component, value)
+				end
+			end
+		end
+		table.insert(listeners, fn)
+	end
+
+	world.removed = function(_, component, fn)
+		local listeners = signals.removed[component]
+		if not listeners then
+			listeners = {}
+			signals.removed[component] = listeners
+			local idr = jecs.id_record_ensure(world, component)
+			idr.hooks.on_remove = function(entity)
+				for _, listener in listeners do
+					listener(entity, component)
+				end
+			end
+		end
+		table.insert(listeners, fn)
+	end
+
+	world.signals = signals
+
+	world.observer = observers_new
+
+	world.monitor = monitors_new
+
+	return world
+end
+
+return observers_add

jecs/build.txt

@@ -1,2 +1,2 @@
-modified = [".luaurc", "jecs.luau"]
+modified = ["addons/observers.luau", ".luaurc", "CHANGELOG.md", "jecs.luau"]
-version = "0.5.5-nightly.20250312T202956Z"
+version = "0.5.5-nightly.20250413T001101Z"

jecs/pesde-rbx.toml

@@ -3,7 +3,7 @@ includes = ["init.luau", "pesde.toml", "README.md", "CHANGELOG.md", "LICENSE", "
 license = "MIT"
 name = "marked/jecs_nightly"
 repository = "https://git.devmarked.win/marked/jecs-nightly"
-version = "0.5.5-nightly.20250312T202956Z"
+version = "0.5.5-nightly.20250413T001101Z"
 
 [indices]
 default = "https://github.com/pesde-pkg/index"

jecs/pesde.toml

@@ -3,7 +3,7 @@ includes = ["init.luau", "pesde.toml", "README.md", "CHANGELOG.md", "LICENSE", "
 license = "MIT"
 name = "marked/jecs_nightly"
 repository = "https://git.devmarked.win/marked/jecs-nightly"
-version = "0.5.5-nightly.20250312T202956Z"
+version = "0.5.5-nightly.20250413T001101Z"
 
 [indices]
 default = "https://github.com/pesde-pkg/index"

jecs/test.txt

@@ -1,2 +1,2 @@
 passed = true
-timestamp = "20250324T001101Z"
+timestamp = "20250413T001103Z"

jecs/test_fulllog.txt

@@ -1,22 +1,39 @@
-271	272	273
+----idempotent
----------------- delete e2 ---------------
+1_2
-"268439800_268439816_536875256_536875272"
+7.4 us   2 kB│ delete children of entity
-"268439800_268439816_536875256"
+9.5 us   1 kB│ remove friends of entity
-"268439816_536875272"
+352 ns   0  B│ simple deletion of entity
-"268439816"
+world:add()
------------------------------
+PASS│ idempotent
-{}
+PASS│ archetype move
-7.7 us   2 kB│ delete children of entity
- 11 us   2 kB│ remove friends of entity
-321 ns   0  B│ simple deletion of entity
-removing
-#repro
-NONE│ 
 
-archetype
+world:children()
 PASS│ 
 
-world:cleanup()
+world:clear()
+PASS│ should remove its components
+PASS│ remove cleared ID from entities
+
+world:component()
+PASS│ only components should have EcsComponent trait
+PASS│ tag
+
+world:contains()
+PASS│ 
+PASS│ should not exist after delete
+
+world:delete()
+PASS│ invoke OnRemove hooks
+PASS│ delete recycled entity id used as component
+PASS│ bug: Empty entity does not respect cleanup policy
+PASS│ should allow deleting components
+PASS│ delete entities using another Entity as component with Delete cleanup action
+PASS│ delete children
+PASS│ remove deleted ID from entities
+PASS│ fast delete
+PASS│ cycle
+
+world:each()
 PASS│ 
 
 world:entity()
@@ -26,16 +43,9 @@ removing
 PASS│ Recycling
 PASS│ Recycling max generation
 
-world:set()
+world:has()
-PASS│ archetype move
+PASS│ should find Tag on entity
-PASS│ pairs
+PASS│ should return false when missing one tag
-
-world:remove()
-PASS│ should allow remove a component that doesn't exist on entity
-
-world:add()
-PASS│ idempotent
-PASS│ archetype move
 
 world:query()
 PASS│ cached
@@ -52,51 +62,35 @@ removing
 PASS│ should allow wildcards in queries
 PASS│ should match against multiple pairs
 PASS│ should only relate alive entities
-NONE│ should error when setting invalid pair
+PASS│ should error when setting invalid pair
 PASS│ should find target for ChildOf
 PASS│ despawning while iterating
-NONE│ iterator invalidation
-SKIP│ adding
-PASS│ spawning
 PASS│ should not find any entities
-PASS│ without
+PASS│ world:query():without()
 
-world:each
+world:remove()
-PASS│ 
+PASS│ should allow remove a component that doesn't exist on entity
 
-world:children
+world:set()
-PASS│ 
+PASS│ archetype move
-
+PASS│ pairs
-world:clear()
-PASS│ should remove its components
-PASS│ should move last record
-
-world:has()
-PASS│ should find Tag on entity
-PASS│ should return false when missing one tag
-
-world:component()
-PASS│ only components should have EcsComponent trait
-PASS│ tag
-
-world:delete
-PASS│ invoke OnRemove hooks
-PASS│ delete recycled entity id used as component
-PASS│ bug: Empty entity does not respect cleanup policy
-PASS│ should allow deleting components
-PASS│ delete entities using another Entity as component with Delete cleanup action
-PASS│ delete children
-PASS│ fast delete
-PASS│ cycle
 
 world:target
 PASS│ nth index
 PASS│ infer index when unspecified
 PASS│ loop until no target
 
-world:contains
+#adding a recycled target
+PASS│ 
+
+#repro2
+PASS│ 
+
+another
+PASS│ 
+
+#repro
 PASS│ 
-PASS│ should not exist after delete
 
 Hooks
 PASS│ OnAdd
@@ -121,5 +115,5 @@ removing
 PASS│ #2
 PASS│ #3
 
-69/69 test cases passed in 31.149 ms.
+68/68 test cases passed in 29.621 ms.
 0 fails

jecs/wally.toml

@@ -5,4 +5,4 @@ license = "MIT"
 name = "mark-marks/jecs-nightly"
 realm = "shared"
 registry = "https://github.com/UpliftGames/wally-index"
-version = "0.5.5-nightly.20250312T202956Z"
+version = "0.5.5-nightly.20250413T001101Z"