@drincs/pixi-vn 1.9.3 → 1.9.5

package/README.md

@@ -1,6 +1,6 @@
 # Pixi’VN - PixiJS Game Engine
 
-![pixi-vn-cover](https://github.com/user-attachments/assets/6a4951d3-459f-4f8d-ae3d-1342a55570e9)
+![pixi-vn-cover](https://github.com/user-attachments/assets/9bd54406-f41a-4d2c-959c-96a773a6103c)
 
 <p align="center">
   <a href="https://www.npmjs.com/package/@drincs/pixi-vn" rel="noopener noreferrer nofollow"><img src="https://img.shields.io/npm/v/@drincs/pixi-vn?label=version" alt="npm version"></a>

package/dist/{ContainerMemory-BpDgacyr.d.cts → ContainerMemory-DNqSVzLY.d.cts}

@@ -1,118 +1,6 @@
-import { UPDATE_PRIORITY, PointData, Container, ContainerOptions } from '@drincs/pixi-vn/pixi.js';
-
-interface TickerArgs {
-}
-
-interface Ticker<TArgs extends TickerArgs> {
-    /**
-     * Arguments to pass to the ticker
-     */
-    args: TArgs;
-    /**
-     * Duration in seconds to run the ticker
-     */
-    duration?: number;
-    /**
-     * Priority of the ticker
-     */
-    priority?: UPDATE_PRIORITY;
-    /**
-     * Get the alias of the ticker class. This variable is used in the system to get the ticker class by id, {@link RegisteredTickers.getInstance}
-     */
-    readonly alias: string;
-    /**
-     * The id of the ticker. Must be unique for each ticker instance.
-     */
-    readonly id: string;
-    /**
-     * The aliases of the canvas elements that are connected to this ticker
-     */
-    canvasElementAliases: string[];
-    /**
-     * Completes the animation and applies the final state.
-     */
-    complete: (options?: {
-        ignoreTickerSteps?: boolean;
-    }) => Promise<void> | void;
-    /**
-     * Stops the animation at its current state, and prevents it from resuming when the animation is played again.
-     */
-    stop: () => void;
-    /**
-     * Starts the ticker. This will start the ticker and begin the animation.
-     */
-    start: () => void;
-    /**
-     * Pauses the animation.
-     */
-    pause: () => void;
-    /**
-     * Plays the animation.
-     */
-    play: () => void;
-    /**
-     * Checks if the ticker is paused.
-     * @returns true if the ticker is paused, false otherwise.
-     */
-    readonly paused: boolean;
-}
-
-/**
- * TickerHistory is a class that contains the name of a class and the arguments that were used to create it.
- */
-interface TickerInfo<TArgs extends TickerArgs> {
-    /**
-     * If this ticker was created by steps
-     */
-    createdByTicketSteps?: {
-        canvasElementAlias: string;
-        id: string;
-    };
-    ticker: Ticker<TArgs>;
-}
-interface TickerHistory<TArgs extends TickerArgs> {
-    id: string;
-    args: TArgs;
-    /**
-     * The aliases of the canvas elements that are connected to this ticker
-     */
-    canvasElementAliases: string[];
-    priority?: UPDATE_PRIORITY;
-    duration?: number;
-    paused?: boolean;
-}
-
-interface TickersStep<TArgs extends TickerArgs> {
-    /**
-     * Ticker class name
-     */
-    ticker: string;
-    /**
-     * Duration in seconds. If is undefined, the step will end only when the animation is finished.
-     */
-    duration?: number;
-    /**
-     * Arguments to pass to the ticker
-     */
-    args: TArgs;
-    /**
-     * Priority of the ticker
-     */
-    priority?: UPDATE_PRIORITY;
-}
-/**
- * The steps of the tickers
- */
-interface TickersSequence {
-    /**
-     * The step number
-     */
-    currentStepNumber: number;
-    /**
-     * The steps of the tickers
-     */
-    steps: TickersStep<any>[];
-}
+import { TickerHistory, TickersSequence } from '@drincs/pixi-vn/tickers';
+import { PointData, Container, ContainerOptions } from '@drincs/pixi-vn/pixi.js';
+import { FilterMemory } from '@drincs/pixi-vn/filters';
 
 /**
  * This class is used to create a canvas element to add into a Pixi Application.
@@ -173,6 +61,14 @@ interface CanvasBaseItemMemory {
     parentLabel?: string;
     label?: string;
     zIndex?: number;
+    /**
+     * The filters applied to this element, if any - kept separate from the real, live `Filter[]`
+     * `.filters` (inherited from the PixiJS options types this memory interface also extends) since a
+     * memory object is serialized data, not construction options. Only filters registered with
+     * {@link filterDecorator}/{@link RegisteredFilters} can be saved - any other `Filter` instance found
+     * on `.filters` is skipped (with a warning) when exporting.
+     */
+    pixivnFilters?: FilterMemory[];
 }
 
 /**
@@ -376,4 +272,4 @@ interface ContainerMemory<C extends ContainerChild = ContainerChild> extends Con
     elements: CanvasBaseItemMemory[];
 }
 
-export { type AdditionalPositionsExtensionProps as A, type CanvasBaseItemMemory as C, type ListenerExtensionMemory as L, type OnEventsHandlers as O, type TickerArgs as T, type Ticker as a, CanvasBaseItem as b, type TickerInfo as c, type TickersSequence as d, type CanvasGameState as e, type ContainerChild as f, type ListenerExtension as g, type AdditionalPositionsExtension as h, type ContainerMemory as i, type TickerHistory as j, addListenerHandler as k, analizePositionsExtensionProps as l };
+export { type AdditionalPositionsExtensionProps as A, type CanvasBaseItemMemory as C, type ListenerExtensionMemory as L, type OnEventsHandlers as O, CanvasBaseItem as a, type CanvasGameState as b, type ContainerChild as c, type ListenerExtension as d, type AdditionalPositionsExtension as e, type ContainerMemory as f, addListenerHandler as g, analizePositionsExtensionProps as h };

package/dist/{ContainerMemory-BpDgacyr.d.ts → ContainerMemory-DNqSVzLY.d.ts}

@@ -1,118 +1,6 @@
-import { UPDATE_PRIORITY, PointData, Container, ContainerOptions } from '@drincs/pixi-vn/pixi.js';
-
-interface TickerArgs {
-}
-
-interface Ticker<TArgs extends TickerArgs> {
-    /**
-     * Arguments to pass to the ticker
-     */
-    args: TArgs;
-    /**
-     * Duration in seconds to run the ticker
-     */
-    duration?: number;
-    /**
-     * Priority of the ticker
-     */
-    priority?: UPDATE_PRIORITY;
-    /**
-     * Get the alias of the ticker class. This variable is used in the system to get the ticker class by id, {@link RegisteredTickers.getInstance}
-     */
-    readonly alias: string;
-    /**
-     * The id of the ticker. Must be unique for each ticker instance.
-     */
-    readonly id: string;
-    /**
-     * The aliases of the canvas elements that are connected to this ticker
-     */
-    canvasElementAliases: string[];
-    /**
-     * Completes the animation and applies the final state.
-     */
-    complete: (options?: {
-        ignoreTickerSteps?: boolean;
-    }) => Promise<void> | void;
-    /**
-     * Stops the animation at its current state, and prevents it from resuming when the animation is played again.
-     */
-    stop: () => void;
-    /**
-     * Starts the ticker. This will start the ticker and begin the animation.
-     */
-    start: () => void;
-    /**
-     * Pauses the animation.
-     */
-    pause: () => void;
-    /**
-     * Plays the animation.
-     */
-    play: () => void;
-    /**
-     * Checks if the ticker is paused.
-     * @returns true if the ticker is paused, false otherwise.
-     */
-    readonly paused: boolean;
-}
-
-/**
- * TickerHistory is a class that contains the name of a class and the arguments that were used to create it.
- */
-interface TickerInfo<TArgs extends TickerArgs> {
-    /**
-     * If this ticker was created by steps
-     */
-    createdByTicketSteps?: {
-        canvasElementAlias: string;
-        id: string;
-    };
-    ticker: Ticker<TArgs>;
-}
-interface TickerHistory<TArgs extends TickerArgs> {
-    id: string;
-    args: TArgs;
-    /**
-     * The aliases of the canvas elements that are connected to this ticker
-     */
-    canvasElementAliases: string[];
-    priority?: UPDATE_PRIORITY;
-    duration?: number;
-    paused?: boolean;
-}
-
-interface TickersStep<TArgs extends TickerArgs> {
-    /**
-     * Ticker class name
-     */
-    ticker: string;
-    /**
-     * Duration in seconds. If is undefined, the step will end only when the animation is finished.
-     */
-    duration?: number;
-    /**
-     * Arguments to pass to the ticker
-     */
-    args: TArgs;
-    /**
-     * Priority of the ticker
-     */
-    priority?: UPDATE_PRIORITY;
-}
-/**
- * The steps of the tickers
- */
-interface TickersSequence {
-    /**
-     * The step number
-     */
-    currentStepNumber: number;
-    /**
-     * The steps of the tickers
-     */
-    steps: TickersStep<any>[];
-}
+import { TickerHistory, TickersSequence } from '@drincs/pixi-vn/tickers';
+import { PointData, Container, ContainerOptions } from '@drincs/pixi-vn/pixi.js';
+import { FilterMemory } from '@drincs/pixi-vn/filters';
 
 /**
  * This class is used to create a canvas element to add into a Pixi Application.
@@ -173,6 +61,14 @@ interface CanvasBaseItemMemory {
     parentLabel?: string;
     label?: string;
     zIndex?: number;
+    /**
+     * The filters applied to this element, if any - kept separate from the real, live `Filter[]`
+     * `.filters` (inherited from the PixiJS options types this memory interface also extends) since a
+     * memory object is serialized data, not construction options. Only filters registered with
+     * {@link filterDecorator}/{@link RegisteredFilters} can be saved - any other `Filter` instance found
+     * on `.filters` is skipped (with a warning) when exporting.
+     */
+    pixivnFilters?: FilterMemory[];
 }
 
 /**
@@ -376,4 +272,4 @@ interface ContainerMemory<C extends ContainerChild = ContainerChild> extends Con
     elements: CanvasBaseItemMemory[];
 }
 
-export { type AdditionalPositionsExtensionProps as A, type CanvasBaseItemMemory as C, type ListenerExtensionMemory as L, type OnEventsHandlers as O, type TickerArgs as T, type Ticker as a, CanvasBaseItem as b, type TickerInfo as c, type TickersSequence as d, type CanvasGameState as e, type ContainerChild as f, type ListenerExtension as g, type AdditionalPositionsExtension as h, type ContainerMemory as i, type TickerHistory as j, addListenerHandler as k, analizePositionsExtensionProps as l };
+export { type AdditionalPositionsExtensionProps as A, type CanvasBaseItemMemory as C, type ListenerExtensionMemory as L, type OnEventsHandlers as O, CanvasBaseItem as a, type CanvasGameState as b, type ContainerChild as c, type ListenerExtension as d, type AdditionalPositionsExtension as e, type ContainerMemory as f, addListenerHandler as g, analizePositionsExtensionProps as h };