@drincs/pixi-vn 1.3.13 → 1.3.15

package/dist/StoredClassModel-CjdhvNgB.d.cts

@@ -1,56 +0,0 @@
-/**
- * StoredClassModel is a abstract class that contains the methods to store a class in the game.
- * I suggest you extend this class to create your own stored class.
- * @example
- * ```typescript
- * export class CharacterBaseModel extends StoredClassModel implements CharacterBaseModelProps {
- *     constructor(id: string, props: CharacterBaseModelProps) {
- *         super("___character___", id)
- *         this.defaultName = props.name
- *         this.defaultSurname = props.surname
- *     }
- *     private defaultName: string = ""
- *     get name(): string {
- *         return this.getStorageProperty<string>("name") || this.defaultName
- *     }
- *     set name(value: string) {
- *         this.setStorageProperty<string>("name", value)
- *     }
- *     private defaultSurname?: string
- *     get surname(): string | undefined {
- *         return this.getStorageProperty<string>("surname") || this.defaultSurname
- *     }
- *     set surname(value: string | undefined) {
- *         this.setStorageProperty<string>("surname", value)
- *     }
- * }
- * ```
- */
-declare class StoredClassModel {
-    /**
-     * @param categoryId The id of the category. For example if you are storing a character class, you can use "characters" as categoryId. so all instances of the character class will be stored in the "characters" category.
-     * @param id The id of instance of the class. This id must be unique for the category.
-     */
-    constructor(categoryId: string, id: string);
-    private _id;
-    /**
-     * Is id of the stored class. is unique for this class.
-     */
-    get id(): string;
-    private categoryId;
-    /**
-     * Update a property in the storage.
-     * @param propertyName The name of the property to set.
-     * @param value The value to set. If is undefined, the property will be removed from the storage.
-     */
-    protected setStorageProperty<T>(propertyName: string, value: T | undefined): void;
-    /**
-     * Get a property from the storage.
-     * @param propertyName The name of the property to get.
-     * @param idToUse The id of the instance to get the property. @default this.id
-     * @returns The value of the property. If the property is not found, returns undefined.
-     */
-    protected getStorageProperty<T>(propertyName: string, idToUse?: string): T | undefined;
-}
-
-export { StoredClassModel as S };

package/dist/StoredClassModel-CjdhvNgB.d.ts

@@ -1,56 +0,0 @@
-/**
- * StoredClassModel is a abstract class that contains the methods to store a class in the game.
- * I suggest you extend this class to create your own stored class.
- * @example
- * ```typescript
- * export class CharacterBaseModel extends StoredClassModel implements CharacterBaseModelProps {
- *     constructor(id: string, props: CharacterBaseModelProps) {
- *         super("___character___", id)
- *         this.defaultName = props.name
- *         this.defaultSurname = props.surname
- *     }
- *     private defaultName: string = ""
- *     get name(): string {
- *         return this.getStorageProperty<string>("name") || this.defaultName
- *     }
- *     set name(value: string) {
- *         this.setStorageProperty<string>("name", value)
- *     }
- *     private defaultSurname?: string
- *     get surname(): string | undefined {
- *         return this.getStorageProperty<string>("surname") || this.defaultSurname
- *     }
- *     set surname(value: string | undefined) {
- *         this.setStorageProperty<string>("surname", value)
- *     }
- * }
- * ```
- */
-declare class StoredClassModel {
-    /**
-     * @param categoryId The id of the category. For example if you are storing a character class, you can use "characters" as categoryId. so all instances of the character class will be stored in the "characters" category.
-     * @param id The id of instance of the class. This id must be unique for the category.
-     */
-    constructor(categoryId: string, id: string);
-    private _id;
-    /**
-     * Is id of the stored class. is unique for this class.
-     */
-    get id(): string;
-    private categoryId;
-    /**
-     * Update a property in the storage.
-     * @param propertyName The name of the property to set.
-     * @param value The value to set. If is undefined, the property will be removed from the storage.
-     */
-    protected setStorageProperty<T>(propertyName: string, value: T | undefined): void;
-    /**
-     * Get a property from the storage.
-     * @param propertyName The name of the property to get.
-     * @param idToUse The id of the instance to get the property. @default this.id
-     * @returns The value of the property. If the property is not found, returns undefined.
-     */
-    protected getStorageProperty<T>(propertyName: string, idToUse?: string): T | undefined;
-}
-
-export { StoredClassModel as S };

package/dist/TickersSequence-Cf1Vcu22.d.cts

@@ -1,133 +0,0 @@
-import { UPDATE_PRIORITY } from 'pixi.js';
-
-/**
- * is a string that represents a ticker id.
- * It is used to {@link canvas.tickers} to get the ticker class.
- */
-type TickerIdType = string;
-
-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 id of the ticker. This variable is used in the system to get the ticker by id, {@link RegisteredTickers.getInstance}
-     */
-    id: TickerIdType;
-    /**
-     * 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.
-     * @param id The id of the ticker.
-     */
-    start: (id: string) => 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: TickerIdType;
-    args: TArgs;
-    /**
-     * The aliases of the canvas elements that are connected to this ticker
-     */
-    canvasElementAliases: string[];
-    priority?: UPDATE_PRIORITY;
-    duration?: number;
-    paused?: boolean;
-}
-
-type PauseType = {
-    /**
-     * The type of the value
-     */
-    type: "pause";
-    /**
-     * Duration in seconds
-     */
-    duration: number;
-};
-
-type RepeatType = "repeat";
-
-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> | RepeatType | PauseType)[];
-}
-
-export type { PauseType as P, RepeatType as R, Ticker as T, TickerArgs as a, TickerHistory as b, TickerInfo as c, TickersSequence as d, TickerIdType as e };

package/dist/TickersSequence-Cf1Vcu22.d.ts

@@ -1,133 +0,0 @@
-import { UPDATE_PRIORITY } from 'pixi.js';
-
-/**
- * is a string that represents a ticker id.
- * It is used to {@link canvas.tickers} to get the ticker class.
- */
-type TickerIdType = string;
-
-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 id of the ticker. This variable is used in the system to get the ticker by id, {@link RegisteredTickers.getInstance}
-     */
-    id: TickerIdType;
-    /**
-     * 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.
-     * @param id The id of the ticker.
-     */
-    start: (id: string) => 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: TickerIdType;
-    args: TArgs;
-    /**
-     * The aliases of the canvas elements that are connected to this ticker
-     */
-    canvasElementAliases: string[];
-    priority?: UPDATE_PRIORITY;
-    duration?: number;
-    paused?: boolean;
-}
-
-type PauseType = {
-    /**
-     * The type of the value
-     */
-    type: "pause";
-    /**
-     * Duration in seconds
-     */
-    duration: number;
-};
-
-type RepeatType = "repeat";
-
-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> | RepeatType | PauseType)[];
-}
-
-export type { PauseType as P, RepeatType as R, Ticker as T, TickerArgs as a, TickerHistory as b, TickerInfo as c, TickersSequence as d, TickerIdType as e };