labag 2.5.1 → 2.6.1

package/dist/index.d.ts

@@ -1,11 +1,12 @@
 import { LaBaG } from "./labag";
-import { modeList, ModeName } from "./modes";
+import { modes } from "./modes";
 import { LaBaGEvent, Pattern, PatternName } from "./types";
 import { Mode } from "./mode";
 import { patterns } from "./pattern";
-import { Recorder, GameRecord } from './recorder';
+import { Recorder, GameRecord } from "./recorder";
 import { RecordChecker } from "./recordChecker";
+import { ModeName } from "./types/index";
 declare const labag: LaBaG;
 declare const recorder: Recorder;
 declare const checker: RecordChecker;
-export { labag, recorder, checker, modeList, patterns, LaBaG, Recorder, RecordChecker, Mode, type LaBaGEvent, type Pattern, type PatternName, type ModeName, type GameRecord };
+export { labag, recorder, checker, modes, patterns, LaBaG, Recorder, RecordChecker, Mode, type LaBaGEvent, type Pattern, type PatternName, type GameRecord, type ModeName, };

package/dist/index.js

@@ -1,10 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Mode = exports.RecordChecker = exports.Recorder = exports.LaBaG = exports.patterns = exports.modeList = exports.checker = exports.recorder = exports.labag = void 0;
+exports.Mode = exports.RecordChecker = exports.Recorder = exports.LaBaG = exports.patterns = exports.modes = exports.checker = exports.recorder = exports.labag = void 0;
 const labag_1 = require("./labag");
 Object.defineProperty(exports, "LaBaG", { enumerable: true, get: function () { return labag_1.LaBaG; } });
 const modes_1 = require("./modes");
-Object.defineProperty(exports, "modeList", { enumerable: true, get: function () { return modes_1.modeList; } });
+Object.defineProperty(exports, "modes", { enumerable: true, get: function () { return modes_1.modes; } });
 const mode_1 = require("./mode");
 Object.defineProperty(exports, "Mode", { enumerable: true, get: function () { return mode_1.Mode; } });
 const pattern_1 = require("./pattern");
@@ -15,7 +15,7 @@ const recordChecker_1 = require("./recordChecker");
 Object.defineProperty(exports, "RecordChecker", { enumerable: true, get: function () { return recordChecker_1.RecordChecker; } });
 const labag = new labag_1.LaBaG();
 exports.labag = labag;
