@vworlds/vecs 1.0.11 → 1.0.13

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/.husky/pre-commit CHANGED
@@ -1,2 +1,3 @@
1
1
  npx tsc --noEmit
2
2
  npx lint-staged
3
+ yarn format:check
package/README.md CHANGED
@@ -15,7 +15,7 @@ yarn add @vworlds/vecs
15
15
  | Concept | What it is |
16
16
  | ------------------------ | ------------------------------------------------------------------------------- |
17
17
  | **World** | Central container. Owns every entity, query, system, and pipeline phase. |
18
- | **Component** | A plain data class. Extend `Component` and attach instances to entities. |
18
+ | **Component** | A registered plain data class with a no-argument constructor. |
19
19
  | **Entity** | A numeric id with a set of components. Created via the world. |
20
20
  | **Query** | A reactive, always-up-to-date set of entities matching a predicate. |
21
21
  | **System** | A `Query` with phase placement and per-tick logic (`update`, `each`, `run`). |
@@ -30,28 +30,28 @@ yarn add @vworlds/vecs
30
30
  registerComponent() × N → addPhase() / system() / query() × N → start() → progress() every frame
31
31
  ```
32
32
 
33
- After `start()`, component registration is disabled. Systems and queries can still be created — standalone queries backfill existing matched entities immediately.
33
+ Components must be registered before they are used as component classes. After `start()`, component registration is disabled. Systems and queries can still be created — standalone queries backfill existing matched entities immediately.
34
34
 
35
35
  ---
36
36
 
37
37
  ## Example
38
38
 
39
39
  ```ts
40
- import { World, Component, IPhase } from "@vworlds/vecs";
40
+ import { World, type IPhase } from "@vworlds/vecs";
41
41
 
42
42
  // ─── Components ────────────────────────────────────────────────────────────
43
43
 
