@draug/engine 1.0.15 → 1.0.17

package/dist/index.d.cts

@@ -203,7 +203,7 @@ declare function Plugin(metadata: PluginMetadata): ClassDecorator;
 declare function getPluginMetadata(plugin: ClassType<PluginBase>): PluginMetadata;
 declare function isPlugin(ctor: Function): boolean;
 declare abstract class PluginBase {
-    onPluginLoad?: (world: World) => void;
+    onPluginLoad?: () => void;
     onPluginUnload?: (world: World) => void;
     onAfterWorldInit?: (world: World) => void;
 }
@@ -227,11 +227,30 @@ declare class PluginsManager {
     private isInitiated_;
     install<T extends ClassType<PluginBase>>(plugin: T, ...constructorProps: ConstructorParameters<T>): void;
     build(): void;
+    __internal__onAfterWorldInit(world: World): void;
     getPluginMetadata(pluginOrId: ClassType<PluginBase> | PluginID): PluginMetadata;
     getPluginInstance<T extends PluginBase>(pluginOrId: ClassType<T> | PluginID): T;
     private resolveId;
 }
 
+declare enum LogLevel {
+    Debug = 0,
+    Info = 1,
+    Warn = 2,
+    Error = 3
+}
+type LogMessage = () => string;
+interface Logger {
+    debug(message: LogMessage): void;
+    info(message: LogMessage): void;
+    warn(message: LogMessage): void;
+    error(message: LogMessage): void;
+}
+
+type WorldConstructor = {
+    maxEntityCount?: number;
+    logger: Logger;
+};
 declare class World {
     readonly entities: EntitiesManager;
     readonly components: ComponentsManager;
@@ -242,7 +261,7 @@ declare class World {
     readonly queries: QueryManager;
     readonly plugins: PluginsManager;
     private entityRefs_;
-    constructor(maxEntityCount?: number);
+    constructor(params: WorldConstructor);
     getEntityRef(id: number): EntityRef;
     query(params: QueryParameters): number[];
     removeComponent<T extends object>(ref: EntityRef, component: ComponentType<T>): void;
@@ -310,11 +329,17 @@ type SystemCtor<T extends SystemBase = SystemBase> = ClassType<T>;
  */
 type SystemComputeContext = {
     /** Entity IDs from the query for this {@link SystemBase.compute} invocation. */
-    entities: number[];
+    readonly entities: number[];
     /** ECS world instance. */
-    world: World;
+    readonly world: World;
     /** Delta time (seconds or your engine's convention) since the previous update. */
-    dt: number;
+    readonly dt: number;
+    /** Logger instance for debugging and diagnostics. */
+    readonly logger: Logger;
+};
+type SystemInitContext = {
+    world: World;
+    logger: Logger;
 };
 /**
  * Base class for ECS systems executed by {@link SystemsManager}.
@@ -328,15 +353,16 @@ declare abstract class SystemBase {
      * Logic for one systems pass: run for all entities in {@link SystemComputeContext.entities}.
      */
     abstract compute(ctx: SystemComputeContext): void;
-    onInit?(world: World): void;
+    onInit?(ctx: SystemInitContext): void;
 }
 declare class SystemsManager {
     private readonly world;
+    private readonly logger;
     private systems_;
     private executionOrder_;
     private requiredComponents_;
     private dirty_;
-    constructor(world: World);
+    constructor(world: World, logger: Logger);
     getRequiredComponents(): ComponentType[];
     register<T extends SystemBase>(sys: T): void;
     build(): void;
@@ -360,16 +386,49 @@ declare class Clock {
     tick(): void;
 }
 
-type StepFunction = (dt: number) => void;
-declare class GameLoop {
-    private clock;
-    private stepFn;
+type StepFunction = (dt: number, world: World) => void;
+type PlatformLoop = (callback: () => void) => void;
+declare class Loop {
+    private readonly clock;
+    private readonly stepFn;
+    private readonly platformLoop;
     private running;
-    constructor(clock: Clock, stepFn: StepFunction);
-    start(platformLoop: (callback: () => void) => void): void;
+    constructor(clock: Clock, stepFn: StepFunction, platformLoop: PlatformLoop);
+    start(world: World): void;
     stop(): void;
 }
 
+declare class Runtime {
+    private readonly loop;
+    constructor(loop: Loop);
+    run(world: World): void;
+}
+
+declare enum VisitedState {
+    Unvisited = 0,
+    Visiting = 1,
+    Visited = 2
+}
+declare class DAGNode<T> {
+    readonly data: T;
+    readonly vertices: DAGNode<T>[];
+    constructor(data: T, vertices?: DAGNode<T>[]);
+}
+declare class ErrDAGCycleDetected extends Error {
+    constructor();
+}
+declare function topologicalSort<T>(nodes: Iterable<DAGNode<T>>): DAGNode<T>[];
+
+declare class ObjectPool<T extends object> {
+    private pool_;
+    private factory_;
+    private cursor_;
+    constructor(factory: () => T, initialSize?: number);
+    acquire(): T;
+    release(obj: T): void;
+    private grow;
+}
+
 declare enum AssetState {
     NOT_READY = 1,
     LOADING = 2,
@@ -420,36 +479,18 @@ declare class AssetsManager {
     disposeAll(): void;
 }
 
-declare class Runtime {
-    readonly world: World;
+type EngineConstructor = {
+    loop: Loop;
+    logger?: Logger;
+};
+declare class Engine {
+    readonly runtime: Runtime;
     readonly assets: AssetsManager;
-    constructor(world: World, assets: AssetsManager);
-    update(dt: number): void;
-}
-
-declare enum VisitedState {
-    Unvisited = 0,
-    Visiting = 1,
-    Visited = 2
-}
-declare class DAGNode<T> {
-    readonly data: T;
-    readonly vertices: DAGNode<T>[];
-    constructor(data: T, vertices?: DAGNode<T>[]);
-}
-declare class ErrDAGCycleDetected extends Error {
-    constructor();
-}
-declare function topologicalSort<T>(nodes: Iterable<DAGNode<T>>): DAGNode<T>[];
-
-declare class ObjectPool<T extends object> {
-    private pool_;
-    private factory_;
-    private cursor_;
-    constructor(factory: () => T, initialSize?: number);
-    acquire(): T;
-    release(obj: T): void;
-    private grow;
+    readonly world: World;
+    readonly logger: Logger;
+    constructor(params: EngineConstructor);
+    init(): void;
+    start(): void;
 }
 
-export { Asset, type AssetDisposer, type AssetID, type AssetIDGenerator, type AssetLoader, AssetState, AssetStorage, AssetsManager, type ClassType, Clock, Commands, Component, ComponentAlreadyRegisteredError, type ComponentInitFn, ComponentStorage, type ComponentType, ComponentsManager, type CreateEntityComponentEntry, DAGNode, EntitiesManager, type EntityID, EntityMaskNotFoundError, EntityRef, ErrDAGCycleDetected, ErrMissingPluginMetadata, ErrMissingSystemMetadata, ErrNotAPlugin, ErrNotASystem, ErrPluginNotInit, ErrUnknownPlugin, EventBuffer, EventBus, GameLoop, type IStorage, ObjectPool, Plugin, PluginBase, type PluginDependencies, PluginError, type PluginID, type PluginMetadata, PluginsManager, ResourcesManager, Runtime, SingletonStorage, type StepFunction, System, SystemBase, type SystemComputeContext, SystemError, SystemPhase, SystemsManager, type TimeSource, UnregisteredComponentStorageError, VisitedState, World, type WorldCommand, createEventKey, entry, getPluginMetadata, getSystemMetadata, isPlugin, isSystem, topologicalSort };
+export { Asset, type AssetDisposer, type AssetID, type AssetIDGenerator, type AssetLoader, AssetState, AssetStorage, AssetsManager, type ClassType, Clock, Commands, Component, ComponentAlreadyRegisteredError, type ComponentInitFn, ComponentStorage, type ComponentType, ComponentsManager, type CreateEntityComponentEntry, DAGNode, Engine, type EngineConstructor, EntitiesManager, type EntityID, EntityMaskNotFoundError, EntityRef, ErrDAGCycleDetected, ErrMissingPluginMetadata, ErrMissingSystemMetadata, ErrNotAPlugin, ErrNotASystem, ErrPluginNotInit, ErrUnknownPlugin, EventBuffer, EventBus, type IStorage, LogLevel, type LogMessage, type Logger, Loop, ObjectPool, type PlatformLoop, Plugin, PluginBase, type PluginDependencies, PluginError, type PluginID, type PluginMetadata, PluginsManager, ResourcesManager, Runtime, SingletonStorage, type StepFunction, System, SystemBase, type SystemComputeContext, SystemError, type SystemInitContext, SystemPhase, SystemsManager, type TimeSource, UnregisteredComponentStorageError, VisitedState, World, type WorldCommand, createEventKey, entry, getPluginMetadata, getSystemMetadata, isPlugin, isSystem, topologicalSort };

package/dist/index.d.ts

@@ -203,7 +203,7 @@ declare function Plugin(metadata: PluginMetadata): ClassDecorator;
 declare function getPluginMetadata(plugin: ClassType<PluginBase>): PluginMetadata;
 declare function isPlugin(ctor: Function): boolean;
 declare abstract class PluginBase {
-    onPluginLoad?: (world: World) => void;
+    onPluginLoad?: () => void;
     onPluginUnload?: (world: World) => void;
     onAfterWorldInit?: (world: World) => void;
 }
@@ -227,11 +227,30 @@ declare class PluginsManager {
     private isInitiated_;
     install<T extends ClassType<PluginBase>>(plugin: T, ...constructorProps: ConstructorParameters<T>): void;
     build(): void;
+    __internal__onAfterWorldInit(world: World): void;
     getPluginMetadata(pluginOrId: ClassType<PluginBase> | PluginID): PluginMetadata;
     getPluginInstance<T extends PluginBase>(pluginOrId: ClassType<T> | PluginID): T;
     private resolveId;
 }
 
+declare enum LogLevel {
+    Debug = 0,
+    Info = 1,
+    Warn = 2,
+    Error = 3
+}
+type LogMessage = () => string;
+interface Logger {
+    debug(message: LogMessage): void;
+    info(message: LogMessage): void;
+    warn(message: LogMessage): void;
+    error(message: LogMessage): void;
+}
+
+type WorldConstructor = {
+    maxEntityCount?: number;
+    logger: Logger;
+};
 declare class World {
     readonly entities: EntitiesManager;
     readonly components: ComponentsManager;
@@ -242,7 +261,7 @@ declare class World {
     readonly queries: QueryManager;
     readonly plugins: PluginsManager;
     private entityRefs_;
-    constructor(maxEntityCount?: number);
+    constructor(params: WorldConstructor);
     getEntityRef(id: number): EntityRef;
     query(params: QueryParameters): number[];
     removeComponent<T extends object>(ref: EntityRef, component: ComponentType<T>): void;
@@ -310,11 +329,17 @@ type SystemCtor<T extends SystemBase = SystemBase> = ClassType<T>;
  */
 type SystemComputeContext = {
     /** Entity IDs from the query for this {@link SystemBase.compute} invocation. */
-    entities: number[];
+    readonly entities: number[];
     /** ECS world instance. */
-    world: World;
+    readonly world: World;
     /** Delta time (seconds or your engine's convention) since the previous update. */
-    dt: number;
+    readonly dt: number;
+    /** Logger instance for debugging and diagnostics. */
+    readonly logger: Logger;
+};
+type SystemInitContext = {
+    world: World;
+    logger: Logger;
 };
 /**
  * Base class for ECS systems executed by {@link SystemsManager}.
@@ -328,15 +353,16 @@ declare abstract class SystemBase {
      * Logic for one systems pass: run for all entities in {@link SystemComputeContext.entities}.
      */
     abstract compute(ctx: SystemComputeContext): void;
-    onInit?(world: World): void;
+    onInit?(ctx: SystemInitContext): void;
 }
 declare class SystemsManager {
     private readonly world;
+    private readonly logger;
     private systems_;
     private executionOrder_;
     private requiredComponents_;
     private dirty_;
-    constructor(world: World);
+    constructor(world: World, logger: Logger);
     getRequiredComponents(): ComponentType[];
     register<T extends SystemBase>(sys: T): void;
     build(): void;
@@ -360,16 +386,49 @@ declare class Clock {
     tick(): void;
 }
 
-type StepFunction = (dt: number) => void;
-declare class GameLoop {
-    private clock;
-    private stepFn;
+type StepFunction = (dt: number, world: World) => void;
+type PlatformLoop = (callback: () => void) => void;
+declare class Loop {
+    private readonly clock;
+    private readonly stepFn;
+    private readonly platformLoop;
     private running;
-    constructor(clock: Clock, stepFn: StepFunction);
-    start(platformLoop: (callback: () => void) => void): void;
+    constructor(clock: Clock, stepFn: StepFunction, platformLoop: PlatformLoop);
+    start(world: World): void;
     stop(): void;
 }
 
+declare class Runtime {
+    private readonly loop;
+    constructor(loop: Loop);
+    run(world: World): void;
+}
+
+declare enum VisitedState {
+    Unvisited = 0,
+    Visiting = 1,
+    Visited = 2
+}
+declare class DAGNode<T> {
+    readonly data: T;
+    readonly vertices: DAGNode<T>[];
+    constructor(data: T, vertices?: DAGNode<T>[]);
+}
+declare class ErrDAGCycleDetected extends Error {
+    constructor();
+}
+declare function topologicalSort<T>(nodes: Iterable<DAGNode<T>>): DAGNode<T>[];
+
+declare class ObjectPool<T extends object> {
+    private pool_;
+    private factory_;
+    private cursor_;
+    constructor(factory: () => T, initialSize?: number);
+    acquire(): T;
+    release(obj: T): void;
+    private grow;
+}
+
 declare enum AssetState {
     NOT_READY = 1,
     LOADING = 2,
@@ -420,36 +479,18 @@ declare class AssetsManager {
     disposeAll(): void;
 }
 
-declare class Runtime {
-    readonly world: World;
+type EngineConstructor = {
+    loop: Loop;
+    logger?: Logger;
+};
+declare class Engine {
+    readonly runtime: Runtime;
     readonly assets: AssetsManager;
-    constructor(world: World, assets: AssetsManager);
-    update(dt: number): void;
-}
-
-declare enum VisitedState {
-    Unvisited = 0,
-    Visiting = 1,
-    Visited = 2
-}
-declare class DAGNode<T> {
-    readonly data: T;
-    readonly vertices: DAGNode<T>[];
-    constructor(data: T, vertices?: DAGNode<T>[]);
-}
-declare class ErrDAGCycleDetected extends Error {
-    constructor();
-}
-declare function topologicalSort<T>(nodes: Iterable<DAGNode<T>>): DAGNode<T>[];
-
-declare class ObjectPool<T extends object> {
-    private pool_;
-    private factory_;
-    private cursor_;
-    constructor(factory: () => T, initialSize?: number);
-    acquire(): T;
-    release(obj: T): void;
-    private grow;
+    readonly world: World;
+    readonly logger: Logger;
+    constructor(params: EngineConstructor);
+    init(): void;
+    start(): void;
 }
 
-export { Asset, type AssetDisposer, type AssetID, type AssetIDGenerator, type AssetLoader, AssetState, AssetStorage, AssetsManager, type ClassType, Clock, Commands, Component, ComponentAlreadyRegisteredError, type ComponentInitFn, ComponentStorage, type ComponentType, ComponentsManager, type CreateEntityComponentEntry, DAGNode, EntitiesManager, type EntityID, EntityMaskNotFoundError, EntityRef, ErrDAGCycleDetected, ErrMissingPluginMetadata, ErrMissingSystemMetadata, ErrNotAPlugin, ErrNotASystem, ErrPluginNotInit, ErrUnknownPlugin, EventBuffer, EventBus, GameLoop, type IStorage, ObjectPool, Plugin, PluginBase, type PluginDependencies, PluginError, type PluginID, type PluginMetadata, PluginsManager, ResourcesManager, Runtime, SingletonStorage, type StepFunction, System, SystemBase, type SystemComputeContext, SystemError, SystemPhase, SystemsManager, type TimeSource, UnregisteredComponentStorageError, VisitedState, World, type WorldCommand, createEventKey, entry, getPluginMetadata, getSystemMetadata, isPlugin, isSystem, topologicalSort };
+export { Asset, type AssetDisposer, type AssetID, type AssetIDGenerator, type AssetLoader, AssetState, AssetStorage, AssetsManager, type ClassType, Clock, Commands, Component, ComponentAlreadyRegisteredError, type ComponentInitFn, ComponentStorage, type ComponentType, ComponentsManager, type CreateEntityComponentEntry, DAGNode, Engine, type EngineConstructor, EntitiesManager, type EntityID, EntityMaskNotFoundError, EntityRef, ErrDAGCycleDetected, ErrMissingPluginMetadata, ErrMissingSystemMetadata, ErrNotAPlugin, ErrNotASystem, ErrPluginNotInit, ErrUnknownPlugin, EventBuffer, EventBus, type IStorage, LogLevel, type LogMessage, type Logger, Loop, ObjectPool, type PlatformLoop, Plugin, PluginBase, type PluginDependencies, PluginError, type PluginID, type PluginMetadata, PluginsManager, ResourcesManager, Runtime, SingletonStorage, type StepFunction, System, SystemBase, type SystemComputeContext, SystemError, type SystemInitContext, SystemPhase, SystemsManager, type TimeSource, UnregisteredComponentStorageError, VisitedState, World, type WorldCommand, createEventKey, entry, getPluginMetadata, getSystemMetadata, isPlugin, isSystem, topologicalSort };

package/dist/index.js

@@ -94,10 +94,12 @@ function isSystem(ctor) {
 var SystemBase = class {
 };
 var SystemsManager = class {
-  constructor(world) {
+  constructor(world, logger) {
     this.world = world;
+    this.logger = logger;
   }
   world;
+  logger;
   systems_ = /* @__PURE__ */ new Map();
   executionOrder_ = [];
   requiredComponents_ = /* @__PURE__ */ new Set();
@@ -121,9 +123,12 @@ var SystemsManager = class {
       this.requiredComponents_.add(c);
   }
   build() {
+    this.logger.info(() => "Building systems...");
     this.buildSystemsArray();
     for (const sys of this.systems_.values())
-      sys.onInit?.(this.world);
+      sys.onInit?.({ world: this.world, logger: this.logger });
+    this.logger.info(() => "Systems sucessfully was built!");
+    this.dirty_ = false;
   }
   rebuild() {
     this.build();
@@ -141,7 +146,12 @@ var SystemsManager = class {
     for (const s of this.executionOrder_) {
       const { query } = getSystemMetadata(s.constructor);
       const entities = this.world.query(query);
-      s.compute({ entities, world: this.world, dt });
+      s.compute({
+        world: this.world,
+        entities,
+        dt,
+        logger: this.logger
+      });
     }
   }
   buildSystemsArray() {
@@ -679,7 +689,7 @@ var QueryManager = class {
   }
 };
 
-// src/plugin/plugin.ts
+// src/ecs/plugin/plugin.ts
 var PluginMetadataSymbol = /* @__PURE__ */ Symbol("plugin");
 function Plugin(metadata) {
   return (target) => {
@@ -787,10 +797,17 @@ var PluginsManager = class {
     for (const node of sortedNodes) {
       const entry2 = this.plugins_.get(node.data);
       const { ctor, ctorParams } = entry2;
-      entry2.instance = new ctor(...ctorParams);
+      const instance = new ctor(...ctorParams);
+      entry2.instance = instance;
+      instance.onPluginLoad?.();
     }
     this.isInitiated_ = true;
   }
+  __internal__onAfterWorldInit(world) {
+    for (const p of this.plugins_.values()) {
+      p.instance?.onAfterWorldInit?.(world);
+    }
+  }
   getPluginMetadata(pluginOrId) {
     const id2 = this.resolveId(pluginOrId);
     const entry2 = this.plugins_.get(id2);
@@ -820,17 +837,24 @@ var PluginsManager = class {
 
 // src/ecs/world.ts
 var World3 = class {
-  entities = new EntitiesManager();
-  components = new ComponentsManager();
-  systems = new SystemsManager(this);
-  events = new EventBus();
-  resources = new ResourcesManager();
-  commands = new Commands(this);
-  queries = new QueryManager(this);
-  plugins = new PluginsManager();
+  entities;
+  components;
+  systems;
+  events;
+  resources;
+  commands;
+  queries;
+  plugins;
   entityRefs_ = /* @__PURE__ */ new Map();
-  constructor(maxEntityCount = ECS_DEFAULTS.MAX_ENTITY_COUNT) {
-    this.components = new ComponentsManager(maxEntityCount);
+  constructor(params) {
+    this.components = new ComponentsManager(params.maxEntityCount ?? ECS_DEFAULTS.MAX_ENTITY_COUNT);
+    this.systems = new SystemsManager(this, params.logger);
+    this.entities = new EntitiesManager();
+    this.events = new EventBus();
+    this.resources = new ResourcesManager();
+    this.commands = new Commands(this);
+    this.queries = new QueryManager(this);
+    this.plugins = new PluginsManager();
   }
   getEntityRef(id2) {
     let ref = this.entityRefs_.get(id2);
@@ -875,6 +899,17 @@ var World3 = class {
   }
 };
 
+// src/runtime/runtime.ts
+var Runtime = class {
+  constructor(loop) {
+    this.loop = loop;
+  }
+  loop;
+  run(world) {
+    this.loop.start(world);
+  }
+};
+
 // src/runtime/clock.ts
 var Clock = class {
   constructor(timeSource_) {
@@ -900,43 +935,32 @@ var Clock = class {
   }
 };
 
-// src/runtime/game-loop.ts
-var GameLoop = class {
-  constructor(clock, stepFn) {
+// src/runtime/loop.ts
+var Loop = class {
+  constructor(clock, stepFn, platformLoop) {
     this.clock = clock;
     this.stepFn = stepFn;
+    this.platformLoop = platformLoop;
   }
   clock;
   stepFn;
+  platformLoop;
   running = false;
-  start(platformLoop) {
+  start(world) {
     this.running = true;
     const loop = () => {
       if (!this.running) return;
       this.clock.tick();
-      this.stepFn(this.clock.dt);
-      platformLoop(loop);
+      this.stepFn(this.clock.dt, world);
+      this.platformLoop(loop);
     };
-    platformLoop(loop);
+    this.platformLoop(loop);
   }
   stop() {
     this.running = false;
   }
 };
 
-// src/runtime/runtime.ts
-var Runtime = class {
-  constructor(world, assets) {
-    this.world = world;
-    this.assets = assets;
-  }
-  world;
-  assets;
-  update(dt) {
-    this.world.update(dt);
-  }
-};
-
 // src/assets/assets.ts
 var AssetState = /* @__PURE__ */ ((AssetState2) => {
   AssetState2[AssetState2["NOT_READY"] = 1] = "NOT_READY";
@@ -1082,6 +1106,46 @@ var AssetsManager = class {
     Array.from(this.storages_.values(), (s) => s.clearAll());
   }
 };
+
+// src/logger/logger.ts
+var LogLevel = /* @__PURE__ */ ((LogLevel2) => {
+  LogLevel2[LogLevel2["Debug"] = 0] = "Debug";
+  LogLevel2[LogLevel2["Info"] = 1] = "Info";
+  LogLevel2[LogLevel2["Warn"] = 2] = "Warn";
+  LogLevel2[LogLevel2["Error"] = 3] = "Error";
+  return LogLevel2;
+})(LogLevel || {});
+var NoopLogger = class {
+  debug() {
+  }
+  info() {
+  }
+  warn() {
+  }
+  error() {
+  }
+};
+
+// src/engine.ts
+var Engine = class {
+  runtime;
+  assets = new AssetsManager();
+  world;
+  logger;
+  constructor(params) {
+    this.runtime = new Runtime(params.loop);
+    this.logger = params.logger ?? new NoopLogger();
+    this.world = new World3({
+      logger: this.logger
+    });
+  }
+  init() {
+    this.world.build();
+  }
+  start() {
+    this.runtime.run(this.world);
+  }
+};
 export {
   Asset,
   AssetState,
@@ -1094,6 +1158,7 @@ export {
   ComponentStorage,
   ComponentsManager,
   DAGNode,
+  Engine,
   EntitiesManager,
   EntityMaskNotFoundError,
   EntityRef,
@@ -1106,7 +1171,8 @@ export {
   ErrUnknownPlugin,
   EventBuffer,
   EventBus,
-  GameLoop,
+  LogLevel,
+  Loop,
   ObjectPool,
   Plugin,
   PluginBase,