@drincs/pixi-vn 1.6.4 → 1.7.2

package/dist/canvas.d.cts

@@ -21,7 +21,9 @@ type AnimationOptions = AnimationOptionsCommon & Omit<CommonTickerProps, "startO
 
 type KeyframesType<T> = ObjectTarget<T> & MotionComponentExtension;
 type SequenceOptions = SequenceOptions$1 & Omit<CommonTickerProps, "startOnlyIfHaveTexture">;
-type ObjectSegment<O extends CanvasBaseInterface<any>> = [ObjectTarget<O> & MotionComponentExtension];
+type ObjectSegment<O extends CanvasBaseInterface<any>> = [
+    ObjectTarget<O> & MotionComponentExtension
+];
 type ObjectSegmentWithTransition<O extends CanvasBaseInterface<any>> = [
     ObjectTarget<O> & MotionComponentExtension,
     AnimationOptions & At
@@ -641,17 +643,11 @@ interface CanvasManagerInterface {
     /**
      * Currently tickers that are running.
      */
-    readonly currentTickers: {
-        [id: string]: TickerInfo<any>;
-    };
+    readonly currentTickers: Map<string, TickerInfo<any>>;
     /**
      * The steps of the tickers
      */
-    readonly currentTickersSteps: {
-        [alias: string]: {
-            [tickerId: string]: TickersSequence;
-        };
-    };
+    readonly currentTickersSteps: Map<string, Map<string, TickersSequence>>;
     /**
      * Find a ticker by its id.
      * @param tickerId The id of the ticker.
@@ -757,6 +753,17 @@ interface CanvasManagerInterface {
      * @returns If the ticker is paused.
      */
     isTickerPaused(alias: string, tickerId?: string): boolean;
+    /**
+     * Pause the rendering of gameLayer and pause currently running tickers.
+     * Use {@link resume} to restore rendering and resume only
+     * the tickers paused by this method.
+     */
+    pause(): void;
+    /**
+     * Resume the rendering of gameLayer and resume tickers that were paused by
+     * {@link pause}.
+     */
+    resume(): void;
     /**
      * Add a ticker that must be completed before the next step.
      * This method is used for example into a transition between scenes.
@@ -842,7 +849,7 @@ interface CanvasManagerInterface {
      * Add a HTML layer to the canvas.
      * @param id The id of the layer.
      * @param element The html element to be added.
-     * @param style The style of the layer. @default { position: "absolute", pointerEvents: "none" }.
+     * @param style The style of the layer. @default { position: "absolute", pointerEvents: "none", userSelect: "none" }.
      * @example
      * ```tsx
      * const root = document.getElementById('root')
@@ -859,7 +866,7 @@ interface CanvasManagerInterface {
      * )
      * ```
      */
-    addHtmlLayer(id: string, element: HTMLElement, style?: Pick<CSSStyleDeclaration, "position" | "pointerEvents">): HTMLDivElement;
+    addHtmlLayer(id: string, element: HTMLElement, style?: Partial<Pick<CSSStyleDeclaration, "position" | "pointerEvents" | "userSelect">>): HTMLDivElement;
     /**
      * Get a HTML layer from the canvas.
      * @param id The id of the layer to be removed.
@@ -1096,7 +1103,7 @@ interface ListenerExtension {
     on: Container$1["on"];
     readonly onEventsHandlers: OnEventsHandlers;
 }
-declare function addListenerHandler<T extends ListenerExtension>(event: symbol | string, element: T, fn: Function): boolean;
+declare function addListenerHandler<T extends ListenerExtension>(event: symbol | string, element: T, fn: (...args: never[]) => unknown): boolean;
 
 /**
  * Interface for Asset memory
@@ -1119,22 +1126,6 @@ interface SpriteBaseMemory extends SpriteOptions$1, CanvasBaseItemMemory, Listen
 interface SpriteMemory extends SpriteBaseMemory {
 }
 
-/**
- * The memory of the image. It uses for save the state of the image.
- */
-interface ImageSpriteMemory extends SpriteBaseMemory {
-    loadIsStarted: boolean;
-}
-
-/**
- * The memory of the video. It uses for save the state of the video.
- */
-interface VideoSpriteMemory extends ImageSpriteMemory {
-    loop: boolean;
-    paused: boolean;
-    currentTime: number;
-}
-
 /**
  * This class is a extension of the [PIXI.Sprite class](https://pixijs.com/8.x/examples/sprite/basic), it has the same properties and methods,
  * but it has the ability to be saved and loaded by the Pixi’VN library.
@@ -1155,7 +1146,7 @@ interface VideoSpriteMemory extends ImageSpriteMemory {
  * ```
  */
 declare class Sprite<Memory extends SpriteOptions$1 & CanvasBaseItemMemory = SpriteMemory> extends _drincs_pixi_vn_pixi_js__default.Sprite implements CanvasBaseItem<Memory | SpriteMemory>, ListenerExtension, AdditionalPositionsExtension {
-    constructor(options?: SpriteOptions | Omit<Texture$1, "on">);
+    constructor(options?: SpriteOptions | Texture$1);
     readonly pixivnId: string;
     get memory(): Memory | SpriteMemory;
     setMemory(value: Memory | SpriteMemory): Promise<void>;
@@ -1210,6 +1201,13 @@ declare class Sprite<Memory extends SpriteOptions$1 & CanvasBaseItemMemory = Spr
     set y(value: number);
 }
 
+/**
+ * The memory of the image. It uses for save the state of the image.
+ */
+interface ImageSpriteMemory extends SpriteBaseMemory {
+    loadIsStarted: boolean;
+}
+
 /**
  * This class is a extension of the {@link Sprite} class, it has the same properties and methods,
  * but it has some features that make texture management easier.
@@ -1258,6 +1256,15 @@ declare class ImageSprite<Memory extends ImageSpriteMemory = ImageSpriteMemory>
     get haveEmptyTexture(): boolean;
 }
 
+/**
+ * The memory of the video. It uses for save the state of the video.
+ */
+interface VideoSpriteMemory extends ImageSpriteMemory {
+    loop: boolean;
+    paused: boolean;
+    currentTime: number;
+}
+
 /**
  * This class is a extension of the {@link ImageSprite} class, it has the same properties and methods,
  * but it has some features that make video management easier.
@@ -1332,15 +1339,6 @@ interface ContainerMemory<C extends ContainerChild = ContainerChild> extends Con
     elements: CanvasBaseItemMemory[];
 }
 
-/**
- * Interface for the canvas container memory
- */
-interface ImageContainerMemory extends ContainerMemory<ImageSprite> {
-    elements: ImageSpriteMemory[];
-    anchor?: PointData;
-    loadIsStarted: boolean;
-}
-
 /**
  * This class is a extension of the [PIXI.Container class](https://pixijs.com/8.x/examples/basic/container), it has the same properties and methods,
  * but it has the ability to be saved and loaded by the Pixi’VN library.
@@ -1421,6 +1419,15 @@ declare class Container<C extends ContainerChild = ContainerChild, Memory extend
     set y(value: number);
 }
 
+/**
+ * Interface for the canvas container memory
+ */
+interface ImageContainerMemory extends ContainerMemory<ImageSprite> {
+    elements: ImageSpriteMemory[];
+    anchor?: PointData;
+    loadIsStarted: boolean;
+}
+
 /**
  * This class is a extension of the {@link Container}, it has the same properties and methods,
  * but this container is composed only of {@link ImageSprite} and introduces the {@link load} functionality
@@ -1496,7 +1503,7 @@ declare class CanvasManagerStatic {
      * @param id it is the id of the canvas element.
      */
     private static addCanvasIntoHTMLElement;
-    static addHtmlLayer(id: string, element: HTMLElement, style?: Pick<CSSStyleDeclaration, "position" | "pointerEvents">): HTMLDivElement;
+    static addHtmlLayer(id: string, element: HTMLElement, style?: Partial<Pick<CSSStyleDeclaration, "position" | "pointerEvents" | "userSelect">>): HTMLDivElement;
     static removeHtmlLayer(id: string): void;
     static getHtmlLayer(id: string): HTMLElement | undefined;
     /**
@@ -1511,18 +1518,15 @@ declare class CanvasManagerStatic {
     static get currentTickersWithoutCreatedBySteps(): {
         [k: string]: TickerHistory<any>;
     };
-    static _currentTickers: {
-        [id: string]: TickerInfo<any>;
-    };
-    static _currentTickersSequence: {
+    static readonly _currentTickers: Map<string, TickerInfo<any>>;
+    static readonly _currentTickersSequence: Map<string, Map<string, TickersSequence>>;
+    static get currentTickersSequence(): {
         [alias: string]: {
             [tickerId: string]: TickersSequence;
         };
     };
-    static _currentTickersTimeouts: {
-        [timeout: string]: TickerTimeoutHistory;
-    };
-    static _tickersToCompleteOnStepEnd: {
+    static readonly _currentTickersTimeouts: Map<string, TickerTimeoutHistory>;
+    static readonly _tickersToCompleteOnStepEnd: {
         tikersIds: {
             id: string;
         }[];
@@ -1697,6 +1701,7 @@ declare namespace RegisteredCanvasComponents {
     function keys(): string[];
 }
 
+type SerializableEventHandler = (...args: never[]) => unknown;
 /**
  * Is a decorator that register a event in the game.
  * Is a required decorator for use the event in the game.
@@ -1715,25 +1720,25 @@ declare namespace RegisteredCanvasComponents {
  * @param name is th identifier of the event, by default is the name of the class
  * @returns
  */
-declare function eventDecorator(name?: string): (target: Object, propertyKey: string | symbol, descriptor: PropertyDescriptor) => void;
+declare function eventDecorator(name?: string): (_target: object, propertyKey: string | symbol, descriptor: PropertyDescriptor) => void;
 declare namespace RegisteredEvents {
     /**
      * Register a event in the game.
      * @param fn The class of the event.
      * @param name Name of the event, by default it will use the class name. If the name is already registered, it will show a warning
      */
-    function add(fn: Function, name: string): void;
+    function add(fn: SerializableEventHandler, name: string): void;
     /**
      * Get a event by the id.
      * @param canvasId The id of the event.
      * @returns The event type.
      */
-    function get(name: string): Function | undefined;
+    function get(name: string): SerializableEventHandler | undefined;
     /**
      * Get a list of all events registered.
      * @returns An array of events.
      */
-    function values(): Function[];
+    function values(): SerializableEventHandler[];
     /**
      * Check if a event is registered.
      * @param id The id of the event.

package/dist/canvas.d.ts

@@ -21,7 +21,9 @@ type AnimationOptions = AnimationOptionsCommon & Omit<CommonTickerProps, "startO
 
 type KeyframesType<T> = ObjectTarget<T> & MotionComponentExtension;
 type SequenceOptions = SequenceOptions$1 & Omit<CommonTickerProps, "startOnlyIfHaveTexture">;
-type ObjectSegment<O extends CanvasBaseInterface<any>> = [ObjectTarget<O> & MotionComponentExtension];
+type ObjectSegment<O extends CanvasBaseInterface<any>> = [
+    ObjectTarget<O> & MotionComponentExtension
+];
 type ObjectSegmentWithTransition<O extends CanvasBaseInterface<any>> = [
     ObjectTarget<O> & MotionComponentExtension,
     AnimationOptions & At
@@ -641,17 +643,11 @@ interface CanvasManagerInterface {
     /**
      * Currently tickers that are running.
      */
-    readonly currentTickers: {
-        [id: string]: TickerInfo<any>;
-    };
+    readonly currentTickers: Map<string, TickerInfo<any>>;
     /**
      * The steps of the tickers
      */
-    readonly currentTickersSteps: {
-        [alias: string]: {
-            [tickerId: string]: TickersSequence;
-        };
-    };
+    readonly currentTickersSteps: Map<string, Map<string, TickersSequence>>;
     /**
      * Find a ticker by its id.
      * @param tickerId The id of the ticker.
@@ -757,6 +753,17 @@ interface CanvasManagerInterface {
      * @returns If the ticker is paused.
      */
     isTickerPaused(alias: string, tickerId?: string): boolean;
+    /**
+     * Pause the rendering of gameLayer and pause currently running tickers.
+     * Use {@link resume} to restore rendering and resume only
+     * the tickers paused by this method.
+     */
+    pause(): void;
+    /**
+     * Resume the rendering of gameLayer and resume tickers that were paused by
+     * {@link pause}.
+     */
+    resume(): void;
     /**
      * Add a ticker that must be completed before the next step.
      * This method is used for example into a transition between scenes.
@@ -842,7 +849,7 @@ interface CanvasManagerInterface {
      * Add a HTML layer to the canvas.
      * @param id The id of the layer.
      * @param element The html element to be added.
-     * @param style The style of the layer. @default { position: "absolute", pointerEvents: "none" }.
+     * @param style The style of the layer. @default { position: "absolute", pointerEvents: "none", userSelect: "none" }.
      * @example
      * ```tsx
      * const root = document.getElementById('root')
@@ -859,7 +866,7 @@ interface CanvasManagerInterface {
      * )
      * ```
      */
-    addHtmlLayer(id: string, element: HTMLElement, style?: Pick<CSSStyleDeclaration, "position" | "pointerEvents">): HTMLDivElement;
+    addHtmlLayer(id: string, element: HTMLElement, style?: Partial<Pick<CSSStyleDeclaration, "position" | "pointerEvents" | "userSelect">>): HTMLDivElement;
     /**
      * Get a HTML layer from the canvas.
      * @param id The id of the layer to be removed.
@@ -1096,7 +1103,7 @@ interface ListenerExtension {
     on: Container$1["on"];
     readonly onEventsHandlers: OnEventsHandlers;
 }
-declare function addListenerHandler<T extends ListenerExtension>(event: symbol | string, element: T, fn: Function): boolean;
+declare function addListenerHandler<T extends ListenerExtension>(event: symbol | string, element: T, fn: (...args: never[]) => unknown): boolean;
 
 /**
  * Interface for Asset memory
@@ -1119,22 +1126,6 @@ interface SpriteBaseMemory extends SpriteOptions$1, CanvasBaseItemMemory, Listen
 interface SpriteMemory extends SpriteBaseMemory {
 }
 
-/**
- * The memory of the image. It uses for save the state of the image.
- */
-interface ImageSpriteMemory extends SpriteBaseMemory {
-    loadIsStarted: boolean;
-}
-
-/**
- * The memory of the video. It uses for save the state of the video.
- */
-interface VideoSpriteMemory extends ImageSpriteMemory {
-    loop: boolean;
-    paused: boolean;
-    currentTime: number;
-}
-
 /**
  * This class is a extension of the [PIXI.Sprite class](https://pixijs.com/8.x/examples/sprite/basic), it has the same properties and methods,
  * but it has the ability to be saved and loaded by the Pixi’VN library.
@@ -1155,7 +1146,7 @@ interface VideoSpriteMemory extends ImageSpriteMemory {
  * ```
  */
 declare class Sprite<Memory extends SpriteOptions$1 & CanvasBaseItemMemory = SpriteMemory> extends _drincs_pixi_vn_pixi_js__default.Sprite implements CanvasBaseItem<Memory | SpriteMemory>, ListenerExtension, AdditionalPositionsExtension {
-    constructor(options?: SpriteOptions | Omit<Texture$1, "on">);
+    constructor(options?: SpriteOptions | Texture$1);
     readonly pixivnId: string;
     get memory(): Memory | SpriteMemory;
     setMemory(value: Memory | SpriteMemory): Promise<void>;
@@ -1210,6 +1201,13 @@ declare class Sprite<Memory extends SpriteOptions$1 & CanvasBaseItemMemory = Spr
     set y(value: number);
 }
 
+/**
+ * The memory of the image. It uses for save the state of the image.
+ */
+interface ImageSpriteMemory extends SpriteBaseMemory {
+    loadIsStarted: boolean;
+}
+
 /**
  * This class is a extension of the {@link Sprite} class, it has the same properties and methods,
  * but it has some features that make texture management easier.
@@ -1258,6 +1256,15 @@ declare class ImageSprite<Memory extends ImageSpriteMemory = ImageSpriteMemory>
     get haveEmptyTexture(): boolean;
 }
 
+/**
+ * The memory of the video. It uses for save the state of the video.
+ */
+interface VideoSpriteMemory extends ImageSpriteMemory {
+    loop: boolean;
+    paused: boolean;
+    currentTime: number;
+}
+
 /**
  * This class is a extension of the {@link ImageSprite} class, it has the same properties and methods,
  * but it has some features that make video management easier.
@@ -1332,15 +1339,6 @@ interface ContainerMemory<C extends ContainerChild = ContainerChild> extends Con
     elements: CanvasBaseItemMemory[];
 }
 
-/**
- * Interface for the canvas container memory
- */
-interface ImageContainerMemory extends ContainerMemory<ImageSprite> {
-    elements: ImageSpriteMemory[];
-    anchor?: PointData;
-    loadIsStarted: boolean;
-}
-
 /**
  * This class is a extension of the [PIXI.Container class](https://pixijs.com/8.x/examples/basic/container), it has the same properties and methods,
  * but it has the ability to be saved and loaded by the Pixi’VN library.
@@ -1421,6 +1419,15 @@ declare class Container<C extends ContainerChild = ContainerChild, Memory extend
     set y(value: number);
 }
 
+/**
+ * Interface for the canvas container memory
+ */
+interface ImageContainerMemory extends ContainerMemory<ImageSprite> {
+    elements: ImageSpriteMemory[];
+    anchor?: PointData;
+    loadIsStarted: boolean;
+}
+
 /**
  * This class is a extension of the {@link Container}, it has the same properties and methods,
  * but this container is composed only of {@link ImageSprite} and introduces the {@link load} functionality
@@ -1496,7 +1503,7 @@ declare class CanvasManagerStatic {
      * @param id it is the id of the canvas element.
      */
     private static addCanvasIntoHTMLElement;
-    static addHtmlLayer(id: string, element: HTMLElement, style?: Pick<CSSStyleDeclaration, "position" | "pointerEvents">): HTMLDivElement;
+    static addHtmlLayer(id: string, element: HTMLElement, style?: Partial<Pick<CSSStyleDeclaration, "position" | "pointerEvents" | "userSelect">>): HTMLDivElement;
     static removeHtmlLayer(id: string): void;
     static getHtmlLayer(id: string): HTMLElement | undefined;
     /**
@@ -1511,18 +1518,15 @@ declare class CanvasManagerStatic {
     static get currentTickersWithoutCreatedBySteps(): {
         [k: string]: TickerHistory<any>;
     };
-    static _currentTickers: {
-        [id: string]: TickerInfo<any>;
-    };
-    static _currentTickersSequence: {
+    static readonly _currentTickers: Map<string, TickerInfo<any>>;
+    static readonly _currentTickersSequence: Map<string, Map<string, TickersSequence>>;
+    static get currentTickersSequence(): {
         [alias: string]: {
             [tickerId: string]: TickersSequence;
         };
     };
-    static _currentTickersTimeouts: {
-        [timeout: string]: TickerTimeoutHistory;
-    };
-    static _tickersToCompleteOnStepEnd: {
+    static readonly _currentTickersTimeouts: Map<string, TickerTimeoutHistory>;
+    static readonly _tickersToCompleteOnStepEnd: {
         tikersIds: {
             id: string;
         }[];
@@ -1697,6 +1701,7 @@ declare namespace RegisteredCanvasComponents {
     function keys(): string[];
 }
 
+type SerializableEventHandler = (...args: never[]) => unknown;
 /**
  * Is a decorator that register a event in the game.
  * Is a required decorator for use the event in the game.
@@ -1715,25 +1720,25 @@ declare namespace RegisteredCanvasComponents {
  * @param name is th identifier of the event, by default is the name of the class
  * @returns
  */
-declare function eventDecorator(name?: string): (target: Object, propertyKey: string | symbol, descriptor: PropertyDescriptor) => void;
+declare function eventDecorator(name?: string): (_target: object, propertyKey: string | symbol, descriptor: PropertyDescriptor) => void;
 declare namespace RegisteredEvents {
     /**
      * Register a event in the game.
      * @param fn The class of the event.
      * @param name Name of the event, by default it will use the class name. If the name is already registered, it will show a warning
      */
-    function add(fn: Function, name: string): void;
+    function add(fn: SerializableEventHandler, name: string): void;
     /**
      * Get a event by the id.
      * @param canvasId The id of the event.
      * @returns The event type.
      */
-    function get(name: string): Function | undefined;
+    function get(name: string): SerializableEventHandler | undefined;
     /**
      * Get a list of all events registered.
      * @returns An array of events.
      */
-    function values(): Function[];
+    function values(): SerializableEventHandler[];
     /**
      * Check if a event is registered.
      * @param id The id of the event.