Merge pull request #171 from DRincs-Productions/170-improve-end-game-…

…management

170 improve end game management

src/classes/LabelJson.ts

@@ -58,8 +58,8 @@ export default class LabelJson<T extends {} = {}> extends LabelAbstract<LabelJso
             }
 
             if (step.end === "game_end") {
-                // TODO end game
-                console.warn("[Pixi'VN] Game end not implemented")
+                GameStepManager.closeAllLabels()
+                GameStepManager.goNext(props)
             }
             else if (step.end === "label_end") {
                 GameStepManager.closeCurrentLabel()

src/managers/StepManager.ts

@@ -291,6 +291,9 @@ export default class GameStepManager {
             }
             else {
                 GameStepManager.restorLastLabelList()
+                if (GameStepManager.gameEnd) {
+                    return await GameStepManager.gameEnd(props)
+                }
                 console.error("[Pixi'VN] The end of the game is not managed, so the game is blocked. Read this documentation to know how to manage the end of the game: https://pixi-vn.web.app/start/labels.html#how-manage-the-end-of-the-game")
                 return
             }
@@ -650,4 +653,15 @@ export default class GameStepManager {
             console.error("[Pixi'VN] Error importing data", e)
         }
     }
+
+    /**
+     * Function to be executed at the end of the game. It should be set in the game initialization.
+     * @example
+     * ```typescript
+     * GameStepManager.gameEnd = async (props) => {
+     *    props.navigate("/end")
+     * }
+     * ```
+     */
+    static gameEnd: StepLabelType | undefined = undefined
 }

src/types/StepLabelJsonType.ts

@@ -5,20 +5,58 @@ import { LabelIdType } from "./LabelIdType"
  * Step label JSON type
  */
 type StepLabelJsonType = {
+    /**
+     * Variable used to display a choice menu.
+     */
     currentChoiceMenuOptions?: {
+        /**
+         * The text to be displayed.
+         */
         text: string
+        /**
+         * The label id to be opened.
+         */
         label: LabelIdType
+        /**
+         * Label opening mode
+         */
         type: LabelRunModeType
+        /**
+         * The properties to be passed to the label.
+         */
         props: StorageObjectType
     }[]
+    /**
+     * Variable used to display a dialog.
+     */
     dialog?: {
+        /**
+         * The character id that will speak.
+         */
         character: string,
+        /**
+         * The text to be displayed.
+         */
         text: string,
     } | string
+    /**
+     * Variable used to open a label.
+     */
     labelToOpen?: {
+        /**
+         * The id of the label to open.
+         */
         labelId: string,
-        type: "jump" | "call",
+        /**
+         * Label opening mode
+         */
+        type: LabelRunModeType,
     }
+    /**
+     * Variable used to end some elements of the narrative.
+     * - game_end: ends the game
+     * - label_end: ends the label
+     */
     end?: "game_end" | "label_end"
 }