@drincs/pixi-vn 0.3.4 → 0.3.5

package/dist/index.d.mts

@@ -193,7 +193,18 @@ type StepHistoryDataType = string;
 /**
  * StepLabel is a function that will be executed as the game continues.
  */
-type StepLabelType = (() => void | Promise<void>);
+type StepLabelType = (() => StepLabelResultType | Promise<StepLabelResultType>);
+/**
+ * StepLabelResultType is the return type of the StepLabel function.
+ * It can be useful for returning to the information calling function to perform other operations that cannot be performed within the StepLabel.
+ */
+type StepLabelResultType = {
+    /**
+     * The new route to navigate to.
+     */
+    newRoute?: string;
+    [key: string]: any;
+} | void;
 
 /**
  * Label is a class that contains a list of steps, which will be performed as the game continues.
@@ -1239,15 +1250,18 @@ declare class GameStepManager {
     private static increaseCurrentStepIndex;
     /**
      * Execute the next step and add it to the history.
-     * @returns
+     * @returns StepLabelResultType or undefined.
      * @example
      * ```typescript
      *     function nextOnClick() {
      *     setLoading(true)
      *     GameStepManager.runNextStep()
-     *         .then(() => {
+     *         .then((result) => {
      *             setUpdate((p) => p + 1)
      *             setLoading(false)
+     *             if (result) {
+     *                 // your code
+     *             }
      *         })
      *         .catch((e) => {
      *             setLoading(false)
@@ -1256,34 +1270,56 @@ declare class GameStepManager {
      * }
      * ```
      */
-    static runNextStep(): Promise<void>;
+    static runNextStep(): Promise<StepLabelResultType>;
     /**
      * Execute the current step and add it to the history.
-     * @returns
+     * @returns StepLabelResultType or undefined.
      */
     private static runCurrentStep;
     /**
      * Execute the label and add it to the history.
      * Is a call function in Ren'Py.
      * @param label The label to execute.
-     * @returns
+     * @returns StepLabelResultType or undefined.
      * @example
      * ```typescript
-     * GameStepManager.callLabel(StartLabel)
+     * GameStepManager.callLabel(StartLabel).then((result) => {
+     *     if (result) {
+     *         // your code
+     *     }
+     * })
+     * ```
+     * @example
+     * ```typescript
+     * // if you use it in a step label you should return the result.
+     * return GameStepManager.callLabel(StartLabel).then((result) => {
+     *     return result
+     * })
      * ```
      */
-    static callLabel(label: typeof Label | Label): Promise<void>;
+    static callLabel(label: typeof Label | Label): Promise<StepLabelResultType>;
     /**
      * Execute the label, close all labels and add them to the history.
      * Is a jump function in Ren'Py.
-     * @param label
-     * @returns
+     * @param label The label to execute.
+     * @returns StepLabelResultType or undefined.
+     * @example
+     * ```typescript
+     * GameStepManager.jumpLabel(StartLabel).then((result) => {
+     *     if (result) {
+     *         // your code
+     *     }
+     * })
+     * ```
      * @example
      * ```typescript
-     * GameStepManager.jumpLabel(StartLabel)
+     * // if you use it in a step label you should return the result.
+     * return GameStepManager.jumpLabel(StartLabel).then((result) => {
+     *     return result
+     * })
      * ```
      */
-    static jumpLabel(label: typeof Label | Label): Promise<void>;
+    static jumpLabel(label: typeof Label | Label): Promise<StepLabelResultType>;
     /**
      * Go back to the last step and add it to the history.
      * @param navigate The navigate function.
@@ -1621,4 +1657,4 @@ declare class GameWindowManager {
     static import(data: object): void;
 }
 
-export { CanvasBase, CanvasContainer, CanvasEvent, type CanvasEventNamesType, CanvasImage, CanvasSprite, CanvasText, CharacterBaseModel, type CharacterBaseModelProps, ChoiceMenuOptionLabel, type ChoiceMenuOptionsType, DialogueBaseModel, 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, getAllCharacters, getCharacterById, getChoiceMenuOptions, getDialogue, getDialogueHistory, getFlag, getSaveData, getSaveJson, getTexture, labelDecorator, loadSaveData, loadSaveJson, removeCanvasElement, saveCharacter, setChoiceMenuOptions, setDialogue, setFlag, showCanvasImages, showImageWithDissolveTransition, tickerDecorator };
+export { CanvasBase, CanvasContainer, CanvasEvent, type CanvasEventNamesType, CanvasImage, CanvasSprite, CanvasText, CharacterBaseModel, type CharacterBaseModelProps, ChoiceMenuOptionLabel, type ChoiceMenuOptionsType, DialogueBaseModel, 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 StepLabelResultType, type StepLabelType, type StorageElementType, StoredClassModel, TickerBase, TickerFadeAlpha, type TickerProgrationType, TickerRotate, addImage, canvasElementDecorator, clearAllGameDatas, clearChoiceMenuOptions, clearDialogue, eventDecorator, getAllCharacters, getCharacterById, getChoiceMenuOptions, getDialogue, getDialogueHistory, getFlag, getSaveData, getSaveJson, getTexture, labelDecorator, loadSaveData, loadSaveJson, removeCanvasElement, saveCharacter, setChoiceMenuOptions, setDialogue, setFlag, showCanvasImages, showImageWithDissolveTransition, tickerDecorator };

package/dist/index.d.ts

@@ -193,7 +193,18 @@ type StepHistoryDataType = string;
 /**
  * StepLabel is a function that will be executed as the game continues.
  */
