angry-pixel 2.1.5 → 2.1.6

package/lib/index.d.ts

@@ -708,6 +708,7 @@ type Component = Record<string, any>;
  */
 type ComponentType<T extends Component = Component> = {
     new (...args: any[]): T;
+    componentName?: string;
 };
 /**
  * This type represents a search result object containing an entity and its matching component.\
@@ -1817,6 +1818,12 @@ type IntervalOptions = {
     times?: number;
     /** Whether to execute the callback immediately before starting the interval timer */
     executeImmediately?: boolean;
+    /** Entity reference to cancel the interval when the entity is disabled or destroyed */
+    entityRef?: Entity;
+    /** Component reference to cancel the interval when the component is disabled or destroyed */
+    componentRef?: Component;
+    /** Whether to use the time scale for the interval, default is TRUE */
+    useTimeScale?: boolean;
 };
 /**
  * Manages the properties associated with time.\
@@ -1856,11 +1863,26 @@ type IntervalOptions = {
  *     executeImmediately: true,
  * });
  *
+ * // set an interval that will be cleared when the entity is destroyed
+ * const intervalId = timeManager.setInterval({
+ *     callback: () => console.log("Will be called indefinitely!"),
+ *     delay: 1000,
+ *     entityRef: entity,
+ * });
+ *
+ * // set an interval that will be cleared when the component is destroyed
+ * const intervalId = timeManager.setInterval({
+ *     callback: () => console.log("Will be called indefinitely!"),
+ *     delay: 1000,
+ *     componentRef: component,
+ * });
+ *
  * // clear the interval with the given id
  * this.timeManager.clearInterval(intervalId);
  * ```
  */
 declare class TimeManager {
+    private readonly entityManager;
     /** @internal */
     readonly fixedGameFramerate: number;
     /** @internal */
@@ -1894,7 +1916,7 @@ declare class TimeManager {
     get physicsDeltaTime(): number;
     /** The browser delta time affected by time scale. */
     get renderDeltaTime(): number;
-    constructor({ physicsFramerate }: GameConfig);
+    constructor({ physicsFramerate }: GameConfig, entityManager: EntityManager);
     /** @internal */
     updateForRender(time: number): void;
     /** @internal */
@@ -1903,11 +1925,13 @@ declare class TimeManager {
     updateForPhysics(time: number): void;
     /** @internal */
     updateIntervals(): void;
+    private intervalHealthCheck;
     /**
      * Sets a timer which executes a function repeatedly at a fixed time interval.\
      * If `times` is provided, the interval will be cleared after the function has been called that many times.\
      * But if `times` is not provided, the interval will continue until it is cleared.\
      * If `executeImmediately` is set to true, the function will be called immediately after the interval is set.\
+     * If `useTimeScale` is set to false, the interval will use the unscaled delta time.\
      * Intervals are cleared when loading a new scene.
      * @param intervalOptions
      * @returns intervalId
@@ -1935,7 +1959,7 @@ declare class TimeManager {
      * });
      * ```
      */
-    setInterval({ callback, delay, times, executeImmediately }: IntervalOptions): number;
+    setInterval({ callback, delay, times, executeImmediately, entityRef, componentRef, useTimeScale, }: IntervalOptions): number;
     /**
      * Clears the interval with the given id.
      * @param intervalId
@@ -2236,17 +2260,26 @@ interface AnimatorOptions {
  * ```
  */
 declare class Animator {
+    /** The animations to play. */
     animations: Map<string, Animation>;
+    /** The animation to play. */
     animation: string;
+    /** The speed of the animation. */
     speed: number;
+    /** TRUE If the animation should reset to the first frame when the animation is stopped, FALSE otherwise. */
     reset: boolean;
+    /** TRUE If the animation is playing, FALSE otherwise. */
     playing: boolean;
+    /** The current frame of the animation. */
     currentFrame: number;
+    /** The current time of the animation. */
     currentTime: number;
     /**  @internal */
     _currentAnimation: string;
     /**  @internal */
     _assetsReady: boolean;
+    /** @internal */
+    static componentName: string;
     constructor(options?: Partial<AnimatorOptions>);
 }
 /**
@@ -2413,6 +2446,8 @@ declare class AudioPlayer {
     _currentAudioSource: HTMLAudioElement;
     _playPromisePendind: boolean;
     _playAfterUserInput: boolean;
+    /** @internal */
+    static componentName: string;
     constructor(options?: Partial<AudioPlayerOptions>);
     /**
      * Play the audio source.
@@ -2505,6 +2540,8 @@ declare class Button {
     onClick: () => void;
     /** Function executed when the button is pressed */
     onPressed: () => void;
+    /** @internal */
+    static componentName: string;
     constructor(options?: Partial<ButtonOptions>);
 }
 /**
@@ -2560,8 +2597,12 @@ interface TiledWrapperOptions {
  * ```
  */
 declare class TiledWrapper {
+    /** The tilemap to render. */
     tilemap: TiledTilemap | string;
+    /** The layer to render. */
     layerToRender: string;
+    /** @internal */
+    static componentName: string;
     constructor(options?: Partial<TiledWrapperOptions>);
 }
 /**
@@ -2724,6 +2765,8 @@ declare class Transform {
     _awake: boolean;
     /** @internal */
     _parent: Transform;
+    /** @internal */
+    static componentName: string;
     constructor(options?: Partial<TransformOptions>);
 }
 
@@ -2785,6 +2828,8 @@ declare class BallCollider implements Collider {
     ignoreCollisionsWithLayers: string[];
     /** @internal */
     shapes: Shape[];
+    /** @internal */
+    static componentName: string;
     constructor(options?: Partial<BallColliderOptions>);
 }
 
@@ -2858,6 +2903,8 @@ declare class BoxCollider implements Collider {
     ignoreCollisionsWithLayers: string[];
     /** @internal */
     shapes: Shape[];
+    /** @internal */
+    static componentName: string;
     constructor(options?: Partial<BoxColliderOptions>);
 }
 
@@ -2924,6 +2971,8 @@ declare class EdgeCollider implements Collider {
     ignoreCollisionsWithLayers: string[];
     /** @internal */
     shapes: Shape[];
+    /** @internal */
+    static componentName: string;
     constructor(options?: Partial<EdgeColliderOptions>);
 }
 
@@ -2992,6 +3041,8 @@ declare class PolygonCollider implements Collider {
     ignoreCollisionsWithLayers: string[];
     /** @internal */
     shapes: Shape[];
+    /** @internal */
+    static componentName: string;
     constructor(options?: Partial<PolygonColliderOptions>);
 }
 
@@ -3125,6 +3176,8 @@ declare class RigidBody {
      * @public
      */
     acceleration: Vector2;
+    /** @internal */
+    static componentName: string;
     constructor(options?: Partial<RigidBodyOptions>);
 }
 
@@ -3188,6 +3241,8 @@ declare class TilemapCollider implements Collider {
     physics: boolean;
     /** @internal */
     shapes: Shape[];
+    /** @internal */
+    static componentName: string;
     constructor(options?: Partial<TilemapColliderOptions>);
 }
 
@@ -3445,6 +3500,8 @@ declare class Camera {
     debug: boolean;
     /** @internal */
     _renderData: CameraData;
+    /** @internal */
+    static componentName: string;
     constructor(options?: Partial<CameraOptions>);
 }
 
@@ -3497,6 +3554,8 @@ declare class LightRenderer {
     intensity: number;
     /** @internal */
     _boundingBox: Rectangle;
+    /** @internal */
+    static componentName: string;
     constructor(options?: Partial<LightRendererOptions>);
 }
 
@@ -3618,6 +3677,8 @@ declare class MaskRenderer {
     layer: string;
     /** @internal */
     _renderData: MaskRenderData;
+    /** @internal */
+    static componentName: string;
     constructor(options?: Partial<MaskRendererOptions>);
 }
 
@@ -3676,6 +3737,8 @@ declare class DarknessRenderer {
     _boundingBox: Rectangle;
     /** @internal */
     _renderData: DarknessRenderData;
+    /** @internal */
+    static componentName: string;
     constructor(options?: Partial<DarknessRendererOptions>);
 }
 
@@ -3787,6 +3850,8 @@ declare class SpriteRenderer {
     tiled: Vector2;
     /** @internal */
     _renderData: SpriteRenderData;
+    /** @internal */
+    static componentName: string;
     constructor(options?: Partial<SpriteRendererOptions>);
 }
 
@@ -3997,6 +4062,8 @@ declare class TextRenderer {
     width: number;
     /** @internal */
     _renderData: TextRenderData;
+    /** @internal */
+    static componentName: string;
     constructor(options?: Partial<TextRendererOptions>);
 }
 
@@ -4110,6 +4177,8 @@ declare class TilemapRenderer {
     _processed: boolean;
     /** @internal */
     _renderData: TilemapRenderData[];
+    /** @internal */
+    static componentName: string;
     constructor(options?: Partial<TilemapRendererOptions>);
 }
 /**
@@ -4264,6 +4333,8 @@ declare class VideoRenderer {
     _playPromisePendind: boolean;
     /** @internal */
     _renderData: VideoRenderData;
+    /** @internal */
+    static componentName: string;
     constructor(options?: Partial<VideoRendererOptions>);
     /**
      * Play the video source.