@slot-engine/core 0.0.9 → 0.0.11

package/dist/index.d.mts

@@ -328,6 +328,10 @@ declare class GameSymbol {
      * Compares this symbol to another symbol or a set of properties.
      */
     compare(symbolOrProperties?: GameSymbol | Record<string, any>): boolean;
+    /**
+     * Creates a clone of this GameSymbol.
+     */
+    clone(): GameSymbol;
 }
 interface GameSymbolOpts {
     /**
@@ -370,6 +374,14 @@ declare class BoardService<TGameModes extends AnyGameModes = AnyGameModes, TSymb
     getPaddingTop(): Reels;
     getPaddingBottom(): Reels;
     getAnticipation(): boolean[];
+    /**
+     * Gets the symbol at the specified reel and row index.
+     */
+    getSymbol(reelIndex: number, rowIndex: number): GameSymbol | undefined;
+    /**
+     * Sets the symbol at the specified reel and row index.
+     */
+    setSymbol(reelIndex: number, rowIndex: number, symbol: GameSymbol): void;
     private resetReels;
     /**
      * Sets the anticipation value for a specific reel.
@@ -416,7 +428,11 @@ declare class BoardService<TGameModes extends AnyGameModes = AnyGameModes, TSymb
     /**
      * Draws a board using specified reel stops.
      */
-    drawBoardWithForcedStops(reels: Reels, forcedStops: Record<string, number>): void;
+    drawBoardWithForcedStops(opts: {
+        reels: Reels;
+        forcedStops: Record<string, number>;
+        randomOffset?: boolean;
+    }): void;
     /**
      * Draws a board using random reel stops.
      */
@@ -597,7 +613,7 @@ declare class ReelSet {
     reels: Reels;
     protected rng: RandomNumberGenerator;
     constructor(opts: ReelSetOptions);
-    generateReels(simulation: Simulation): void;
+    generateReels(config: GameConfig): ReelSet;
     /**
      * Reads a reelset CSV file and returns the reels as arrays of GameSymbols.
      */
@@ -675,6 +691,11 @@ interface GameModeOpts {
 
 declare class GameService<TGameModes extends AnyGameModes = AnyGameModes, TSymbols extends AnySymbols = AnySymbols, TUserState extends AnyUserData = AnyUserData> extends AbstractService {
     constructor(ctx: () => GameContext<TGameModes, TSymbols, TUserState>);
+    /**
+     * Intended for internal use only.\
+     * Generates reels for all reel sets in the game configuration.
+     */
+    _generateReels(): void;
     /**
      * Retrieves a reel set by its ID within a specific game mode.
      */
@@ -1171,6 +1192,7 @@ declare class WinType {
         winCombinations: WinCombination[];
     };
     protected isWild(symbol: GameSymbol): boolean;
+    protected getSymbolPayout(symbol: GameSymbol, count: number): number;
 }
 interface WinTypeOpts {
     /**
@@ -1198,6 +1220,7 @@ interface WinTypeOpts {
 type WinCombination = {
     payout: number;
     kind: number;
+    baseSymbol: GameSymbol;
     symbols: Array<{
         symbol: GameSymbol;
         isWild: boolean;
@@ -1226,6 +1249,7 @@ declare class LinesWinType extends WinType {
      * Retrieve the results using `getWins()` after.
      */
     evaluateWins(board: Reels): this;
+    private getLinePayout;
 }
 interface LinesWinTypeOpts extends WinTypeOpts {
     /**
@@ -1244,20 +1268,57 @@ interface LinesWinTypeOpts extends WinTypeOpts {
 }
 interface LineWinCombination extends WinCombination {
     lineNumber: number;
-    symbol: GameSymbol;
-    winType: "pure-wild" | "substituted";
-    substitutedBaseSymbol: GameSymbol | null;
-    stats: {
-        wildCount: number;
-        nonWildCount: number;
-        leadingWilds: number;
-    };
 }
 
 declare class ClusterWinType extends WinType {
+    protected winCombinations: ClusterWinCombination[];
+    getWins: () => {
+        payout: number;
+        winCombinations: ClusterWinCombination[];
+    };
+    private _checked;
+    private _checkedWilds;
+    private _currentBoard;
+    constructor(opts: ClusterWinTypeOpts);
+    private validateConfig;
+    /**
+     * Calculates wins based on symbol cluster size and provided board state.\
+     * Retrieve the results using `getWins()` after.
+     */
+    evaluateWins(board: Reels): this;
+    private getNeighbors;
+    private evaluateCluster;
+    private isChecked;
+    private isCheckedWild;
+}
+interface ClusterWinTypeOpts extends WinTypeOpts {
+}
+interface ClusterWinCombination extends WinCombination {
 }
 
 declare class ManywaysWinType extends WinType {
+    protected winCombinations: ManywaysWinCombination[];
+    getWins: () => {
+        payout: number;
+        winCombinations: ManywaysWinCombination[];
+    };
+    private _checked;
+    private _checkedWilds;
+    constructor(opts: ManywaysWinTypeOpts);
+    private validateConfig;
+    /**
+     * Calculates wins based on the defined paylines and provided board state.\
+     * Retrieve the results using `getWins()` after.
+     */
+    evaluateWins(board: Reels): this;
+    private getWayLength;
+    private isChecked;
+    private isCheckedWild;
+}
+interface ManywaysWinTypeOpts extends WinTypeOpts {
+}
+interface ManywaysWinCombination extends WinCombination {
+    ways: number;
 }
 
 /**
@@ -1292,7 +1353,7 @@ declare class GeneratedReelSet extends ReelSet {
      * Checks if a symbol can be placed at the target index without violating spacing rules.
      */
     private violatesSpacing;
-    generateReels({ gameConfig: config }: Simulation): void;
+    generateReels(config: GameConfig): this;
 }
 interface GeneratedReelSetOptions extends ReelSetOptions {
     /**
@@ -1406,7 +1467,7 @@ declare class StaticReelSet extends ReelSet {
     private _strReels;
     constructor(opts: StaticReelSetOptions);
     private validateConfig;
-    generateReels({ gameConfig: config }: Simulation): void;
+    generateReels(config: GameConfig): this;
 }
 interface StaticReelSetOptions extends ReelSetOptions {
     reels?: string[][];
@@ -1431,6 +1492,14 @@ declare class StandaloneBoard {
     getBoardReels(): Reels;
     getPaddingTop(): Reels;
     getPaddingBottom(): Reels;
+    /**
+     * Gets the symbol at the specified reel and row index.
+     */
+    getSymbol(reelIndex: number, rowIndex: number): GameSymbol | undefined;
+    /**
+     * Sets the symbol at the specified reel and row index.
+     */
+    setSymbol(reelIndex: number, rowIndex: number, symbol: GameSymbol): void;
     private resetReels;
     /**
      * Sets the anticipation value for a specific reel.
@@ -1477,7 +1546,11 @@ declare class StandaloneBoard {
     /**
      * Draws a board using specified reel stops.
      */
-    drawBoardWithForcedStops(reels: Reels, forcedStops: Record<string, number>): void;
+    drawBoardWithForcedStops(opts: {
+        reels: Reels;
+        forcedStops: Record<string, number>;
+        randomOffset?: boolean;
+    }): void;
     /**
      * Draws a board using random reel stops.
      */

package/dist/index.d.ts

@@ -328,6 +328,10 @@ declare class GameSymbol {
      * Compares this symbol to another symbol or a set of properties.
      */
     compare(symbolOrProperties?: GameSymbol | Record<string, any>): boolean;
+    /**
+     * Creates a clone of this GameSymbol.
+     */
+    clone(): GameSymbol;
 }
 interface GameSymbolOpts {
     /**
@@ -370,6 +374,14 @@ declare class BoardService<TGameModes extends AnyGameModes = AnyGameModes, TSymb
     getPaddingTop(): Reels;
     getPaddingBottom(): Reels;
     getAnticipation(): boolean[];
+    /**
+     * Gets the symbol at the specified reel and row index.
+     */
+    getSymbol(reelIndex: number, rowIndex: number): GameSymbol | undefined;
+    /**
+     * Sets the symbol at the specified reel and row index.
+     */
+    setSymbol(reelIndex: number, rowIndex: number, symbol: GameSymbol): void;
     private resetReels;
     /**
      * Sets the anticipation value for a specific reel.
@@ -416,7 +428,11 @@ declare class BoardService<TGameModes extends AnyGameModes = AnyGameModes, TSymb
     /**
      * Draws a board using specified reel stops.
      */
-    drawBoardWithForcedStops(reels: Reels, forcedStops: Record<string, number>): void;
+    drawBoardWithForcedStops(opts: {
+        reels: Reels;
+        forcedStops: Record<string, number>;
+        randomOffset?: boolean;
+    }): void;
     /**
      * Draws a board using random reel stops.
      */
@@ -597,7 +613,7 @@ declare class ReelSet {
     reels: Reels;
     protected rng: RandomNumberGenerator;
     constructor(opts: ReelSetOptions);
-    generateReels(simulation: Simulation): void;
+    generateReels(config: GameConfig): ReelSet;
     /**
      * Reads a reelset CSV file and returns the reels as arrays of GameSymbols.
      */
@@ -675,6 +691,11 @@ interface GameModeOpts {
 
 declare class GameService<TGameModes extends AnyGameModes = AnyGameModes, TSymbols extends AnySymbols = AnySymbols, TUserState extends AnyUserData = AnyUserData> extends AbstractService {
     constructor(ctx: () => GameContext<TGameModes, TSymbols, TUserState>);
+    /**
+     * Intended for internal use only.\
+     * Generates reels for all reel sets in the game configuration.
+     */
+    _generateReels(): void;
     /**
      * Retrieves a reel set by its ID within a specific game mode.
      */
@@ -1171,6 +1192,7 @@ declare class WinType {
         winCombinations: WinCombination[];
     };
     protected isWild(symbol: GameSymbol): boolean;
+    protected getSymbolPayout(symbol: GameSymbol, count: number): number;
 }
 interface WinTypeOpts {
     /**
@@ -1198,6 +1220,7 @@ interface WinTypeOpts {
 type WinCombination = {
     payout: number;
     kind: number;
+    baseSymbol: GameSymbol;
     symbols: Array<{
         symbol: GameSymbol;
         isWild: boolean;
@@ -1226,6 +1249,7 @@ declare class LinesWinType extends WinType {
      * Retrieve the results using `getWins()` after.
      */
     evaluateWins(board: Reels): this;
+    private getLinePayout;
 }
 interface LinesWinTypeOpts extends WinTypeOpts {
     /**
@@ -1244,20 +1268,57 @@ interface LinesWinTypeOpts extends WinTypeOpts {
 }
 interface LineWinCombination extends WinCombination {
     lineNumber: number;
-    symbol: GameSymbol;
-    winType: "pure-wild" | "substituted";
-    substitutedBaseSymbol: GameSymbol | null;
-    stats: {
-        wildCount: number;
-        nonWildCount: number;
-        leadingWilds: number;
-    };
 }
 
 declare class ClusterWinType extends WinType {
+    protected winCombinations: ClusterWinCombination[];
+    getWins: () => {
+        payout: number;
+        winCombinations: ClusterWinCombination[];
+    };
+    private _checked;
+    private _checkedWilds;
+    private _currentBoard;
+    constructor(opts: ClusterWinTypeOpts);
+    private validateConfig;
+    /**
+     * Calculates wins based on symbol cluster size and provided board state.\
+     * Retrieve the results using `getWins()` after.
+     */
+    evaluateWins(board: Reels): this;
+    private getNeighbors;
+    private evaluateCluster;
+    private isChecked;
+    private isCheckedWild;
+}
+interface ClusterWinTypeOpts extends WinTypeOpts {
+}
+interface ClusterWinCombination extends WinCombination {
 }
 
 declare class ManywaysWinType extends WinType {
+    protected winCombinations: ManywaysWinCombination[];
+    getWins: () => {
+        payout: number;
+        winCombinations: ManywaysWinCombination[];
+    };
+    private _checked;
+    private _checkedWilds;
+    constructor(opts: ManywaysWinTypeOpts);
+    private validateConfig;
+    /**
+     * Calculates wins based on the defined paylines and provided board state.\
+     * Retrieve the results using `getWins()` after.
+     */
+    evaluateWins(board: Reels): this;
+    private getWayLength;
+    private isChecked;
+    private isCheckedWild;
+}
+interface ManywaysWinTypeOpts extends WinTypeOpts {
+}
+interface ManywaysWinCombination extends WinCombination {
+    ways: number;
 }
 
 /**
@@ -1292,7 +1353,7 @@ declare class GeneratedReelSet extends ReelSet {
      * Checks if a symbol can be placed at the target index without violating spacing rules.
      */
     private violatesSpacing;
-    generateReels({ gameConfig: config }: Simulation): void;
+    generateReels(config: GameConfig): this;
 }
 interface GeneratedReelSetOptions extends ReelSetOptions {
     /**
@@ -1406,7 +1467,7 @@ declare class StaticReelSet extends ReelSet {
     private _strReels;
     constructor(opts: StaticReelSetOptions);
     private validateConfig;
-    generateReels({ gameConfig: config }: Simulation): void;
+    generateReels(config: GameConfig): this;
 }
 interface StaticReelSetOptions extends ReelSetOptions {
     reels?: string[][];
@@ -1431,6 +1492,14 @@ declare class StandaloneBoard {
     getBoardReels(): Reels;
     getPaddingTop(): Reels;
     getPaddingBottom(): Reels;
+    /**
+     * Gets the symbol at the specified reel and row index.
+     */
+    getSymbol(reelIndex: number, rowIndex: number): GameSymbol | undefined;
+    /**
+     * Sets the symbol at the specified reel and row index.
+     */
+    setSymbol(reelIndex: number, rowIndex: number, symbol: GameSymbol): void;
     private resetReels;
     /**
      * Sets the anticipation value for a specific reel.
@@ -1477,7 +1546,11 @@ declare class StandaloneBoard {
     /**
      * Draws a board using specified reel stops.
      */
-    drawBoardWithForcedStops(reels: Reels, forcedStops: Record<string, number>): void;
+    drawBoardWithForcedStops(opts: {
+        reels: Reels;
+        forcedStops: Record<string, number>;
+        randomOffset?: boolean;
+    }): void;
     /**
      * Draws a board using random reel stops.
      */