-type StepLabelType = (() => void | Promise<void>);
+type StepLabelType = (() => StepLabelResultType | Promise<StepLabelResultType>);
+/**
+ * StepLabelResultType is the return type of the StepLabel function.
+ * It can be useful for returning to the information calling function to perform other operations that cannot be performed within the StepLabel.
+ */
+type StepLabelResultType = {
+    /**
+     * The new route to navigate to.
+     */
+    newRoute?: string;
+    [key: string]: any;
+} | void;
 
 /**
  * Label is a class that contains a list of steps, which will be performed as the game continues.
@@ -1239,15 +1250,18 @@ declare class GameStepManager {
     private static increaseCurrentStepIndex;
     /**
      * Execute the next step and add it to the history.
-     * @returns
+     * @returns StepLabelResultType or undefined.
      * @example
      * ```typescript
      *     function nextOnClick() {
      *     setLoading(true)
      *     GameStepManager.runNextStep()
-     *         .then(() => {
+     *         .then((result) => {
      *             setUpdate((p) => p + 1)
      *             setLoading(false)
+     *             if (result) {
+     *                 // your code
+     *             }
      *         })
      *         .catch((e) => {
      *             setLoading(false)
@@ -1256,34 +1270,56 @@ declare class GameStepManager {
      * }
      * ```
      */
-    static runNextStep(): Promise<void>;
+    static runNextStep(): Promise<StepLabelResultType>;
     /**
      * Execute the current step and add it to the history.
-     * @returns
+     * @returns StepLabelResultType or undefined.
      */
     private static runCurrentStep;
     /**
      * Execute the label and add it to the history.
      * Is a call function in Ren'Py.
      * @param label The label to execute.
-     * @returns
+     * @returns StepLabelResultType or undefined.
      * @example
      * ```typescript
-     * GameStepManager.callLabel(StartLabel)
+     * GameStepManager.callLabel(StartLabel).then((result) => {
+     *     if (result) {
+     *         // your code
+     *     }
+     * })
+     * ```
+     * @example
+     * ```typescript
+     * // if you use it in a step label you should return the result.
+     * return GameStepManager.callLabel(StartLabel).then((result) => {
+     *     return result
+     * })
      * ```
      */
-    static callLabel(label: typeof Label | Label): Promise<void>;
+    static callLabel(label: typeof Label | Label): Promise<StepLabelResultType>;
     /**
      * Execute the label, close all labels and add them to the history.
      * Is a jump function in Ren'Py.
-     * @param label
-     * @returns
+     * @param label The label to execute.
+     * @returns StepLabelResultType or undefined.
+     * @example
+     * ```typescript
+     * GameStepManager.jumpLabel(StartLabel).then((result) => {
+     *     if (result) {
+     *         // your code
+     *     }
+     * })
+     * ```
      * @example
      * ```typescript
-     * GameStepManager.jumpLabel(StartLabel)
+     * // if you use it in a step label you should return the result.
+     * return GameStepManager.jumpLabel(StartLabel).then((result) => {
+     *     return result
+     * })
      * ```
      */
