@combos-fun/engine 0.0.11 → 0.0.12

package/dist/engine.d.ts

@@ -90,209 +90,80 @@ declare class Transform extends Component<TransformParams> {
     clearChildren(): void;
 }
 
-/**
- * Scene is a gameObject container
- */
-declare class Scene extends GameObject {
-    gameObjects: GameObject[];
-    canvas: HTMLCanvasElement;
-    constructor(name: any, obj?: TransformParams);
-    /**
-     * Add gameObject
-     * @param gameObject - game object
-     */
-    addGameObject(gameObject: GameObject): void;
-    /**
-     * Remove gameObject
-     * @param gameObject - game object
-     */
-    removeGameObject(gameObject: GameObject): void;
-    /**
-     * Destroy scene
-     */
-    destroy(): void;
+interface TickerOptions {
+    autoStart?: boolean;
+    frameRate?: number;
 }
-
 /**
- * GameObject is a general purpose object. It consists of a unique id and components.
- * @public
+ * Timeline tool
  */
-declare class GameObject {
-    /** Name of this gameObject */
-    private _name;
-    /** Scene is an abstraction, represent a canvas layer */
-    private _scene;
-    /** A key-value map for components on this gameObject */
-    private _componentCache;
-    /** Identifier of this gameObject */
-    id: number;
-    /** Components apply to this gameObject */
-    components: Component<ComponentParams>[];
-    /** GameObject has been destroyed */
-    destroyed: boolean;
-    /**
-     * Consruct a new gameObject
-     * @param name - the name of this gameObject
-     * @param obj - optional transform parameters for default Transform component
-     */
-    constructor(name: string, obj?: TransformParams);
-    /**
-     * Get default transform component
-     * @returns transform component on this gameObject
-     * @readonly
-     */
-    get transform(): Transform;
-    /**
-     * Get parent gameObject
-     * @returns parent gameObject
-     * @readonly
-     */
-    get parent(): GameObject;
-    /**
-     * Get the name of this gameObject
-     * @readonly
-     */
-    get name(): string;
-    set scene(val: Scene);
-    /**
-     * Get the scene which this gameObject added on
-     * @returns scene
-     * @readonly
-     */
-    get scene(): Scene;
-    /**
-     * Add child gameObject
-     * @param gameObject - child gameobject
-     */
-    addChild(gameObject: GameObject): void;
-    /**
-     * Remove child gameObject
-     * @param gameObject - child gameobject
-     */
-    removeChild(gameObject: GameObject): GameObject;
-    /**
-     * Add component to this gameObject
-     * @remarks
-     * If component has already been added on a gameObject, it will throw an error
-     * @param C - component instance or Component class
-     */
-    addComponent<T extends Component<ComponentParams>>(C: T): T;
-    addComponent<T extends Component<ComponentParams>>(C: ComponentConstructor<T>, obj?: ComponentParams): T;
-    /**
-     * Remove component on this gameObject
-     * @remarks
-     * default Transform component can not be removed, if the paramter represent a transform component, an error will be thrown.
-     * @param c - one of the compnoentName, component instance, component Class
-     * @returns
-     */
-    removeComponent<T extends Component<ComponentParams>>(c: string): T;
-    removeComponent<T extends Component<ComponentParams>>(c: T): T;
-    removeComponent<T extends Component<ComponentParams>>(c: ComponentConstructor<T>): T;
-    private _removeComponent;
-    /**
-     * Get component on this gameObject
-     * @param c - one of the compnoentName, component instance, component Class
-     * @returns
-     */
-    getComponent<T extends Component<ComponentParams>>(c: ComponentConstructor<T>): T;
-    getComponent<T extends Component>(c: string): T;
+declare class Ticker {
+    /** Whether or not ticker should auto start */
+    autoStart: boolean;
+    /** FPS, The number of times that raf method is called per second */
+    frameRate: number;
+    /** Global Timeline **/
+    private timeline;
+    /** Time between two frame */
+    private _frameDuration;
+    /** Ticker is a function will called in each raf */
+    private _tickers;
+    /** raf handle id */
+    _requestId: number;
+    /** Last frame render time */
+    private _lastFrameTime;
+    /** Frame count since from ticker beigning */
+    private _frameCount;
+    /** Main ticker method handle */
+    private _ticker;
+    /** Represents the status of the Ticker, If ticker has started, the value is true */
+    private _started;
     /**
-     * Remove this gameObject on its parent
-     * @returns return this gameObject
+     * @param autoStart - auto start game
+     * @param frameRate - game frame rate
      */
-    remove(): GameObject;
-    /** Destory this gameObject */
-    destroy(): void;
+    constructor(options?: TickerOptions);
+    /** Main loop, all _tickers will called in this method */
+    update(): void;
+    /** Add ticker function */
+    add(fn: (params: UpdateParams) => void): void;
+    /** Remove ticker function */
+    remove(fn: (params: UpdateParams) => void): void;
+    /** Start main loop */
+    start(): void;
+    /** Pause main loop */
+    pause(): void;
+    setPlaybackRate(rate: number): void;
 }
 
-/** frame info pass to `Component.update` method */
-interface UpdateParams {
-    /** delta time from last frame */
-    deltaTime: number;
-    /** frame count since game begining */
-    frameCount: number;
-    /** current timestamp */
-    time: number;
-    /** current timestamp */
-    currentTime: number;
-    /** fps at current frame */
-    fps: number;
-}
-interface ComponentParams {
-}
-interface ComponentConstructor<T extends Component<ComponentParams>> {
-    componentName: string;
-    new (params?: ComponentParams): T;
+/** Observer event type */
+declare enum ObserverType {
+    ADD = "ADD",
+    REMOVE = "REMOVE",
+    CHANGE = "CHANGE"
 }
 /**
- * Component contain raw data apply to gameObject and how it interacts with the world
- * @public
+ * Observer property
+ * @remarks
+ * If `deep` is true then all descendants of `prop` will be observed
+ * @example
+ * ```typescript
+ * @observerComponent({
+ *   Transform: [{ prop: 'size', deep: true }]
+ * })
+ * class TestSystem extends System {}
+ * ```
  */
-declare class Component<T extends ComponentParams = {}> extends EventEmitter {
-    /** Name of this component */
-    static componentName: string;
-    /** Name of this component */
-    readonly name: string;
-    /**
-     * Represents the status of the component, If component has started, the value is true
-     * @defaultValue false
-     */
-    started: boolean;
-    /**
-     * gameObject which this component had added on
-     * @remarks
-     * Component can only be added on one gameObject, otherwise an error will be thrown,
-     * Component can only be attached to one game object at a time.
-     */
-    gameObject: GameObject;
-    /** Default paramaters for this component */
-    __componentDefaultParams: T;
-    constructor(params?: T);
-    /**
-     * Called during component construction
-     * @param params - optional initial parameters
-     * @override
-     */
-    init?(params?: T): void;
-    /**
-     * Called when component is added to a gameObject
-     * @override
-     */
-    awake?(): void;
-    /**
-     * Called after all component's `awake` method has been called
-     * @override
-     */
-    start?(): void;
-    /**
-     * Called in every tick, change self property or other component property
-     * @param frame - frame info about this tick
-     * @override
-     */
-    update?(frame: UpdateParams): void;
-    /**
-     * Called after all gameObject's `update` method has been called
-     * @param frame - frame info about this tick
-     * @override
-     */
-    lateUpdate?(frame: UpdateParams): void;
-    /**
-     * Called before game runing or every time game paused
-     * @virtual
-     * @override
-     */
-    onResume?(): void;
-    /**
-     * Called while the game paused.
-     * @override
-     */
-    onPause?(): void;
-    /**
-     * Called while component be destroyed.
-     * @override
-     */
-    onDestroy?(): void;
+interface PureObserverProp {
+    deep: boolean;
+    prop: string[];
 }
+/**
+ * Observer Info
+ * @remarks
+ * The key of this map always be component's name, the value of this map is an array of `PureObserverProp`
+ */
+type PureObserverInfo = Record<string, PureObserverProp[]>;
 
 interface ObserverEventParams {
     type: ObserverType;
@@ -337,50 +208,99 @@ declare class ComponentObserver {
     clear(): ObserverEvent[];
 }
 
-interface TickerOptions {
-    autoStart?: boolean;
-    frameRate?: number;
+interface SystemConstructor<T extends System = System> {
+    systemName: string;
+    observerInfo: PureObserverInfo;
+    new (params?: any): T;
 }
 /**
- * Timeline tool
+ * Each System runs continuously and performs global actions on every Entity that possesses a Component of the same aspect as that System.
+ * @public
  */
-declare class Ticker {
-    /** Whether or not ticker should auto start */
-    autoStart: boolean;
-    /** FPS, The number of times that raf method is called per second */
-    frameRate: number;
-    /** Global Timeline **/
-    private timeline;
-    /** Time between two frame */
-    private _frameDuration;
-    /** Ticker is a function will called in each raf */
-    private _tickers;
-    /** raf handle id */
-    _requestId: number;
-    /** Last frame render time */
-    private _lastFrameTime;
-    /** Frame count since from ticker beigning */
-    private _frameCount;
-    /** Main ticker method handle */
-    private _ticker;
-    /** Represents the status of the Ticker, If ticker has started, the value is true */
-    private _started;
+declare class System<T extends {} = {}> {
+    /** System name */
+    static systemName: string;
+    name: string;
     /**
-     * @param autoStart - auto start game
-     * @param frameRate - game frame rate
+     * The collection of component properties observed by the System. System will respond to these changes
+     * @example
+     * ```typescript
+     * // TestSystem will respond to changes of `size` and `position` property of the Transform component
+     * class TestSystem extends System {
+     *   static observerInfo = {
+     *     Transform: [{ prop: 'size', deep: true }, { prop: 'position', deep: true }]
+     *   }
+     * }
+     * ```
+     */
+    static observerInfo: PureObserverInfo;
+    /** Component Observer */
+    componentObserver: ComponentObserver;
+    /** Game instance */
+    game: Game;
+    /** Represents the status of the component, if component has started, the value is true */
+    started: boolean;
+    /** Default paramaters for this system */
+    __systemDefaultParams: T;
+    constructor(params?: T);
+    /**
+     * Called when system is added to a gameObject
+     * @remarks
+     * The difference between init and awake is that `init` method recieves params.
+     * Both of those methods are called early than `start` method.
+     * Use this method to prepare data, ect.
+     * @param param - optional params
+     * @override
+     */
+    init?(param?: T): void | Promise<void>;
+    /**
+     * Calleen system installed
+     * @override
+     */
+    awake?(): void;
+    /**
+     * Called after all system `awake` method has been called
+     * @override
+     */
+    start?(): void;
+    /**
+     * Called in each tick
+     * @example
+     * ```typescript
+     * // run TWEEN `update` method in main requestAnimationFrame loop
+     * class TransitionSystem extends System {
+     *   update() {
+     *     TWEEN.update()
+     *   }
+     * }
+     * ```
+     * @param e - info about this tick
+     * @override
+     */
+    update?(e: UpdateParams): void;
+    /**
+     * Called after all system have called the `update` method
+     * @param e - info about this tick
+     * @override
+     */
+    lateUpdate?(e: UpdateParams): void;
+    /**
+     * Called before game runing or every time game paused
+     * @override
+     */
+    onResume?(): void;
+    /**
+     * Called while the game paused
+     * @override
+     */
+    onPause?(): void;
+    /**
+     * Called while the system be destroyed.
+     * @override
      */
-    constructor(options?: TickerOptions);
-    /** Main loop, all _tickers will called in this method */
-    update(): void;
-    /** Add ticker function */
-    add(fn: (params: UpdateParams) => void): void;
-    /** Remove ticker function */
-    remove(fn: (params: UpdateParams) => void): void;
-    /** Start main loop */
-    start(): void;
-    /** Pause main loop */
-    pause(): void;
-    setPlaybackRate(rate: number): void;
+    onDestroy?(): void;
+    /** Default destroy method */
+    destroy(): void;
 }
 
 /** Plugin registration shape */
@@ -506,129 +426,216 @@ declare class Game extends EventEmitter {
     loadScene({ scene, mode, params, }: LoadSceneParams): void;
 }
 
-interface SystemConstructor<T extends System = System> {
-    systemName: string;
-    observerInfo: PureObserverInfo;
-    new (params?: any): T;
+/**
+ * Scene is a gameObject container
+ */
+declare class Scene extends GameObject {
+    gameObjects: GameObject[];
+    canvas: HTMLCanvasElement;
+    game: Game;
+    constructor(name: string, obj?: TransformParams);
+    /**
+     * Add gameObject
+     * @param gameObject - game object
+     */
+    addGameObject(gameObject: GameObject): void;
+    /**
+     * Remove gameObject
+     * @param gameObject - game object
+     */
+    removeGameObject(gameObject: GameObject): void;
+    /**
+     * Destroy scene
+     */
+    destroy(): void;
 }
+
 /**
- * Each System runs continuously and performs global actions on every Entity that possesses a Component of the same aspect as that System.
+ * GameObject is a general purpose object. It consists of a unique id and components.
  * @public
  */
-declare class System<T extends {} = {}> {
-    /** System name */
-    static systemName: string;
-    name: string;
+declare class GameObject {
+    /** Name of this gameObject */
+    private _name;
+    /** Scene is an abstraction, represent a canvas layer */
+    private _scene;
+    /** A key-value map for components on this gameObject */
+    private _componentCache;
+    /** Identifier of this gameObject */
+    id: number;
+    /** Components apply to this gameObject */
+    components: Component<ComponentParams>[];
+    /** GameObject has been destroyed */
+    destroyed: boolean;
     /**
-     * The collection of component properties observed by the System. System will respond to these changes
-     * @example
-     * ```typescript
-     * // TestSystem will respond to changes of `size` and `position` property of the Transform component
-     * class TestSystem extends System {
-     *   static observerInfo = {
-     *     Transform: [{ prop: 'size', deep: true }, { prop: 'position', deep: true }]
-     *   }
-     * }
-     * ```
+     * Consruct a new gameObject
+     * @param name - the name of this gameObject
+     * @param obj - optional transform parameters for default Transform component
+     */
+    constructor(name: string, obj?: TransformParams);
+    /**
+     * Get default transform component
+     * @returns transform component on this gameObject
+     * @readonly
+     */
+    get transform(): Transform;
+    /**
+     * Get parent gameObject
+     * @returns parent gameObject
+     * @readonly
+     */
+    get parent(): GameObject;
+    /**
+     * Get the name of this gameObject
+     * @readonly
+     */
+    get name(): string;
+    set scene(val: Scene);
+    /**
+     * Get the scene which this gameObject added on
+     * @returns scene
+     * @readonly
+     */
+    get scene(): Scene;
+    /**
+     * Add child gameObject
+     * @param gameObject - child gameobject
+     */
+    addChild(gameObject: GameObject): void;
+    /**
+     * Remove child gameObject
+     * @param gameObject - child gameobject
+     */
+    removeChild(gameObject: GameObject): GameObject;
+    /**
+     * Add component to this gameObject
+     * @remarks
+     * If component has already been added on a gameObject, it will throw an error
+     * @param C - component instance or Component class
+     */
+    addComponent<T extends Component>(C: T): T;
+    addComponent<T extends Component>(C: ComponentConstructor<T>, obj?: ComponentParams): T;
+    /**
+     * Remove component on this gameObject
+     * @remarks
+     * default Transform component can not be removed, if the paramter represent a transform component, an error will be thrown.
+     * @param c - one of the compnoentName, component instance, component Class
+     * @returns
+     */
+    removeComponent<T extends Component>(c: string): T;
+    removeComponent<T extends Component>(c: T): T;
+    removeComponent<T extends Component>(c: ComponentConstructor<T>): T;
+    private _removeComponent;
+    /**
+     * Get component on this gameObject
+     * @param c - one of the compnoentName, component instance, component Class
+     * @returns
+     */
+    getComponent<T extends Component>(c: ComponentConstructor<T>): T;
+    getComponent<T extends Component>(c: string): T;
+    /**
+     * Remove this gameObject on its parent
+     * @returns return this gameObject
+     */
+    remove(): GameObject;
+    /** Destroy this gameObject */
+    destroy(): void;
+}
+
+/** frame info pass to `Component.update` method */
+interface UpdateParams {
+    /** delta time from last frame */
+    deltaTime: number;
+    /** alias for deltaTime, matching common game framework conventions */
+    delta: number;
+    /** frame count since game begining */
+    frameCount: number;
+    /** current timestamp */
+    time: number;
+    /** current timestamp */
+    currentTime: number;
+    /** fps at current frame */
+    fps: number;
+}
+interface ComponentParams {
+}
+interface ComponentConstructor<T extends Component> {
+    componentName: string;
+    new (...args: any[]): T;
+}
+/**
+ * Component contain raw data apply to gameObject and how it interacts with the world
+ * @public
+ */
+declare class Component<T extends ComponentParams = {}> extends EventEmitter {
+    /** Name of this component */
+    static componentName: string;
+    /** Name of this component */
+    readonly name: string;
+    /**
+     * Represents the status of the component, If component has started, the value is true
+     * @defaultValue false
      */
-    static observerInfo: PureObserverInfo;
-    /** Component Observer */
-    componentObserver: ComponentObserver;
-    /** Game instance */
-    game: Game;
-    /** Represents the status of the component, if component has started, the value is true */
     started: boolean;
-    /** Default paramaters for this system */
-    __systemDefaultParams: T;
-    constructor(params?: T);
     /**
-     * Called when system is added to a gameObject
+     * gameObject which this component had added on
      * @remarks
-     * The difference between init and awake is that `init` method recieves params.
-     * Both of those methods are called early than `start` method.
-     * Use this method to prepare data, ect.
-     * @param param - optional params
+     * Component can only be added on one gameObject, otherwise an error will be thrown,
+     * Component can only be attached to one game object at a time.
+     */
+    gameObject: GameObject;
+    /**
+     * Get the game instance this component belongs to
+     */
+    get game(): Game;
+    /** Default paramaters for this component */
+    __componentDefaultParams: T;
+    constructor(params?: T);
+    /**
+     * Called during component construction
+     * @param params - optional initial parameters
      * @override
      */
-    init?(param?: T): void | Promise<void>;
+    init?(params?: T): void;
     /**
-     * Calleen system installed
+     * Called when component is added to a gameObject
      * @override
      */
     awake?(): void;
     /**
-     * Called after all system `awake` method has been called
+     * Called after all component's `awake` method has been called
      * @override
      */
     start?(): void;
     /**
-     * Called in each tick
-     * @example
-     * ```typescript
-     * // run TWEEN `update` method in main requestAnimationFrame loop
-     * class TransitionSystem extends System {
-     *   update() {
-     *     TWEEN.update()
-     *   }
-     * }
-     * ```
-     * @param e - info about this tick
+     * Called in every tick, change self property or other component property
+     * @param frame - frame info about this tick
      * @override
      */
-    update?(e: UpdateParams): void;
+    update?(frame: UpdateParams): void;
     /**
-     * Called after all system have called the `update` method
-     * @param e - info about this tick
+     * Called after all gameObject's `update` method has been called
+     * @param frame - frame info about this tick
      * @override
      */
-    lateUpdate?(e: UpdateParams): void;
+    lateUpdate?(frame: UpdateParams): void;
     /**
-     * Called before game runing or every time game paused
+     * Called every time game resumed from pause
+     * @virtual
      * @override
      */
     onResume?(): void;
     /**
-     * Called while the game paused
+     * Called while the game paused.
      * @override
      */
     onPause?(): void;
     /**
-     * Called while the system be destroyed.
+     * Called while component be destroyed.
      * @override
      */
     onDestroy?(): void;
-    /** Default destory method */
-    destroy(): void;
-}
-
-/** Observer event type */
-declare enum ObserverType {
-    ADD = "ADD",
-    REMOVE = "REMOVE",
-    CHANGE = "CHANGE"
-}
-/**
- * Observer property
- * @remarks
- * If `deep` is true then all descendants of `prop` will be observed
- * @example
- * ```typescript
- * @observerComponent({
- *   Transform: [{ prop: 'size', deep: true }]
- * })
- * class TestSystem extends System {}
- * ```
- */
-interface PureObserverProp {
-    deep: boolean;
-    prop: string[];
 }
-/**
- * Observer Info
- * @remarks
- * The key of this map always be component's name, the value of this map is an array of `PureObserverProp`
- */
-type PureObserverInfo = Record<string, PureObserverProp[]>;
 
 /**
  * Collect property which react in Editor tooling
@@ -800,7 +807,7 @@ declare class Resource extends EventEmitter {
     getResource(name: string): Promise<ResourceStruct>;
     /** Make resource instance by resource type */
     private instance;
-    /** destory this resource manager */
+    /** Destroy resource by name */
     destroy(name: string): Promise<void>;
     private _destroy;
     /**