-modes_1.modeList.forEach((mode) => {
+modes_1.modes.forEach((mode) => {
     labag.addMode(mode);
 });
 const recorder = new recorder_1.Recorder(labag);

package/dist/labag.d.ts

@@ -1,6 +1,5 @@
 import { Mode } from "./mode";
-import { ModeName } from "./modes";
-import { Pattern, LaBaGEvent } from "./types";
+import { Pattern, LaBaGEvent, ModeName } from "./types";
 /**
  * 拉霸遊戲的主要類別。
  */
@@ -20,13 +19,10 @@ export declare class LaBaG {
     /** 當前轉出的圖案組合 */
     patterns: [Pattern | null, Pattern | null, Pattern | null];
     /** 遊戲模式列表 */
-    modes: Mode<any>[];
+    modes: Mode<Record<string, any>>[];
     /** 事件監聽器列表 */
     eventListeners: Record<LaBaGEvent, ((game: LaBaG) => void)[]>;
-    /**
-     * 初始化拉霸遊戲。
-     * @param times - 總遊玩次數，預設為 30。
-     */
+    __defaultMode__: Mode<{}, "normal">;
     constructor(times?: number);
     /**
      * 觸發指定事件。
@@ -35,54 +31,69 @@ export declare class LaBaG {
     private emit;
     /**
      * 新增事件監聽器。
-     * @param event - 事件名稱。
-     * @param listener - 監聽器函式。
+     * @param event - 要監聽的事件名稱。
+     * @param listener - 事件觸發時要執行的函式。
+     * @remarks 可以為同一事件添加多個監聽器，這些監聽器將按照添加的順序依次執行。
+     * @example
+     * game.addEventListener("gameStart", (game) => {
+     *   console.log("遊戲開始了！");
+     * });
+     * game.addEventListener("roundEnd", (game) => {
+     *  console.log("一輪結束了！");
+     * });
      */
     addEventListener(event: LaBaGEvent, callbackFn: (game: LaBaG) => void): void;
     /**
      * 移除事件監聽器。
-     * @param event - 事件名稱。
-     * @param listener - 監聽器函式。
+     * @param event - 要移除監聽器的事件名稱。
+     * @param listener - 要移除的監聽器函式。
+     * @remarks 這將從指定事件的監聽器列表中移除第一個匹配的函式。
+     * @example
+     * const onGameStart = (game) => {
+     *   console.log("遊戲開始了！");
+     * };
+     * game.addEventListener("gameStart", onGameStart);
+     * // 之後如果想要移除這個監聽器：
+     * game.removeEventListener("gameStart", onGameStart);
      */
     removeEventListener(event: LaBaGEvent, callbackFn: (game: LaBaG) => void): void;
     /**
      * 新增遊戲模式。
-     * @param mode - 要新增的模式。
+     * @param mode - 要新增的遊戲模式實例。
+     * @remarks 這將把指定的模式添加到遊戲的模式列表中，並自動註冊該模式定義的事件監聽器。
+     * @example
+     * const myMode = new Mode({
+     *  active: false,
+     * name: "myMode",
+     * rates: {
+     *  gss: 10,
+     *  hhh: 20,
+     *  hentai: 30,
+     *  handson: 20,
+     *  kachu: 10,
+     *  rrr: 10,
+     * },
+     * });
+     * game.addMode(myMode);
      */
     addMode(mode: Mode<any>): void;
-    /**
-     * 檢查遊戲是否正在進行中（未達次數上限）。
-     * @returns 如果遊戲仍在進行中則返回 true，否則返回 false。
-     */
-    isRunning(): boolean;
     /**
      * 取得目前遊戲的相關設定
      */
     getCurrentConfig(): {
-        modes: Mode<any>[];
+        modes: Mode<Record<string, any>, string>[];
         ranges: {
             threshold: number;
             pattern: Pattern;
         }[];
     };
-    /**
-     * 初始化遊戲狀態。
-     */
     init(): void;
-    /**
-     * 新的一小輪開始。
-     */
-    private roundStart;
-    /**
-     * 轉動拉霸機，產生隨機圖案。
-     */
-    private rollSlots;
-    /**
-     * 計算分數。
-     */
-    private calculateScore;
-    private roundEnd;
-    private gameOver;
+    roundStart(): void;
+    rollSlots(): void;
+    calculateScore(): void;
+    roundEnd(): void;
+    gameOver(): void;
     play(): void;
-    getMode(modeName: ModeName): Mode | undefined;
+    getModes(name: ModeName): Mode<Record<string, any>, string>[];
+    get isRunning(): boolean;
 }

package/dist/labag.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.LaBaG = void 0;
+const mode_1 = require("./mode");
 const pattern_1 = require("./pattern");
 const randInt_1 = require("./utils/randInt");
 /**
@@ -25,10 +26,7 @@ class LaBaG {
     modes;
     /** 事件監聽器列表 */
     eventListeners;
-    /**
-     * 初始化拉霸遊戲。
-     * @param times - 總遊玩次數，預設為 30。
-     */
+    __defaultMode__;
     constructor(times = 30) {
         this.times = times;
         this.played = 0;
@@ -46,6 +44,90 @@ class LaBaG {
             rollSlots: [],
             calculateScore: [],
         };
+        this.__defaultMode__ = new mode_1.Mode({
+            active: true,
+            name: "normal",
+            rates: {
+                gss: 36,
+                hhh: 24,
+                hentai: 17,
+                handson: 12,
+                kachu: 8,
+                rrr: 3,
+            },
+            eventListener: {
+                gameStart: (game) => {
+                    game.played = 0;
+                    game.rounds = 0;
+                    game.score = 0;
+                    game.marginScore = 0;
+                    game.randNums = [];
+                    game.patterns = [null, null, null];
+                },
+                roundStart: (game) => {
+                    game.played += 1;
+                    game.rounds += 1;
+                    game.marginScore = 0;
+                },
+                rollSlots: (game) => {
+                    const { ranges } = game.getCurrentConfig();
+                    const rangesAcc = ranges.length > 0 ? ranges[ranges.length - 1].threshold : 0;
+                    // 產生 3 個隨機數字並直接尋找對應圖案
+                    for (let i = 0; i < 3; i++) {
+                        const num = (0, randInt_1.randInt)(1, rangesAcc);
+                        game.randNums[i] = num;
+                        let matchedPattern = null;
+                        for (let j = 0; j < ranges.length; j++) {
+                            if (num <= ranges[j].threshold) {
+                                matchedPattern = ranges[j].pattern;
+                                break;
+                            }
+                        }
+                        game.patterns[i] = matchedPattern;
+                    }
+                },
+                calculateScore: (game) => {
+                    const [p1, p2, p3] = game.patterns;
+                    if (!p1 || !p2 || !p3) {
+                        game.marginScore = 0;
+                        return;
+                    }
+                    if (p1.name === p2.name && p2.name === p3.name) {
+                        // 三個圖案相同
+                        this.marginScore += p1.scores[0];
+                    }
+                    else if (p1.name === p2.name ||
+                        p2.name === p3.name ||
+                        p1.name === p3.name) {
+                        // 兩個圖案相同
+                        if (p1.name === p2.name) {
+                            this.marginScore += p1.scores[1];
+                            this.marginScore += p3.scores[2];
+                        }
+                        else if (p2.name === p3.name) {
+                            this.marginScore += p2.scores[1];
+                            this.marginScore += p1.scores[2];
+                        }
+                        else {
+                            this.marginScore += p1.scores[1];
+                            this.marginScore += p2.scores[2];
+                        }
+                        this.marginScore = Math.round(this.marginScore / 1.4);
+                    }
+                    else {
+                        // 三個圖案皆不同
+                        this.marginScore += p1.scores[2];
+                        this.marginScore += p2.scores[2];
+                        this.marginScore += p3.scores[2];
+                        this.marginScore = Math.round(this.marginScore / 3);
+                    }
+                },
+                roundEnd: (game) => {
+                    game.score += game.marginScore;
+                },
+            },
+        });
+        this.addMode(this.__defaultMode__);
     }
     /**
      * 觸發指定事件。
@@ -59,26 +141,58 @@ class LaBaG {
     }
     /**
      * 新增事件監聽器。
-     * @param event - 事件名稱。
-     * @param listener - 監聽器函式。
+     * @param event - 要監聽的事件名稱。
+     * @param listener - 事件觸發時要執行的函式。
+     * @remarks 可以為同一事件添加多個監聽器，這些監聽器將按照添加的順序依次執行。
+     * @example
+     * game.addEventListener("gameStart", (game) => {
+     *   console.log("遊戲開始了！");
+     * });
+     * game.addEventListener("roundEnd", (game) => {
+     *  console.log("一輪結束了！");
+     * });
      */
     addEventListener(event, callbackFn) {
         this.eventListeners[event].push(callbackFn);
     }
     /**
      * 移除事件監聽器。
-     * @param event - 事件名稱。
-     * @param listener - 監聽器函式。
+     * @param event - 要移除監聽器的事件名稱。
+     * @param listener - 要移除的監聽器函式。
+     * @remarks 這將從指定事件的監聽器列表中移除第一個匹配的函式。
+     * @example
+     * const onGameStart = (game) => {
+     *   console.log("遊戲開始了！");
+     * };
+     * game.addEventListener("gameStart", onGameStart);
+     * // 之後如果想要移除這個監聽器：
+     * game.removeEventListener("gameStart", onGameStart);
      */
     removeEventListener(event, callbackFn) {
-        const index = this.eventListeners[event].indexOf(callbackFn);
+        const listeners = this.eventListeners[event];
+        const index = listeners.indexOf(callbackFn);
         if (index !== -1) {
-            this.eventListeners[event].splice(index, 1);
+            listeners.splice(index, 1);
         }
     }
     /**
      * 新增遊戲模式。
-     * @param mode - 要新增的模式。
+     * @param mode - 要新增的遊戲模式實例。
+     * @remarks 這將把指定的模式添加到遊戲的模式列表中，並自動註冊該模式定義的事件監聽器。
+     * @example
+     * const myMode = new Mode({
+     *  active: false,
+     * name: "myMode",
+     * rates: {
+     *  gss: 10,
+     *  hhh: 20,
+     *  hentai: 30,
+     *  handson: 20,
+     *  kachu: 10,
+     *  rrr: 10,
+     * },
+     * });
+     * game.addMode(myMode);
      */
     addMode(mode) {
         this.modes.push(mode);
@@ -89,13 +203,6 @@ class LaBaG {
             }
         });
     }