-    static jumpLabel(label: typeof Label | Label): Promise<void>;
+    static jumpLabel(label: typeof Label | Label): Promise<StepLabelResultType>;
     /**
      * Go back to the last step and add it to the history.
      * @param navigate The navigate function.
@@ -1621,4 +1657,4 @@ declare class GameWindowManager {
     static import(data: object): void;
 }
 
-export { CanvasBase, CanvasContainer, CanvasEvent, type CanvasEventNamesType, CanvasImage, CanvasSprite, CanvasText, CharacterBaseModel, type CharacterBaseModelProps, ChoiceMenuOptionLabel, type ChoiceMenuOptionsType, DialogueBaseModel, 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, getAllCharacters, getCharacterById, getChoiceMenuOptions, getDialogue, getDialogueHistory, getFlag, getSaveData, getSaveJson, getTexture, labelDecorator, loadSaveData, loadSaveJson, removeCanvasElement, saveCharacter, setChoiceMenuOptions, setDialogue, setFlag, showCanvasImages, showImageWithDissolveTransition, tickerDecorator };
+export { CanvasBase, CanvasContainer, CanvasEvent, type CanvasEventNamesType, CanvasImage, CanvasSprite, CanvasText, CharacterBaseModel, type CharacterBaseModelProps, ChoiceMenuOptionLabel, type ChoiceMenuOptionsType, DialogueBaseModel, 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 StepLabelResultType, type StepLabelType, type StorageElementType, StoredClassModel, TickerBase, TickerFadeAlpha, type TickerProgrationType, TickerRotate, addImage, canvasElementDecorator, clearAllGameDatas, clearChoiceMenuOptions, clearDialogue, eventDecorator, getAllCharacters, getCharacterById, getChoiceMenuOptions, getDialogue, getDialogueHistory, getFlag, getSaveData, getSaveJson, getTexture, labelDecorator, loadSaveData, loadSaveJson, removeCanvasElement, saveCharacter, setChoiceMenuOptions, setDialogue, setFlag, showCanvasImages, showImageWithDissolveTransition, tickerDecorator };

package/dist/index.js

@@ -2024,15 +2024,18 @@ var _GameStepManager = class _GameStepManager {
   /* Run Methods */
   /**
    * Execute the next step and add it to the history.
-   * @returns
+   * @returns StepLabelResultType or undefined.
    * @example
    * ```typescript
    *     function nextOnClick() {
    *     setLoading(true)
    *     GameStepManager.runNextStep()
-   *         .then(() => {
+   *         .then((result) => {
    *             setUpdate((p) => p + 1)
    *             setLoading(false)
+   *             if (result) {
+   *                 // your code
+   *             }
    *         })
    *         .catch((e) => {
    *             setLoading(false)
@@ -2053,7 +2056,7 @@ var _GameStepManager = class _GameStepManager {
   }
   /**
    * Execute the current step and add it to the history.
-   * @returns 
+   * @returns StepLabelResultType or undefined.
    */
   static runCurrentStep() {
     return __async(this, null, function* () {
@@ -2071,11 +2074,12 @@ var _GameStepManager = class _GameStepManager {
         let n = currentLabel.steps.length;
         if (n > lasteStepsLength) {
           let nextStep = currentLabel.steps[lasteStepsLength];
-          yield nextStep();
+          let result = yield nextStep();
           _GameStepManager.addStepHistory(nextStep);
+          return result;
         } else if (n === lasteStepsLength) {
           _GameStepManager.closeCurrentLabel();
-          yield _GameStepManager.runNextStep();
+          return yield _GameStepManager.runNextStep();
         } else {
           console.warn("[Pixi'VN] There are no steps to run");
         }
@@ -2086,10 +2090,21 @@ var _GameStepManager = class _GameStepManager {
    * Execute the label and add it to the history.
    * Is a call function in Ren'Py.
    * @param label The label to execute.
-   * @returns
+   * @returns StepLabelResultType or undefined.
    * @example
    * ```typescript
-   * GameStepManager.callLabel(StartLabel)
+   * GameStepManager.callLabel(StartLabel).then((result) => {
+   *     if (result) {
+   *         // your code
+   *     }
+   * })
+   * ```
+   * @example
+   * ```typescript
+   * // if you use it in a step label you should return the result.
+   * return GameStepManager.callLabel(StartLabel).then((result) => {
+   *     return result
+   * })
    * ```
    */
   static callLabel(label) {
@@ -2110,11 +2125,22 @@ var _GameStepManager = class _GameStepManager {
   /**
    * Execute the label, close all labels and add them to the history.
    * Is a jump function in Ren'Py.
-   * @param label 
-   * @returns
+   * @param label The label to execute.
+   * @returns StepLabelResultType or undefined.
+   * @example
+   * ```typescript
+   * GameStepManager.jumpLabel(StartLabel).then((result) => {
+   *     if (result) {
+   *         // your code
+   *     }
+   * })
+   * ```
    * @example
    * ```typescript
-   * GameStepManager.jumpLabel(StartLabel)
+   * // if you use it in a step label you should return the result.
+   * return GameStepManager.jumpLabel(StartLabel).then((result) => {
+   *     return result
+   * })
    * ```
    */
   static jumpLabel(label) {