44
- class Position extends Component {
44
+ class Position {
45
45
  x = 0;
46
46
  y = 0;
47
47
  }
48
48
 
49
- class Velocity extends Component {
49
+ class Velocity {
50
50
  vx = 0;
51
51
  vy = 0;
52
52
  }
53
53
 
54
- class Health extends Component {
54
+ class Health {
55
55
  hp = 100;
56
56
  }
57
57
 
@@ -78,7 +78,7 @@ world
78
78
  .each([Position, Velocity], (e, [pos, vel]) => {
79
79
  pos.x += vel.vx;
80
80
  pos.y += vel.vy;
81
- pos.modified(); // signal that Position changed so other systems react
81
+ e.modified(Position); // signal that Position changed so other systems react
82
82
  });
83
83
 
84
84
  // HealthSystem: despawns entities whose HP drops to zero.
@@ -86,9 +86,9 @@ world
86
86
  .system("Health")
87
87
  .phase(cleanup)
88
88
  .requires(Health)
89
- .update(Health, (health) => {
89
+ .update(Health, (entity, health) => {
90
90
  if (health.hp <= 0) {
91
- health.entity.destroy();
91
+ entity.destroy();
92
92
  }
93
93
  });
94
94
 
@@ -96,8 +96,8 @@ world
96
96
 
97
97
  world
98
98
  .hook(Health)
99
- .onAdd((h) => console.log(`entity ${h.entity.eid} spawned with hp=${h.hp}`))
100
- .onRemove((h) => console.log(`entity ${h.entity.eid} died`));
99
+ .onAdd((entity, h) => console.log(`entity ${entity.eid} spawned with hp=${h.hp}`))
100
+ .onRemove((entity) => console.log(`entity ${entity.eid} died`));
101
101
 
102
102
  // ─── Start ─────────────────────────────────────────────────────────────────
103
103
 
@@ -144,9 +144,16 @@ const world = new World();
144
144
 
145
145
  #### Component registration
146
146
 
147
+ Components are ordinary classes. They do not inherit from a vecs base class, and vecs constructs them with `new ComponentClass()`, so constructors should take no parameters. Register every component class before using it in `add`, `set`, `get`, `requires`, `query`, `filter`, `hook`, or `setExclusiveComponents`.
148
+
147
149
  ```ts
150
+ class Position {
151
+ x = 0;
152
+ y = 0;
153
+ }
154
+
148
155
  // Auto-assigned type id (≥ 256 for "local" components):
149
- world.registerComponent(Position);
156
+ const positionMeta = world.registerComponent(Position);
150
157
 
151
158
  // Explicit numeric type id (e.g. server-assigned):
152
159
  world.registerComponent(Position, 1);
@@ -158,7 +165,9 @@ world.registerComponent(Position, "pos");
158
165
  world.registerComponentType("Position", 1);
159
166
  ```
160
167
 
161
- After `world.start()` (or `world.disableComponentRegistration()`) any further call to `registerComponent` throws.
168
+ `registerComponent` returns the `ComponentMeta` for the class. Internally, vecs stores that metadata on the component class under a hidden world-specific key, so the same class can be registered independently in multiple worlds. Numeric type lookup still goes through the world's type table.
169
+
170
+ After `world.start()` (or `world.disableComponentRegistration()`) any further call to `registerComponent` throws. There is no automatic component registration; using an unregistered component class as a component is an error.
162
171
 
163
172
  #### Exclusive component groups
164
173
 
@@ -199,12 +208,12 @@ world.clearAllEntities();
199
208
  ```ts
200
209
  world
201
210
  .hook(Sprite)
202
- .onAdd((sprite) => sprite.initialize(scene))
203
- .onRemove((sprite) => sprite.destroy())
204
- .onSet((sprite) => sprite.syncToScene());
211
+ .onAdd((entity, sprite) => sprite.initialize(scene, entity))
212
+ .onRemove((entity, sprite) => sprite.destroy(scene, entity))
213
+ .onSet((entity, sprite) => sprite.syncToScene(entity));
205
214
  ```
206
215
 
207
- `onAdd` fires when the component is first attached. `onRemove` fires when it is removed (or the entity is destroyed). `onSet` fires whenever `component.modified()` (or `entity.modified(c)`) is called, and when `entity.set(C, props)` is applied to an entity that already has the component.
216
+ `onAdd` fires when the component is first attached. `onRemove` fires when it is removed (or the entity is destroyed). `onSet` fires whenever `entity.modified(C)` is called, and when `entity.set(C, props)` is applied to an entity that already has the component. Hook callbacks receive the owning entity because component instances do not carry entity references.
208
217
 
209
218
  #### Phases
210
219
 
@@ -217,9 +226,14 @@ const send = world.addPhase("send");
217
226
  world.progress(now, delta);
218
227
 
219
228
  // ...or run individual phases manually:
220
- world.runPhase(preUpdate, now, delta);
221
- world.runPhase(update, now, delta);
222
- world.runPhase(send, now, delta);
229
+ world.beginFrame(delta);
230
+ try {
231
+ world.runPhase(preUpdate, now, delta);
232
+ world.runPhase(update, now, delta);
233
+ world.runPhase(send, now, delta);
234
+ } finally {
235
+ world.endFrame();
236
+ }
223
237
  ```
224
238
 
225
239
  Systems with no explicit phase are placed in the built-in `"update"` phase.
@@ -237,6 +251,67 @@ world
237
251
  .exit(...);
238
252
  ```
239
253
 
254
+ #### Timers and rate filters
255
+
256
+ Systems can opt into a slower cadence instead of running on every phase tick. `interval()` takes seconds; throttled `run()` callbacks receive the accumulated milliseconds since the previous fire as `delta`.
257
+
258
+ ```ts
259
+ import { IntervalTickSource, RateTickSource } from "@vworlds/vecs";
260
+
261
+ world
262
+ .system("Move")
263
+ .interval(1.0)
264
+ .each([Position], (e, [pos]) => {
265
+ // 1 Hz
266
+ });
267
+
268
+ world
269
+ .system("Move")
270
+ .rate(2)
271
+ .each([Position], (e, [pos]) => {
272
+ // every 2nd frame
273
+ });
274
+
275
+ const second = new IntervalTickSource(1.0);
276
+
277
+ world
278
+ .system("Move")
279
+ .tickSource(second)
280
+ .each([Position], (e, [pos]) => {
281
+ // driven by a shared timer
282
+ });
283
+
284
+ second.stop();
285
+ second.start();
286
+
287
+ const minute = new RateTickSource(60, second);
288
+ const hour = world
289
+ .system("Hour")
290
+ .tickSource(minute)
291
+ .rate(60)
292
+ .run((now, delta) => {
293
+ console.log("hour tick", now, delta);
294
+ });
295
+
296
+ // Systems can also be tick sources for each other.
297
+ const eachSecond = world
298
+ .system("EachSecond")
299
+ .interval(1)
300
+ .run(() => {
301
+ // ...
302
+ });
303
+
304
+ const eachMinute = world
305
+ .system("EachMinute")
306
+ .tickSource(eachSecond)
307
+ .rate(60)
308
+ .run(() => {
309
+ // ...
310
+ });
311
+ ```
312
+
313
+ Tick source objects and systems can both be used as sources. Disabling a source system suppresses its callbacks, but its clock still drives downstream consumers.
314
+
240
315
  #### Queries
241
316
 
242
317
  ```ts
@@ -292,8 +367,10 @@ world.endDefer();
292
367
 
293
368
  ### `Component`
294
369
 
370
+ Components are plain classes. vecs does not provide a runtime base class and does not attach `entity`, `meta`, `type`, `bitPtr`, or `modified()` to component instances.
371
+
295
372
  ```ts
296
- class Position extends Component {
373
+ class Position {
297
374
  x = 0;
298
375
  y = 0;
299
376
  }
@@ -303,20 +380,21 @@ world.registerComponent(Position);
303
380
  entity.add(Position);
304
381
  const pos = entity.get(Position)!;
305
382
  pos.x = 100;
306
- pos.modified(); // tell the world this component changed
383
+ entity.modified(Position); // tell the world this component changed
307
384
 
308
385
  // Equivalent — set assigns props and fires onSet automatically:
309
386
  entity.set(Position, { x: 100 });
310
387
  ```
311
388
 
312
- | Property / Method | Description |
313
- | ----------------- | --------------------------------------------------------------------- |
314
- | `entity` | The `Entity` this component belongs to. |
315
- | `meta` | `ComponentMeta` type id, display name, and bit-pointer. |
316
- | `type` | Numeric type id (shorthand for `meta.type`). |
317
- | `bitPtr` | `BitPtr` (shorthand for `meta.bitPtr`). |
318
- | `modified()` | Queue an `onSet` / `update` notification. Call after mutating fields. |
319
- | `toString()` | Returns the registered component name. |
389
+ | Rule | Description |
390
+ | ------------------------- | ------------------------------------------------------------------------------------------------------------- |
391
+ | Plain class | Components should be ordinary classes with field initializers and methods as needed. |
392
+ | No-arg construction | vecs calls `new ComponentClass()`, so constructors should be omitted or take no parameters. |
393
+ | Explicit registration | Call `world.registerComponent(C)` before using the class as a component. |
394
+ | Shared instances possible | A component instance does not know which entity owns it; code should use the entity passed by vecs callbacks. |
395
+ | Manual dirty marking | After mutating fields directly, call `entity.modified(C)` to notify hooks, queries, and systems. |
396
+
397
+ Use `world.getComponentMeta(C)` or `world.getComponentType(C)` when you need metadata such as the numeric type id or component name. Metadata is world-specific.
320
398
 
321
399
  ---
322
400
 
@@ -324,32 +402,32 @@ entity.set(Position, { x: 100 });
324
402
 
325
403
  Created via `world.entity()` (auto-assigned id) or `world.getOrCreateEntity(id, ...)` (caller-supplied id).
326
404
 
327
- | Property / Method | Description |
328
- | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
329
- | `eid` | Unique numeric entity id. |
330
- | `world` | The `World` that owns this entity. |
331
- | `componentBitmask` | `Bitset` of component type ids attached to this entity. Used by archetype matching. |
332
- | `properties` | `Map<string, any>` free-form bag for module-level bookkeeping. |
333
- | `add(Class)` | Attach a component (idempotent). Returns the entity for chaining. |
334
- | `set(Class, props)` | Attach a component and assign `props`; fires `onSet`. Returns the entity for chaining. |
335
- | `modified(component)` | Queue an `onSet` / `update` notification. Returns the entity for chaining. |
336
- | `get(Class)` | Return the component instance, or `undefined`. |
337
- | `remove(Class)` | Detach a component (fires `onRemove` and `exit`). |
338
- | `destroy()` | Remove all components, unregister from the world, recurse into children. |
339
- | `components` | `ReadonlyArrayMap<Component>` — read-only view of attached components keyed by type id. Supports `forEach`, `get`, `has`, and `size`. |
340
- | `empty` | `true` when no components are attached. |
341
- | `parent` | Parent entity, or `undefined` for a root entity. |
342
- | `children` | `ReadonlySet<Entity>` of direct children (lazy). |
343
- | `setParent(p)` | Reparent the entity. `undefined` makes it a root entity. Throws on cycles. |
344
- | `events` | Typed event emitter. Currently emits `"destroy"` just before teardown. |
345
- | `toString()` | Returns `"EntityN"`. |
346
-
347
- `entity.modified(c)` is equivalent to `c.modified()` but returns the entity so it can chain:
405
+ | Property / Method | Description |
406
+ | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
407
+ | `eid` | Unique numeric entity id. |
408
+ | `world` | The `World` that owns this entity. |
409
+ | `componentBitmask` | `Bitset` of component type ids attached to this entity. Used by archetype matching. |
410
+ | `properties` | `Map<string, any>` free-form bag for module-level bookkeeping. |
411
+ | `add(Class)` | Attach a component (idempotent). Returns the entity for chaining. |
412
+ | `set(Class, props)` | Attach a component and assign `props`; fires `onSet`. Returns the entity for chaining. |
413
+ | `modified(Class)` | Queue an `onSet` / `update` notification for a component class or numeric type id. Returns the entity for chaining. |
414
+ | `get(Class)` | Return the component instance, or `undefined`. |
415
+ | `remove(Class)` | Detach a component (fires `onRemove` and `exit`). |
416
+ | `destroy()` | Remove all components, unregister from the world, recurse into children. |
417
+ | `components` | `ReadonlyArrayMap<Component>` — read-only view of attached components keyed by type id. Supports `forEach`, `get`, `has`, and `size`. |
418
+ | `empty` | `true` when no components are attached. |
419
+ | `parent` | Parent entity, or `undefined` for a root entity. |
420
+ | `children` | `ReadonlySet<Entity>` of direct children (lazy). |
421
+ | `setParent(p)` | Reparent the entity. `undefined` makes it a root entity. Throws on cycles. |
422
+ | `events` | Typed event emitter. Currently emits `"destroy"` just before teardown. |
423
+ | `toString()` | Returns `"EntityN"`. |
424
+
425
+ Call `entity.modified(C)` after mutating a component directly. Repeated calls for the same component type are coalesced while the world is deferred:
348
426
 
349
427
  ```ts
350
428
  const vel = entity.get(Velocity)!;
351
429
  vel.vx += accel;
352
- entity.modified(vel); // chainable
430
+ entity.modified(Velocity); // chainable
353
431
  ```
354
432
 
355
433
  #### Parent / child hierarchy
@@ -396,6 +474,8 @@ Declare which entities the system tracks.
396
474
  | A single class / id | Shorthand for `{ HAS: [C] }` |
397
475
  | A predicate function | Custom membership logic |
398
476
 
477
+ Class-valued query terms are recognized as components by looking up registered metadata for the current world. Register component classes before using them in a `QueryDSL`; an unregistered class is treated like a predicate function and will fail if it cannot be called that way.
478
+
399
479
  **Type inference.** `requires()` records the listed classes as a type parameter `R` on the system. Callbacks in `.sort()`, `.each()`, and `.update()` injection treat those components as non-nullable — no `!` needed. For complex `query()` expressions the type system can't introspect, supply a `_guaranteed` second argument:
400
480
 
401
481
  ```ts
@@ -440,12 +520,12 @@ Fires when an entity leaves the system (component removed or entity destroyed).
440
520
 
441
521
  #### `.update(ComponentClass, callback)` / `.update(ComponentClass, inject, callback)`
442
522
 
443
- Fires when `component.modified()` is called for the watched component on a tracked entity.
523
+ Fires when `entity.modified(ComponentClass)` is called for the watched component on a tracked entity. It also fires for `entity.set(C, props)` on an already-attached component and for initial watched components when an entity enters the query. The callback receives the entity first because component instances do not carry owner references.
444
524
 
445
525
  ```ts
446
- .update(Position, (pos) => renderer.setPosition(pos.x, pos.y));
526
+ .update(Position, (entity, pos) => renderer.setPosition(entity.eid, pos.x, pos.y));
447
527
 
448
- .update(Position, [Sprite], (pos, [sprite]) => {
528
+ .update(Position, [Sprite], (entity, pos, [sprite]) => {
449
529
  sprite.sprite.setPosition(pos.x, pos.y);
450
530
  });
451
531
  ```
@@ -471,7 +551,7 @@ Store matched entities in a custom order determined by `compare`. Implies `.trac
471
551
  world
472
552
  .system("Render")
473
553
  .requires(Position, Sprite)
474
- .sort([Position], ([posA], [posB]) => posA.z - posB.z)
554
+ .sort([Position], (_entityA, [posA], _entityB, [posB]) => posA.z - posB.z)
475
555
  .each([Position, Sprite], (e, [pos, sprite]) => sprite.draw(pos.x, pos.y));
476
556
  ```
477
557
 
@@ -489,6 +569,22 @@ Fires every tick when the system's phase runs, regardless of entity state. Use f
489
569
  });
490
570
  ```
491
571
 
572
+ #### `.disable()` / `.enable()`
573
+
574
+ Pause and resume a system at runtime. While disabled the system is effectively invisible: the inbox is cleared immediately, any new `enter`, `exit`, or `update` events are silently dropped, `run` and `each` callbacks do not fire, and the system skips its `_run` entirely. Entity membership in the underlying query is still maintained, so the tracked set remains correct and the system resumes cleanly when re-enabled. Events that occurred while the system was disabled are **not** replayed.
575
+
576
+ ```ts
577
+ const ai = world.system("AI").requires(Enemy).run(tickAI);
578
+
579
+ // Pause AI processing during a cutscene:
580
+ ai.disable();
581
+
582
+ // Resume normal processing:
583
+ ai.enable();
584
+ ```
585
+
586
+ Both methods return `this` for chaining and are idempotent (calling `disable()` on an already-disabled system, or `enable()` on an already-enabled system, is a no-op).
587
+
492
588
  #### `.destroy()`
493
589
 
494
590
  **Not supported on `System`** — calling it throws. Systems live for the duration of the world. Use a standalone `Query` for temporary reactive sets.
@@ -503,7 +599,7 @@ Fires every tick when the system's phase runs, regardless of entity state. Use f
503
599
  const projectiles = world
504
600
  .query("Projectiles")
505
601
  .requires(Position, Velocity)
506
- .sort([Position], ([a], [b]) => a.z - b.z)
602
+ .sort([Position], (_entityA, [a], _entityB, [b]) => a.z - b.z)
507
603
  .enter([Position], (e, [pos]) => {
508
604
  pos.x = spawnX;
509
605
  });
@@ -514,20 +610,20 @@ projectiles.forEach((e) => { ... });
514
610
  console.log(projectiles.entities.size, "active projectiles");
515
611
  ```
516
612
 
517
- | Method | Description |
518
- | ------------------------------------------------------- | ------------------------------------------------------------------------ |
519
- | `.requires(...components)` | Set the membership predicate to `HAS(...components)` and start tracking. |
520
- | `.query(expr, _guaranteed?)` | Set the membership predicate using a `QueryDSL` expression. |
521
- | `.enter(callback)` / `.enter(inject, callback)` | Fires when an entity joins the query. |
522
- | `.exit(callback)` / `.exit(inject, callback)` | Fires when an entity leaves the query. |
523
- | `.update(C, callback)` / `.update(C, inject, callback)` | Fires when `C` is modified on a tracked entity. |
524
- | `.sort(components, compare)` | Store matched entities in sorted order. |
525
- | `.track()` | Enable tracking. Backfills when called after `start()`. |
526
- | `.belongs(e)` | Returns `true` if the entity satisfies the predicate. |
527
- | `.forEach(callback)` | Iterate currently tracked entities. |
528
- | `.forEach(components, callback)` | Iterate with component injection. |
529
- | `.entities` | `ReadonlySet<Entity>` of currently tracked entities. |
530
- | `.destroy()` | Remove the query from the world and from every entity (no exit fires). |
613
+ | Method | Description |
614
+ | ------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
615
+ | `.requires(...components)` | Set the membership predicate to `HAS(...components)` and start tracking. |
616
+ | `.query(expr, _guaranteed?)` | Set the membership predicate using a `QueryDSL` expression. |
617
+ | `.enter(callback)` / `.enter(inject, callback)` | Fires when an entity joins the query. |
618
+ | `.exit(callback)` / `.exit(inject, callback)` | Fires when an entity leaves the query. |
619
+ | `.update(C, callback)` / `.update(C, inject, callback)` | Fires when `C` is modified on a tracked entity. Callback receives `(entity, component, injected?)`. |
620
+ | `.sort(components, compare)` | Store matched entities in sorted order. Comparator receives `(entityA, tupleA, entityB, tupleB)`. |
621
+ | `.track()` | Enable tracking. Backfills when called after `start()`. |
622
+ | `.belongs(e)` | Returns `true` if the entity satisfies the predicate. |
623
+ | `.forEach(callback)` | Iterate currently tracked entities. |
624
+ | `.forEach(components, callback)` | Iterate with component injection. |
625
+ | `.entities` | `ReadonlySet<Entity>` of currently tracked entities. |
626
+ | `.destroy()` | Remove the query from the world and from every entity (no exit fires). |
531
627
 
532
628
  #### `.destroy()` semantics
533
629
 
@@ -581,6 +677,7 @@ A compact, growable set of non-negative integers backed by 32-bit words. Used in
581
677
  | `add(n)` | Set bit `n`. |
582
678
  | `addBit(bptr)` | Set the bit at a pre-computed `BitPtr`. |
583
679
  | `delete(n)` | Clear bit `n`. Trims trailing zero words. |
680
+ | `clear()` | Remove every set bit. |
584
681
  | `has(n)` | Returns `true` if bit `n` is set. |
585
682
  | `hasBit(bptr)` | Fast check via a pre-computed `BitPtr`. |
586
683
  | `equal(other)` | Returns `true` when both bitsets have the same bits set. |
@@ -589,7 +686,7 @@ A compact, growable set of non-negative integers backed by 32-bit words. Used in
589
686
  | `indices()` | Return all set bit indices as a `number[]`. |
590
687
 
591
688
  ```ts
592
- class Tags extends Component {
689
+ class Tags {
593
690
  tags = new Bitset();
594
691
  }
595
692
 
@@ -1,5 +1,11 @@
1
1
  import { BitPtr } from "./util/bitset.js";
2
2
  import type { Entity } from "./entity.js";
3
+ /** A component instance. Components are plain objects created with a no-arg constructor. */
4
+ export type Component = object;
5
+ /** A component class constructor. */
6
+ export type ComponentClass<T extends Component = Component> = new () => T;
7
+ /** A component class constructor or its numeric type id. */
8
+ export type ComponentClassOrType = number | ComponentClass;
3
9
  /**
4
10
  * Lifecycle hook for a registered component class. Obtained via
5
11
  * {@link World.hook}.
@@ -11,16 +17,16 @@ import type { Entity } from "./entity.js";
11
17
  *
12
18
  * ```ts
13
19
  * world.hook(Sprite)
14
- * .onAdd(c => initSprite(c))
15
- * .onRemove(c => destroySprite(c))
16
- * .onSet(c => syncSprite(c));
20
+ * .onAdd((e, c) => initSprite(e, c))
21
+ * .onRemove((e, c) => destroySprite(e, c))
22
+ * .onSet((e, c) => syncSprite(e, c));
17
23
  * ```
18
24
  *
19
25
  * Callbacks fire synchronously when the corresponding entity command is
20
26
  * applied: inline outside deferred mode, or while the world drains its command
21
27
  * queue inside a system / `forEach` / `defer` block.
22
28
  *
23
- * @typeParam C - Component subclass this hook is bound to.
29
+ * @typeParam C - Component class this hook is bound to.
24
30
  */
25
31
  export interface Hook<C extends Component = Component> {
26
32
  /**
@@ -28,29 +34,29 @@ export interface Hook<C extends Component = Component> {
28
34
  * to an entity (`entity.add(C)` or `entity.set(C, ...)` on an entity that
29
35
  * does not yet have the component).
30
36
  *
31
- * @param handler - Receives the freshly created component instance.
37
+ * @param handler - Receives the entity and freshly created component instance.
32
38
  * @returns This hook, for chaining.
33
39
  */
34
- onAdd(handler: (c: C) => void): Hook<C>;
40
+ onAdd(handler: (entity: Entity, c: C) => void): Hook<C>;
35
41
  /**
36
42
  * Register a handler invoked when a component of this type is removed from
37
43
  * an entity (explicit `entity.remove(C)` or implicit removal during
38
44
  * `entity.destroy()`).
39
45
  *
40
- * @param handler - Receives the component instance that was removed.
46
+ * @param handler - Receives the entity and component instance that was removed.
41
47
  * @returns This hook, for chaining.
42
48
  */
43
- onRemove(handler: (c: C) => void): Hook<C>;
49
+ onRemove(handler: (entity: Entity, c: C) => void): Hook<C>;
44
50
  /**
45
51
  * Register a handler invoked when a component's data has been marked as
46
- * changed (`component.modified()` or `entity.modified(c)`), and when
52
+ * changed (`entity.modified(C)`), and when
47
53
  * `entity.set(C, props)` is called on an entity that already has the
48
54
  * component.
49
55
  *
50
- * @param handler - Receives the component instance whose data changed.
56
+ * @param handler - Receives the entity and component instance whose data changed.
51
57
  * @returns This hook, for chaining.
52
58
  */
53
- onSet(handler: (c: C) => void): Hook<C>;
59
+ onSet(handler: (entity: Entity, c: C) => void): Hook<C>;
54
60
  }
55
61
  /**
56
62
  * Bookkeeping record produced for each component class registered via
@@ -63,72 +69,18 @@ export interface Hook<C extends Component = Component> {
63
69
  */
64
70
  export declare class ComponentMeta implements Hook<Component> {
65
71
  /** The component class constructor this meta represents. */
66
- readonly Class: typeof Component;
72
+ readonly Class: ComponentClass;
67
73
  /** Numeric type id assigned at registration time. */
68
74
  readonly type: number;
69
75
  /** Human-readable name used in logs and serialization lookups. */
70
76
  readonly componentName: string;
71
77
  /** Pre-computed bit-pointer into the entity archetype {@link Bitset}. */
72
78
  readonly bitPtr: BitPtr;
73
- /**
74
- * Type ids of components that cannot coexist with this one on the same
75
- * entity. Set via {@link World.setExclusiveComponents}; `undefined` means
76
- * no restriction.
77
- */
78
- exclusive: number[] | undefined;
79
- constructor(Class: typeof Component, type: number, componentName: string);
79
+ constructor(Class: ComponentClass, type: number, componentName: string);
80
80
  /** @inheritdoc */
81
- onAdd(handler: (c: Component) => void): ComponentMeta;
81
+ onAdd(handler: (entity: Entity, c: Component) => void): ComponentMeta;
82
82
  /** @inheritdoc */
83
- onRemove(handler: (c: Component) => void): ComponentMeta;
83
+ onRemove(handler: (entity: Entity, c: Component) => void): ComponentMeta;
84
84
  /** @inheritdoc */
85
- onSet(handler: (c: Component) => void): ComponentMeta;
86
- }
87
- /** A component class constructor or its numeric type id. */
88
- export type ComponentClassOrType = number | typeof Component;
89
- /**
90
- * Base class for all ECS components.
91
- *
92
- * Subclass `Component` to declare data that can be attached to an
93
- * {@link Entity}. Instances are constructed by the world when
94
- * {@link Entity.add} or {@link Entity.set} runs — never instantiate manually.
95
- *
96
- * ```ts
97
- * class Position extends Component {
98
- * x = 0;
99
- * y = 0;
100
- * }
101
- *
102
- * world.registerComponent(Position);
103
- * entity.set(Position, { x: 100 });
104
- * ```
105
- *
106
- * Each instance is bound to a single entity via {@link entity}; that link is
107
- * permanent for the component's lifetime.
108
- */
109
- export declare class Component {
110
- /** The entity this component belongs to. */
111
- readonly entity: Entity;
112
- /** Registration metadata (type id, display name, bit-pointer). */
113
- readonly meta: ComponentMeta;
114
- constructor(
115
- /** The entity this component belongs to. */
116
- entity: Entity,
117
- /** Registration metadata (type id, display name, bit-pointer). */
118
- meta: ComponentMeta);
119
- /** Numeric type id — shorthand for `this.meta.type`. */
120
- get type(): number;
121
- /** Pre-computed bit-pointer — shorthand for `this.meta.bitPtr`. */
122
- get bitPtr(): BitPtr;
123
- /**
124
- * Notify the world that this component's data has changed.
125
- *
126
- * Queues a modified event that fires `update` callbacks on every system /
127
- * query that watches this component type, plus the component's `onSet`
128
- * hook. Repeated calls before the world drains its queue are coalesced
129
- * into one delivery.
130
- */
131
- modified(): void;
132
- /** Returns the component's registered display name (e.g. `"Position"`). */
133
- toString(): string;
85
+ onSet(handler: (entity: Entity, c: Component) => void): ComponentMeta;
134
86
  }
package/dist/component.js CHANGED
@@ -11,11 +11,11 @@ import { BitPtr, Bitset } from "./util/bitset.js";
11
11
  export class ComponentMeta {
12
12
  constructor(Class, type, componentName) {
13
13
  /**
14
- * Type ids of components that cannot coexist with this one on the same
15
- * entity. Set via {@link World.setExclusiveComponents}; `undefined` means
16
- * no restriction.
14
+ * @internal Peer metas of components that cannot coexist with this one on
15
+ * the same entity. Set via {@link World.setExclusiveComponents}; `undefined`
16
+ * means no restriction.
17
17
  */
18
- this.exclusive = undefined;
18
+ this._exclusive = undefined;
19
19
  this.Class = Class;
20
20
  this.type = type;
21
21
  this.componentName = componentName;
@@ -37,61 +37,6 @@ export class ComponentMeta {
37
37
  return this;
38
38
  }
39
39
  }
40
- /**
41
- * Base class for all ECS components.
42
- *
43
- * Subclass `Component` to declare data that can be attached to an
44
- * {@link Entity}. Instances are constructed by the world when
45
- * {@link Entity.add} or {@link Entity.set} runs — never instantiate manually.
46
- *
47
- * ```ts
48
- * class Position extends Component {
49
- * x = 0;
50
- * y = 0;
51
- * }
52
- *
53
- * world.registerComponent(Position);
54
- * entity.set(Position, { x: 100 });
55
- * ```
56
- *
57
- * Each instance is bound to a single entity via {@link entity}; that link is
58
- * permanent for the component's lifetime.
59
- */
60
- export class Component {
61
- constructor(
62
- /** The entity this component belongs to. */
63
- entity,
64
- /** Registration metadata (type id, display name, bit-pointer). */
65
- meta) {
66
- this.entity = entity;
67
- this.meta = meta;
68
- /** @internal Set by {@link Entity.modified} to coalesce repeated calls until the world routes the modified command. */
69
- this._dirty = false;
70
- }
71
- /** Numeric type id — shorthand for `this.meta.type`. */
72
- get type() {
73
- return this.meta.type;
74
- }
75
- /** Pre-computed bit-pointer — shorthand for `this.meta.bitPtr`. */
76
- get bitPtr() {
77
- return this.meta.bitPtr;
78
- }
79
- /**
80
- * Notify the world that this component's data has changed.
81
- *
82
- * Queues a modified event that fires `update` callbacks on every system /
83
- * query that watches this component type, plus the component's `onSet`
84
- * hook. Repeated calls before the world drains its queue are coalesced
85
- * into one delivery.
86
- */
87
- modified() {
88
- this.entity.modified(this);
89
- }
90
- /** Returns the component's registered display name (e.g. `"Position"`). */
91
- toString() {
92
- return this.meta.componentName;
93
- }
94
- }
95
40
  /**
96
41
  * Compute a {@link Bitset} with one bit set for every component class or
97
42
  * numeric type id in `classes`.