-    /**
-     * 檢查遊戲是否正在進行中（未達次數上限）。
-     * @returns 如果遊戲仍在進行中則返回 true，否則返回 false。
-     */
-    isRunning() {
-        return this.played < this.times;
-    }
     /**
      * 取得目前遊戲的相關設定
      */
@@ -116,7 +223,8 @@ class LaBaG {
         for (let i = 0; i < activeModes.length; i++) {
             const mode = activeModes[i];
             for (const patternName in mode.rates) {
-                combinedRates[patternName] += mode.rates[patternName];
+                combinedRates[patternName] +=
+                    mode.rates[patternName];
             }
         }
         // 預先計算合併後的區間
@@ -131,108 +239,41 @@ class LaBaG {
         }
         return { modes: activeModes, ranges };
     }
-    /**
-     * 初始化遊戲狀態。
-     */
     init() {
-        this.played = 0;
-        this.score = 0;
-        this.marginScore = 0;
-        this.randNums = [];
-        this.patterns = [null, null, null];
-        this.rounds = 0;
         this.emit("gameStart");
     }
-    /**
-     * 新的一小輪開始。
-     */
     roundStart() {
-        this.played += 1;
-        this.rounds += 1;
-        this.marginScore = 0;
         this.emit("roundStart");
     }
