@drincs/pixi-vn 0.1.4 → 0.2.0

package/README.md

@@ -14,7 +14,7 @@ This allows the use of systems such as React, Vue, Angular, etc. to create much
 ### Installation
 
 ```bash
-npm install pixi-vn
+npm install @drincs/pixi-vn
 ```
 
 ### Usage

package/dist/index.d.mts

@@ -35,7 +35,7 @@ declare class CanvasEvent<C> {
  * ```typescript
  * export class CharacterModelBase extends StoredClassModel implements ICharacterModelBase {
  *     constructor(id: string, props: ICharacterModelBase) {
- *         super(id)
+ *         super("___character___", id)
  *         this.defaultName = props.name
  *         this.defaultSurname = props.surname
  *     }
@@ -44,24 +44,42 @@ declare class CanvasEvent<C> {
  *         return this.getStorageProperty<string>("name") || this.defaultName
  *     }
  *     set name(value: string) {
- *         this.updateStorageProperty<string>("name", value)
+ *         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.updateStorageProperty<string>("surname", value)
+ *         this.setStorageProperty<string>("surname", value)
  *     }
  * }
  * ```
  */
 declare abstract class StoredClassModel {
-    id: string;
-    constructor(id: string);
-    private get nameClass();
-    updateStorageProperty<T>(key: string, value: T | undefined): void;
-    getStorageProperty<T>(key: string): T | undefined;
+    /**
+     * @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.
+     */
+    setStorageProperty<T>(propertyName: string, value: T | undefined): void;
+    /**
+     * Get a property from the storage.
+     * @param propertyName The name of the property to get.
+     * @returns The value of the property. If the property is not found, returns undefined.
+     */
+    getStorageProperty<T>(propertyName: string): T | undefined;
 }
 
 interface ICharacterModelBase {
@@ -859,7 +877,7 @@ interface ExportedStep {
 }
 
 interface ISaveData {
-    version: string;
+    pixivn_version: string;
     stepData: ExportedStep;
     storageData: ExportedStorage;
     canvasData: ExportedCanvas;
@@ -961,6 +979,19 @@ declare function clearChoiceMenuOptions(): void;
  */
 declare function getDialogueHistory<T extends DialogueModelBase = DialogueModelBase>(): IDialogueHistory<T>[];
 
+/**
+ * Set a flag to true or false.
+ * @param name The name of the flag
+ * @param value The value of the flag.
+ */
+declare function setFlag(name: string, value: boolean): void;
+/**
+ * Get the value of a flag
+ * @param name The name of the flag
+ * @returns The value of the flag
+ */
+declare function getFlag(name: string): boolean;
+
 /**
  * Clear all game data. This function is used to reset the game.
  */
@@ -1091,13 +1122,18 @@ declare class GameStepManager {
     private static _openedLabels;
     static get openedLabels(): IOpenedLabel[];
     /**
-     * currentLabel is the current label that occurred during the progression of the steps.
+     * currentLabelId is the current label id that occurred during the progression of the steps.
      */
-    private static get currentLabel();
+    private static get currentLabelId();
     /**
-     * is the current step index of the current label that occurred during the progression of the steps.
+     * currentLabel is the current label that occurred during the progression of the steps.
      */
+    static get currentLabel(): Label | undefined;
     private static get currentLabelStepIndex();
+    /**
+     * currentLabelStep is the current step that occurred during the progression of the steps. It can used to determine the game end.
+     */
+    static get isLastGameStep(): boolean;
     /**
      * lastHistoryStep is the last history step that occurred during the progression of the steps.
      */
@@ -1190,6 +1226,10 @@ declare class GameStepManager {
      */
     static goBack(navigate: (path: string) => void, steps?: number): void;
     private static goBackInternal;
+    /**
+     * Return true if it is possible to go back.
+     */
+    static get canGoBack(): boolean;
     /**
      * Add a label to the history.
      */
@@ -1224,7 +1264,8 @@ declare class GameStorageManager {
         LAST_DIALOGUE_ADDED_IN_STEP_MEMORY_KEY: string;
         CURRENT_MENU_OPTIONS_MEMORY_KEY: string;
         LAST_MENU_OPTIONS_ADDED_IN_STEP_MEMORY_KEY: string;
-        CHARACTER_PREKEY: string;
+        CHARACTER_CATEGORY_KEY: string;
+        FLAGS_CATEGORY_KEY: string;
     };
     /**
      * Set a variable in the storage
@@ -1507,4 +1548,4 @@ declare class GameWindowManager {
     static import(data: object): void;
 }
 
-export { CanvasBase, CanvasContainer, CanvasEvent, type CanvasEventNamesType, CanvasImage, CanvasSprite, CanvasText, CharacterModelBase, ChoiceMenuOptionLabel, type ChoiceMenuOptionsType, DialogueModelBase, type ExportedCanvas, type ExportedStep, type ExportedStorage, GameStepManager, GameStorageManager, GameWindowManager, type ICanvasBaseMemory, type ICanvasContainerMemory, type ICanvasImageMemory, type ICanvasSpriteBaseMemory, type ICanvasSpriteMemory, type ICanvasTextMemory as ICanvasTextTextMemory, type IClassWithArgsHistory, type IClassWithArgsHistoryForExport, type IDialogueHistory, type IHistoryStep, type IHistoryStepData, type IOpenedLabel, type ISaveData, type ITextureMemory, type ITicker, type ITickersSteps, Label, LabelRunModeEnum, Pause, type PauseType, PauseValueType, Repeat, type RepeatType, type StepLabelType, type StorageElementType, StoredClassModel, TickerBase, TickerFadeAlpha, type TickerProgrationType, TickerRotate, addImage, canvasElementDecorator, clearAllGameDatas, clearChoiceMenuOptions, clearDialogue, eventDecorator, getCharacterById, getChoiceMenuOptions, getDialogue, getDialogueHistory, getSaveData, getSaveJson, getTexture, labelDecorator, loadSaveData, loadSaveJson, removeCanvasElement, saveCharacter, setChoiceMenuOptions, setDialogue, showCanvasImages, showImageWithDissolveTransition, tickerDecorator };
+export { CanvasBase, CanvasContainer, CanvasEvent, type CanvasEventNamesType, CanvasImage, CanvasSprite, CanvasText, CharacterModelBase, ChoiceMenuOptionLabel, type ChoiceMenuOptionsType, DialogueModelBase, type ExportedCanvas, type ExportedStep, type ExportedStorage, GameStepManager, GameStorageManager, GameWindowManager, type ICanvasBaseMemory, type ICanvasContainerMemory, type ICanvasImageMemory, type ICanvasSpriteBaseMemory, type ICanvasSpriteMemory, type ICanvasTextMemory as ICanvasTextTextMemory, type IClassWithArgsHistory, type IClassWithArgsHistoryForExport, type IDialogueHistory, type IHistoryStep, type IHistoryStepData, type IOpenedLabel, type ISaveData, type ITextureMemory, type ITicker, type ITickersSteps, Label, LabelRunModeEnum, Pause, type PauseType, PauseValueType, Repeat, type RepeatType, type StepLabelType, type StorageElementType, StoredClassModel, TickerBase, TickerFadeAlpha, type TickerProgrationType, TickerRotate, addImage, canvasElementDecorator, clearAllGameDatas, clearChoiceMenuOptions, clearDialogue, eventDecorator, getCharacterById, getChoiceMenuOptions, getDialogue, getDialogueHistory, getFlag, getSaveData, getSaveJson, getTexture, labelDecorator, loadSaveData, loadSaveJson, removeCanvasElement, saveCharacter, setChoiceMenuOptions, setDialogue, setFlag, showCanvasImages, showImageWithDissolveTransition, tickerDecorator };

package/dist/index.d.ts

@@ -35,7 +35,7 @@ declare class CanvasEvent<C> {
  * ```typescript
  * export class CharacterModelBase extends StoredClassModel implements ICharacterModelBase {
  *     constructor(id: string, props: ICharacterModelBase) {
- *         super(id)
+ *         super("___character___", id)
  *         this.defaultName = props.name
  *         this.defaultSurname = props.surname
  *     }
@@ -44,24 +44,42 @@ declare class CanvasEvent<C> {
  *         return this.getStorageProperty<string>("name") || this.defaultName
  *     }
  *     set name(value: string) {
- *         this.updateStorageProperty<string>("name", value)
+ *         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.updateStorageProperty<string>("surname", value)
+ *         this.setStorageProperty<string>("surname", value)
  *     }
  * }
  * ```
  */
 declare abstract class StoredClassModel {
-    id: string;
-    constructor(id: string);
-    private get nameClass();
-    updateStorageProperty<T>(key: string, value: T | undefined): void;
-    getStorageProperty<T>(key: string): T | undefined;
+    /**
+     * @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.
+     */
+    setStorageProperty<T>(propertyName: string, value: T | undefined): void;
+    /**
+     * Get a property from the storage.
+     * @param propertyName The name of the property to get.
+     * @returns The value of the property. If the property is not found, returns undefined.
+     */
+    getStorageProperty<T>(propertyName: string): T | undefined;
 }
 
 interface ICharacterModelBase {
@@ -859,7 +877,7 @@ interface ExportedStep {
 }
 
 interface ISaveData {
-    version: string;
+    pixivn_version: string;
     stepData: ExportedStep;
     storageData: ExportedStorage;
     canvasData: ExportedCanvas;
@@ -961,6 +979,19 @@ declare function clearChoiceMenuOptions(): void;
  */
 declare function getDialogueHistory<T extends DialogueModelBase = DialogueModelBase>(): IDialogueHistory<T>[];
 
+/**
+ * Set a flag to true or false.
+ * @param name The name of the flag
+ * @param value The value of the flag.
+ */
+declare function setFlag(name: string, value: boolean): void;
+/**
+ * Get the value of a flag
+ * @param name The name of the flag
+ * @returns The value of the flag
+ */
+declare function getFlag(name: string): boolean;
+
 /**
  * Clear all game data. This function is used to reset the game.
  */
@@ -1091,13 +1122,18 @@ declare class GameStepManager {
     private static _openedLabels;
     static get openedLabels(): IOpenedLabel[];
     /**
-     * currentLabel is the current label that occurred during the progression of the steps.
+     * currentLabelId is the current label id that occurred during the progression of the steps.
      */
-    private static get currentLabel();
+    private static get currentLabelId();
     /**
-     * is the current step index of the current label that occurred during the progression of the steps.
+     * currentLabel is the current label that occurred during the progression of the steps.
      */
+    static get currentLabel(): Label | undefined;
     private static get currentLabelStepIndex();
+    /**
+     * currentLabelStep is the current step that occurred during the progression of the steps. It can used to determine the game end.
+     */
+    static get isLastGameStep(): boolean;
     /**
      * lastHistoryStep is the last history step that occurred during the progression of the steps.
      */
@@ -1190,6 +1226,10 @@ declare class GameStepManager {
      */
     static goBack(navigate: (path: string) => void, steps?: number): void;
     private static goBackInternal;
+    /**
+     * Return true if it is possible to go back.
+     */
+    static get canGoBack(): boolean;
     /**
      * Add a label to the history.
      */
@@ -1224,7 +1264,8 @@ declare class GameStorageManager {
         LAST_DIALOGUE_ADDED_IN_STEP_MEMORY_KEY: string;
         CURRENT_MENU_OPTIONS_MEMORY_KEY: string;
         LAST_MENU_OPTIONS_ADDED_IN_STEP_MEMORY_KEY: string;
-        CHARACTER_PREKEY: string;
+        CHARACTER_CATEGORY_KEY: string;
+        FLAGS_CATEGORY_KEY: string;
     };
     /**
      * Set a variable in the storage
@@ -1507,4 +1548,4 @@ declare class GameWindowManager {
     static import(data: object): void;
 }
 
-export { CanvasBase, CanvasContainer, CanvasEvent, type CanvasEventNamesType, CanvasImage, CanvasSprite, CanvasText, CharacterModelBase, ChoiceMenuOptionLabel, type ChoiceMenuOptionsType, DialogueModelBase, type ExportedCanvas, type ExportedStep, type ExportedStorage, GameStepManager, GameStorageManager, GameWindowManager, type ICanvasBaseMemory, type ICanvasContainerMemory, type ICanvasImageMemory, type ICanvasSpriteBaseMemory, type ICanvasSpriteMemory, type ICanvasTextMemory as ICanvasTextTextMemory, type IClassWithArgsHistory, type IClassWithArgsHistoryForExport, type IDialogueHistory, type IHistoryStep, type IHistoryStepData, type IOpenedLabel, type ISaveData, type ITextureMemory, type ITicker, type ITickersSteps, Label, LabelRunModeEnum, Pause, type PauseType, PauseValueType, Repeat, type RepeatType, type StepLabelType, type StorageElementType, StoredClassModel, TickerBase, TickerFadeAlpha, type TickerProgrationType, TickerRotate, addImage, canvasElementDecorator, clearAllGameDatas, clearChoiceMenuOptions, clearDialogue, eventDecorator, getCharacterById, getChoiceMenuOptions, getDialogue, getDialogueHistory, getSaveData, getSaveJson, getTexture, labelDecorator, loadSaveData, loadSaveJson, removeCanvasElement, saveCharacter, setChoiceMenuOptions, setDialogue, showCanvasImages, showImageWithDissolveTransition, tickerDecorator };
+export { CanvasBase, CanvasContainer, CanvasEvent, type CanvasEventNamesType, CanvasImage, CanvasSprite, CanvasText, CharacterModelBase, ChoiceMenuOptionLabel, type ChoiceMenuOptionsType, DialogueModelBase, type ExportedCanvas, type ExportedStep, type ExportedStorage, GameStepManager, GameStorageManager, GameWindowManager, type ICanvasBaseMemory, type ICanvasContainerMemory, type ICanvasImageMemory, type ICanvasSpriteBaseMemory, type ICanvasSpriteMemory, type ICanvasTextMemory as ICanvasTextTextMemory, type IClassWithArgsHistory, type IClassWithArgsHistoryForExport, type IDialogueHistory, type IHistoryStep, type IHistoryStepData, type IOpenedLabel, type ISaveData, type ITextureMemory, type ITicker, type ITickersSteps, Label, LabelRunModeEnum, Pause, type PauseType, PauseValueType, Repeat, type RepeatType, type StepLabelType, type StorageElementType, StoredClassModel, TickerBase, TickerFadeAlpha, type TickerProgrationType, TickerRotate, addImage, canvasElementDecorator, clearAllGameDatas, clearChoiceMenuOptions, clearDialogue, eventDecorator, getCharacterById, getChoiceMenuOptions, getDialogue, getDialogueHistory, getFlag, getSaveData, getSaveJson, getTexture, labelDecorator, loadSaveData, loadSaveJson, removeCanvasElement, saveCharacter, setChoiceMenuOptions, setDialogue, setFlag, showCanvasImages, showImageWithDissolveTransition, tickerDecorator };