-    /**
-     * 轉動拉霸機，產生隨機圖案。
-     */
     rollSlots() {
-        const { ranges } = this.getCurrentConfig();
-        const rangesAcc = ranges.length > 0 ? ranges[ranges.length - 1].threshold : 0;
-        // 產生 3 個隨機數字並直接尋找對應圖案
-        for (let i = 0; i < 3; i++) {
-            const num = (0, randInt_1.randInt)(1, rangesAcc);
-            this.randNums[i] = num;
-            let matchedPattern = null;
-            for (let j = 0; j < ranges.length; j++) {
-                if (num <= ranges[j].threshold) {
-                    matchedPattern = ranges[j].pattern;
-                    break;
-                }
-            }
-            this.patterns[i] = matchedPattern;
-        }
         this.emit("rollSlots");
     }
-    /**
-     * 計算分數。
-     */
     calculateScore() {
-        const [p1, p2, p3] = this.patterns;
-        if (!p1 || !p2 || !p3) {
-            throw new Error("圖案未正確生成，無法計算分數。");
-        }
-        if (p1.name === p2.name && p2.name === p3.name) {
-            // 三個圖案相同
-            this.marginScore += p1.scores[0];
-        }
-        else if (p1.name === p2.name ||
-            p2.name === p3.name ||
-            p1.name === p3.name) {
-            // 兩個圖案相同
-            if (p1.name === p2.name) {
-                this.marginScore += p1.scores[1];
-                this.marginScore += p3.scores[2];
-            }
-            else if (p2.name === p3.name) {
-                this.marginScore += p2.scores[1];
-                this.marginScore += p1.scores[2];
-            }
-            else {
-                this.marginScore += p1.scores[1];
-                this.marginScore += p2.scores[2];
-            }
-            this.marginScore = Math.round(this.marginScore / 1.4);
-        }
-        else {
-            // 三個圖案皆不同
-            this.marginScore += p1.scores[2];
-            this.marginScore += p2.scores[2];
-            this.marginScore += p3.scores[2];
-            this.marginScore = Math.round(this.marginScore / 3);
-        }
         this.emit("calculateScore");
     }
     roundEnd() {
-        this.score += this.marginScore;
         this.emit("roundEnd");
     }
     gameOver() {
         this.emit("gameOver");
     }
     play() {
-        if (!this.isRunning()) {
-            throw new Error("遊戲次數已達上限，無法繼續遊玩。");
+        if (!this.isRunning) {
+            throw new Error("遊戲已結束，無法繼續遊玩。");
         }
         this.roundStart();
         this.rollSlots();
         this.calculateScore();
         this.roundEnd();
-        if (!this.isRunning()) {
+        if (!this.isRunning) {
             this.gameOver();
         }
     }
-    getMode(modeName) {
-        return this.modes.find((mode) => mode.name === modeName);
+    getModes(name) {
+        return this.modes.filter((m) => m.name === name);
+    }
+    get isRunning() {
+        return this.played < this.times;
     }
 }
 exports.LaBaG = LaBaG;

package/dist/mode.d.ts

@@ -1,8 +1,8 @@
 import { LaBaG } from "./labag";
 import { LaBaGEvent, Pattern, PatternName } from "./types";
-interface ModeConfig<VariableType extends Record<string, any>> {
+interface ModeConfig<VariableType extends Record<string, any>, N extends string = string> {
     active: boolean;
-    name: string;
+    name: N;
     rates: Record<PatternName, number>;
     eventListener?: Partial<Record<LaBaGEvent, (game: LaBaG, mode: Mode<VariableType>) => void>>;
     variable?: VariableType;
@@ -10,11 +10,11 @@ interface ModeConfig<VariableType extends Record<string, any>> {
 /**
  * 代表遊戲的一種模式，包含機率設定和事件監聽器。
  */
-export declare class Mode<VariableType extends Record<string, any> = Record<string, any>> implements ModeConfig<VariableType> {
+export declare class Mode<VariableType extends Record<string, any> = Record<string, any>, N extends string = string> implements ModeConfig<VariableType, N> {
     /** 模式是否啟用 */
     active: boolean;
     /** 模式名稱 */
-    name: string;
+    name: N;
     /** 各圖案出現的機率 */
     rates: Record<PatternName, number>;
     ranges: {
@@ -27,12 +27,34 @@ export declare class Mode<VariableType extends Record<string, any> = Record<stri
     variable: VariableType;
     /** 機率總和 */
     /**
-     * 建立一個新的模式。
-     * @param active - 是否啟用此模式。
-     * @param name - 模式名稱。
-     * @param rates - 各圖案的機率設定。
-     * @param eventListener - 事件監聽器。
+     * 建立一個新的遊戲模式。
+     * @param config 模式的設定，包括啟用狀態、名稱、機率、事件監聽器和專屬變數。
+     * @remarks 會根據提供的機率設定預先計算出對應的區間，以便在遊戲中快速查找圖案。
+     * @example
+     * const myMode = new Mode({
+     *   active: false,
+     *   name: "myMode",
+     *  rates: {
+     *    gss: 10,
+     *   hhh: 20,
+     *   hentai: 30,
+     *   handson: 20,
+     *   kachu: 10,
+     *   rrr: 10,
+     * },
+     *  eventListener: {
+     *   gameStart: (game, mode) => {
+     *    console.log("遊戲開始了！", mode.name);
+     * },
+     *  roundEnd: (game, mode) => {
+     *   console.log("一輪結束了！", mode.name);
+     * },
+     * },
+     * variable: {
+     *  myCustomValue: 123,
+     * },
+     * });
      */
-    constructor(active: boolean, name: string, rates: Record<PatternName, number>, eventListener?: Partial<Record<LaBaGEvent, (game: LaBaG, mode: Mode<VariableType>) => void>>, variable?: VariableType);
+    constructor(config: ModeConfig<VariableType, N>);
 }
 export {};

package/dist/mode.js

@@ -20,13 +20,36 @@ class Mode {
     variable;
     /** 機率總和 */
     /**
-     * 建立一個新的模式。
-     * @param active - 是否啟用此模式。
-     * @param name - 模式名稱。
-     * @param rates - 各圖案的機率設定。
-     * @param eventListener - 事件監聽器。
+     * 建立一個新的遊戲模式。
+     * @param config 模式的設定，包括啟用狀態、名稱、機率、事件監聽器和專屬變數。
+     * @remarks 會根據提供的機率設定預先計算出對應的區間，以便在遊戲中快速查找圖案。
+     * @example
+     * const myMode = new Mode({
+     *   active: false,
+     *   name: "myMode",
+     *  rates: {
+     *    gss: 10,
+     *   hhh: 20,
+     *   hentai: 30,
+     *   handson: 20,
+     *   kachu: 10,
+     *   rrr: 10,
+     * },
+     *  eventListener: {
+     *   gameStart: (game, mode) => {
+     *    console.log("遊戲開始了！", mode.name);
+     * },
+     *  roundEnd: (game, mode) => {
+     *   console.log("一輪結束了！", mode.name);
+     * },
+     * },
+     * variable: {
+     *  myCustomValue: 123,
+     * },
+     * });
      */
-    constructor(active, name, rates, eventListener, variable) {
+    constructor(config) {
+        const { active, name, rates, eventListener, variable } = config;
         this.active = active;
         this.name = name;
         this.rates = rates;

package/dist/modes/greenwei.d.ts

@@ -16,5 +16,5 @@ declare const _default: Mode<{
     bonusTimes: number;
     requiredBindPatternCount: number;
     mutiplier: number;
-}>;
+}, "greenwei">;
 export default _default;