pixi-rainman-game-engine 0.2.11 → 0.2.13

package/dist/ComponentRegistry/ComponentRegistry.d.ts

@@ -14,7 +14,7 @@ export declare class ComponentRegistry {
     /**
      * Method for changing temporarily speed for turbo spin
      * @public
-     * @param {SpeedLevel} newSpeedLevel
+     * @param {SpeedLevel} newSpeedLevel - new speed level
      */
     setTemporarySpeedLevel(newSpeedLevel: SpeedLevel): void;
     /**
@@ -25,7 +25,7 @@ export declare class ComponentRegistry {
     /**
      * Setter fo speed level
      * @public
-     * @param {SpeedLevel} newSpeedLevel
+     * @param {SpeedLevel} newSpeedLevel - new speed level
      */
     setSpeedLevel(newSpeedLevel: SpeedLevel): void;
     /**
@@ -36,7 +36,7 @@ export declare class ComponentRegistry {
     /**
      * Getter for current speed level
      * @public
-     * @returns {SpeedLevel}
+     * @returns {SpeedLevel} speed of the game
      */
     getSpeedLevel(): SpeedLevel;
     /**
@@ -47,26 +47,26 @@ export declare class ComponentRegistry {
     /**
      * Function for adding components into ComponentRegistry
      * @public
-     * @param {Container} component
+     * @param {Container} component component to be added
      */
     add(component: Container): void;
     /**
      * Function for updating component that are in ComponentRegistry
      * @public
-     * @param {Container} oldComponent
-     * @param {Container} newComponent
+     * @param {Container} oldComponent - old component
+     * @param {Container} newComponent - new component
      */
     update(oldComponent: Container, newComponent: Container): void;
     /**
      * Function for removing components from Component Registry
      * @public
-     * @param {Container} component
+     * @param {Container} component - component to be removed
      */
     remove(component: Container): void;
     /**
      * Function that adapt speed of all components
      * @public
-     * @param {SpeedLevel} speedLevel
+     * @param {SpeedLevel} speedLevel - speed lever for updating
      */
     updateAllSpeedAdaptable(speedLevel: SpeedLevel): void;
     /**
@@ -74,36 +74,36 @@ export declare class ComponentRegistry {
      * Throws error if component is not present
      * @public
      * @template {keyof RegistryMap} T
-     * @param {T} componentName
-     * @returns {RegistryMap[T]}
+     * @param {T} componentName - name of the component
+     * @returns {RegistryMap[T]} - component from registry
      */
     get<T extends keyof RegistryMap>(componentName: T): RegistryMap[T];
     /**
      * Getter for existing components that are in ComponentRegistry
      * @public
      * @template {keyof RegistryMap} T
-     * @param {T} componentName
-     * @returns {RegistryMap[T]}
+     * @param {T} componentName - component name
+     * @returns {RegistryMap[T]} - component from registry
      */
     getIfExists<T extends keyof RegistryMap>(componentName: T): RegistryMap[T];
     /**
      * Helper function to check if the component is present in ComponentRegistry
      * @public
      * @template {keyof RegistryMap} T
-     * @param {T} componentName
-     * @returns {boolean}
+     * @param {T} componentName - component name
+     * @returns {boolean} - true if component is present
      */
     has<T extends keyof RegistryMap>(componentName: T): boolean;
     /**
      * Function for adding components
      * @public
-     * @param {Container[]} components
+     * @param {Container[]} components - components to be added
      */
     addMany(components: Container[]): void;
     /**
      * Function for removing components
      * @public
-     * @param {Container[]} components
+     * @param {Container[]} components - components to be removed
      */
     removeMany(components: Container[]): void;
 }

package/dist/ComponentRegistry/ComponentRegistry.js

@@ -21,7 +21,7 @@ export class ComponentRegistry {
     /**
      * Method for changing temporarily speed for turbo spin
      * @public
-     * @param {SpeedLevel} newSpeedLevel
+     * @param {SpeedLevel} newSpeedLevel - new speed level
      */
     setTemporarySpeedLevel(newSpeedLevel) {
         this.speedLevelHandler.setSpeed(newSpeedLevel);
@@ -38,7 +38,7 @@ export class ComponentRegistry {
     /**
      * Setter fo speed level
      * @public
-     * @param {SpeedLevel} newSpeedLevel
+     * @param {SpeedLevel} newSpeedLevel - new speed level
      */
     setSpeedLevel(newSpeedLevel) {
         this.speedLevelHandler.setSpeed(newSpeedLevel);
@@ -59,7 +59,7 @@ export class ComponentRegistry {
     /**
      * Getter for current speed level
      * @public
-     * @returns {SpeedLevel}
+     * @returns {SpeedLevel} speed of the game
      */
     getSpeedLevel() {
         return this.speedLevelHandler.currentSpeed;
@@ -74,7 +74,7 @@ export class ComponentRegistry {
     /**
      * Function for adding components into ComponentRegistry
      * @public
-     * @param {Container} component
+     * @param {Container} component component to be added
      */
     add(component) {
         if (isSpeedAdapterInterface(component)) {
@@ -95,8 +95,8 @@ export class ComponentRegistry {
     /**
      * Function for updating component that are in ComponentRegistry
      * @public
-     * @param {Container} oldComponent
-     * @param {Container} newComponent
+     * @param {Container} oldComponent - old component
+     * @param {Container} newComponent - new component
      */
     update(oldComponent, newComponent) {
         if (oldComponent.name !== newComponent.name) {
@@ -114,7 +114,7 @@ export class ComponentRegistry {
     /**
      * Function for removing components from Component Registry
      * @public
-     * @param {Container} component
+     * @param {Container} component - component to be removed
      */
     remove(component) {
         if (component.name)
@@ -123,7 +123,7 @@ export class ComponentRegistry {
     /**
      * Function that adapt speed of all components
      * @public
-     * @param {SpeedLevel} speedLevel
+     * @param {SpeedLevel} speedLevel - speed lever for updating
      */
     updateAllSpeedAdaptable(speedLevel) {
         this.speedAdaptableComponents.forEach((speedAdaptableComponent) => {
@@ -135,8 +135,8 @@ export class ComponentRegistry {
      * Throws error if component is not present
      * @public
      * @template {keyof RegistryMap} T
-     * @param {T} componentName
-     * @returns {RegistryMap[T]}
+     * @param {T} componentName - name of the component
+     * @returns {RegistryMap[T]} - component from registry
      */
     get(componentName) {
         const componentToReturn = this.registry.get(componentName);
@@ -149,8 +149,8 @@ export class ComponentRegistry {
      * Getter for existing components that are in ComponentRegistry
      * @public
      * @template {keyof RegistryMap} T
-     * @param {T} componentName
-     * @returns {RegistryMap[T]}
+     * @param {T} componentName - component name
+     * @returns {RegistryMap[T]} - component from registry
      */
     getIfExists(componentName) {
         const componentToReturn = this.registry.get(componentName);
@@ -160,8 +160,8 @@ export class ComponentRegistry {
      * Helper function to check if the component is present in ComponentRegistry
      * @public
      * @template {keyof RegistryMap} T
-     * @param {T} componentName
-     * @returns {boolean}
+     * @param {T} componentName - component name
+     * @returns {boolean} - true if component is present
      */
     has(componentName) {
         return this.registry.has(componentName);
@@ -169,7 +169,7 @@ export class ComponentRegistry {
     /**
      * Function for adding components
      * @public
-     * @param {Container[]} components
+     * @param {Container[]} components - components to be added
      */
     addMany(components) {
         for (const component of components) {
@@ -179,7 +179,7 @@ export class ComponentRegistry {
     /**
      * Function for removing components
      * @public
-     * @param {Container[]} components
+     * @param {Container[]} components - components to be removed
      */
     removeMany(components) {
         for (const component of components) {

package/dist/Rainman/Rainman.js

@@ -28,6 +28,7 @@ export class RainMan {
         RainMan.settingsStore = settingStore;
         RainMan.componentRegistry = new ComponentRegistry(app);
         RainMan.globals = {
+            shouldShowModals: false,
             currency: Currencies["USD"],
         };
     }

package/dist/Rainman/types.d.ts

@@ -66,6 +66,7 @@ export type AppConfig = RequiredAppConfig & DeepPartial<OptionalAppConfig>;
  */
 export interface Globals {
     currency: Currency;
+    shouldShowModals: boolean;
     actionsAfterClosureWebSocket?: () => void;
     disableSpeedPopup?: (value: boolean) => void;
     handleDisablingButtons?: (value?: boolean) => void;

package/dist/SettingsUI/components/AutoplaySettings/index.jsx

@@ -49,7 +49,7 @@ export const AutoplaySettings = observer(() => {
     useEffect(() => {
         updateLimitsBounds(initialAutoSpinCount);
     }, []);
-    const { singleWinExceeds, balancedIncreased, balancedDecreased, howManyAutoSpinsLeft, infinitySpinsEnabled, setSingleWinExceeds, setBalancedIncreased, setBalancedDecreased, setAutoSpinsCount, flipInfinitySpinsFlag, resetAutoplaySettings, } = settingStore;
+    const { singleWinExceeds, balancedIncreased, balancedDecreased, howManyAutoSpinsLeft, infinitySpinsEnabled, setSingleWinExceeds, setBalancedIncreased, setBalancedDecreased, setAutoSpinsCount, flipInfinitySpinsFlag, resetAutoplaySettings, isAutoplayEnabled, } = settingStore;
     return (<div className="autoplay-settings">
             <CloseModalButton layerId={UI_ITEMS.autoplay}/>
             <div className="autoplay-settings__title">
@@ -110,7 +110,11 @@ export const AutoplaySettings = observer(() => {
         }}>
                     <p>{i18next.t("cancel")}</p>
                 </button>
-                <button id={COMPONENTS.autoSpinConfirm} onClick={() => settingStore.decreaseAutoSpinsCount()} className="autoplay-settings__confirmation-button">
+                <button id={COMPONENTS.autoSpinConfirm} onClick={() => {
+            if (isAutoplayEnabled)
+                return;
+            settingStore.decreaseAutoSpinsCount();
+        }} className="autoplay-settings__confirmation-button">
                     <p>{i18next.t("confirm")}</p>
                 </button>
             </div>

package/dist/application/ButtonsEventManager/ButtonsEventManager.js

@@ -304,7 +304,7 @@ export class ButtonsEventManager {
      * @param {string} layerName - name of layer
      */
     handleModalInvocation(layerName) {
-        if (this.checkAnyLayerIsPresent(layerName))
+        if (this.checkAnyLayerIsPresent(layerName) && RainMan.globals.shouldShowModals)
             return;
         const layer = window.document.getElementById(layerName);
         if (layer !== null) {

package/dist/application/SoundManager/types.d.ts

@@ -26,6 +26,7 @@
  * @property {string} mediumWin - on medium win - this sound is played when win of all streaks is more than x1.1 * bet and less than x5 * bet
  * @property {string} highWin - on high win - this sound is played when win of all streaks is more than x5.1 * bet and less than x15 * bet
  * @property {string} veryHighWin - on very high win - this sound is played when win of all streaks is more than x15.1 * bet
+ * @property {string} mysterySymbol - on mystery symbol appearance on the screen
  * @typedef {SoundTracks}
  */
 export declare const SoundTracks: SoundTracks;
@@ -55,6 +56,7 @@ export interface SoundTracks {
     specialSymbolOnReel: "specialSymbolOnReel";
     start: "start";
     symbol: "symbol";
+    mysterySymbol: "mysterySymbol";
 }
 export type SoundTrack = SoundTracks[keyof SoundTracks];
 /**

package/dist/application/SoundManager/types.js

@@ -26,6 +26,7 @@
  * @property {string} mediumWin - on medium win - this sound is played when win of all streaks is more than x1.1 * bet and less than x5 * bet
  * @property {string} highWin - on high win - this sound is played when win of all streaks is more than x5.1 * bet and less than x15 * bet
  * @property {string} veryHighWin - on very high win - this sound is played when win of all streaks is more than x15.1 * bet
+ * @property {string} mysterySymbol - on mystery symbol appearance on the screen
  * @typedef {SoundTracks}
  */
 export const SoundTracks = {
@@ -54,4 +55,5 @@ export const SoundTracks = {
     specialSymbolOnReel: "specialSymbolOnReel",
     start: "start",
     symbol: "symbol",
+    mysterySymbol: "mysterySymbol",
 };

package/dist/application/SpeedState/SpeedLevelHandler.d.ts

@@ -20,10 +20,13 @@ export declare class SpeedLevelHandler {
     /**
      * Setter for speed level
      * @param {SpeedLevel} newSpeedLevel - new speed level
+     * @throws {Error} - if no matched speed level
      */
     setSpeed(newSpeedLevel: SpeedLevel): void;
     /**
      * Function for setting next speed level
+     * This will after switching speed level check if the speed level is normal or fast
+     * and if so, it will disable the speed popup
      */
     nextSpeed(): void;
     /**

package/dist/application/SpeedState/SpeedLevelHandler.js

@@ -1,3 +1,4 @@
+import { RainMan } from "../../Rainman";
 import { DEFAULT_SPEED, SPEED_LEVELS } from "./SpeedLevel";
 /**
  * Class for handling speed levels
@@ -29,6 +30,7 @@ export class SpeedLevelHandler {
     /**
      * Setter for speed level
      * @param {SpeedLevel} newSpeedLevel - new speed level
+     * @throws {Error} - if no matched speed level
      */
     setSpeed(newSpeedLevel) {
         switch (newSpeedLevel) {
@@ -47,8 +49,11 @@ export class SpeedLevelHandler {
     }
     /**
      * Function for setting next speed level
+     * This will after switching speed level check if the speed level is normal or fast
+     * and if so, it will disable the speed popup
      */
     nextSpeed() {
+        RainMan.globals.disableSpeedPopup?.(true);
         if (this.shouldResetSpeedOptionsLoop()) {
             this.chosenSpeedLevel = 0;
             return;

package/dist/components/symbols/AbstractSymbolsColumn.d.ts

@@ -4,7 +4,7 @@ import { DropTransformationDetails, SymbolReel } from "../../connectivity";
 import { Nullable, VoidPromiseResolver } from "../../utils";
 import { AbstractColumnsContainer, AbstractFrame } from "../frame";
 import { AbstractSymbolBase } from "./AbstractSymbolBase";
-import { AnimationTimeSettings } from "./types";
+import { AnimationTimeSettings, Phase } from "./types";
 /**
  * Class represent single column in {@link ColumnsContainer}. It contains array of {@link AbstractSymbolBase}
  * @abstract
@@ -18,12 +18,12 @@ export declare abstract class AbstractSymbolsColumn extends Container implements
     allSymbols: SymbolId[];
     spinning: boolean;
     speedLevelMapper: import("../../application").SpeedLevelDirectory<number>;
-    protected symbols: Array<AbstractSymbolBase>;
+    symbols: Array<AbstractSymbolBase>;
     private velocity;
     protected velocityMultiplier: number;
     private previousVelocityMultiplier;
     private spritesCount;
-    private phase;
+    protected phase: Phase;
     private ending;
     private lastEnding;
     private tween;
@@ -34,11 +34,12 @@ export declare abstract class AbstractSymbolsColumn extends Container implements
     private droppingTweens;
     private movingDownSymbols;
     private droppingDownSymbols;
-    private topMostSymbol;
+    protected topMostSymbol: Nullable<AbstractSymbolBase>;
     private triggerNextColumn;
     private triggerNextColumnPromise;
     private spinEndPromise;
     skipHidingMysteryFx: boolean;
+    protected mysterySymbol: Nullable<SymbolId>;
     protected bonusSymbol: Nullable<SymbolId>;
     protected frozenSymbol: Nullable<AbstractSymbolBase>;
     private readonly _id;
@@ -68,6 +69,7 @@ export declare abstract class AbstractSymbolsColumn extends Container implements
     private changePhase;
     private moveToTop;
     protected shouldPlaySpecialRollStopSound(): boolean;
+    private shouldPlayMysteryStopSound;
     handleStopping(): void;
     protected abstract createNewSymbol(): AbstractSymbolBase;
     private initSymbolSprites;
@@ -77,7 +79,7 @@ export declare abstract class AbstractSymbolsColumn extends Container implements
     private ensureTopOffset;
     private swapSymbolFace;
     private fixZOrder;
-    private doStop;
+    protected doStop(): Promise<void>;
     private stopSymbols;
     protected getSymbolsSortedByYPosition(): AbstractSymbolBase[];
     /**

package/dist/components/symbols/AbstractSymbolsColumn.js

@@ -41,6 +41,7 @@ export class AbstractSymbolsColumn extends Container {
     triggerNextColumnPromise = null;
     spinEndPromise = null;
     skipHidingMysteryFx = false;
+    mysterySymbol = null;
     bonusSymbol = null;
     frozenSymbol = null;
     _id;
@@ -344,14 +345,29 @@ export class AbstractSymbolsColumn extends Container {
             .flat()
             .filter((symbol) => symbol && symbol.id === this.bonusSymbol).length >= 1);
     }
+    shouldPlayMysteryStopSound() {
+        return (Array.from({ length: RainMan.config.numberOfColumns }, (_, i) => i)
+            .map((i) => {
+            const column = this.columnsContainer.getColumnAtPosition(i);
+            if (column !== this)
+                return null;
+            return column.symbols.slice(0, RainMan.config.numberOfRows);
+        })
+            .flat()
+            .filter((symbol) => symbol && symbol.id === this.mysterySymbol).length >= 1);
+    }
     handleStopping() {
         if (!this.topMostSymbol || this.phase === Phase.END)
             return;
         if (this.topMostSymbol.y >= this.tileHeight / 2) {
             if (!this.columnsContainer.quickReelsStop &&
                 RainMan.settingsStore.currentSpeed !== SPEED_LEVELS.fast &&
-                !this.areAnyFrozenTiles())
+                !this.areAnyFrozenTiles()) {
                 SoundManager.play(this.shouldPlaySpecialRollStopSound() ? SoundTracks.specialSymbolOnReel : SoundTracks.rollStop);
+                if (this.shouldPlayMysteryStopSound()) {
+                    SoundManager.play(SoundTracks.mysterySymbol);
+                }
+            }
             this.fixStationaryPositions();
             this.doStop();
             return;

package/dist/controllers/AbstractController.js

@@ -276,6 +276,12 @@ export class AbstractController {
     changeGamePhase(newPhase) {
         logInfo(`👋🏼👋🏼👋🏼👋🏼 ${this.gamePhase} --> ${newPhase}`);
         this.gamePhase = newPhase;
+        if (this.gamePhase === gamePhases.HANDLING_ACTIONS ||
+            this.gamePhase === gamePhases.STOPPING_HANDLING_ACTIONS ||
+            this.gamePhase === gamePhases.SPINNING ||
+            this.gamePhase === gamePhases.GAME_SUMMARY) {
+            RainMan.globals.shouldShowModals = false;
+        }
         this.handleDisablingButtons(true);
         this.setMessageBoxBasedOnPhase(newPhase);
         this.setRefreshButtonBasedOnPhase(newPhase);
@@ -366,6 +372,7 @@ export class AbstractController {
      */
     handleSpinLogic() {
         this.handleDisablingButtons(true);
+        RainMan.globals.shouldShowModals = false;
         if (this.mainContainer.freeSpinPlate) {
             if (this.mainContainer.freeSpinPlate.shownAt === null ||
                 performance.now() - this.mainContainer.freeSpinPlate.shownAt <
@@ -421,6 +428,7 @@ export class AbstractController {
      */
     throttledSpin() {
         this.handleDisablingButtons(true);
+        RainMan.globals.shouldShowModals = false;
         const elementsToSkipHide = [];
         if (performance.now() - this.buttonsEventManager.speedPopupShownAt <
             RainMan.config.durationOfActions.speedPopupVisibleTime) {
@@ -473,6 +481,7 @@ export class AbstractController {
      * @returns {void} promise
      */
     autoplaySpin() {
+        RainMan.globals.shouldShowModals = false;
         if (!RainMan.settingsStore.howManyAutoSpinsLeft)
             return;
         if (!RainMan.settingsStore.infinitySpinsEnabled) {
@@ -480,6 +489,7 @@ export class AbstractController {
         }
         if (RainMan.settingsStore.howManyAutoSpinsLeft === 0) {
             this.uiController.messageBox.showIncentiveText();
+            RainMan.globals.shouldShowModals = false;
             this.disableAutoplay();
         }
         this.changeGamePhase(gamePhases.IDLE);
@@ -498,9 +508,10 @@ export class AbstractController {
     disableAutoplay() {
         RainMan.componentRegistry.get(AutoplayButton.registryName).activate(false);
         RainMan.componentRegistry.get(MessageBox.registryName).hideAutoSpinText();
-        RainMan.settingsStore.resetAutoplaySettings();
         RainMan.componentRegistry.get(BUTTONS.plus).flipDisabledFlag(false);
         RainMan.componentRegistry.get(BUTTONS.neg).flipDisabledFlag(false);
+        RainMan.settingsStore.resetAutoplaySettings();
+        RainMan.globals.shouldShowModals = false;
     }
     /**
      * This function is responsible for actions while fetching data
@@ -573,10 +584,15 @@ export class AbstractController {
      * @returns {Promise<void>}
      */
     async spin() {
-        if (this.uiController.currentBalance < RainMan.settingsStore.bet) {
+        RainMan.globals.shouldShowModals = false;
+        if (this.uiController.currentBalance < RainMan.settingsStore.bet &&
+            !RainMan.settingsStore.isFreeSpinsPlayEnabled) {
             try {
-                this.uiController.updateBet("highest");
+                if (RainMan.settingsStore.isAutoplayEnabled) {
+                    this.disableAutoplay();
+                }
                 this.handleDisablingButtons(false);
+                return;
             }
             catch (e) {
                 RainMan.componentRegistry.get(AutoplayButton.registryName).flipDisabledFlag(true);
@@ -695,6 +711,7 @@ export class AbstractController {
         this.handleDisablingButtons();
         RainMan.settingsStore.setModalsAvailability(true);
         await this.performActionsAfterSpin();
+        RainMan.globals.shouldShowModals = true;
     }
     /**
      *  Function for invoking free spin plate, invoked in mainContainer
@@ -732,6 +749,7 @@ export class AbstractController {
         this.invokeFreeSpinSummaryPlateAfterWin = false;
     }
     handleAutoplayLogic() {
+        RainMan.globals.shouldShowModals = false;
         this.autoSpinBalance += this.uiController.recentWin;
         const { balancedIncreased, balancedDecreased, singleWinExceeds } = RainMan.settingsStore;
         if (balancedIncreased > 0) {

package/dist/controllers/QuickStopController.d.ts

@@ -3,8 +3,6 @@ import { ButtonsEventManager } from "../application";
  * This controller is used to show the speed popup and handle quick stops
  * After 4 quick stops, the speed popup will be shown.
  * Number of quick spin can be adjusted in {@link MAX_QUICK_STOPS}
- *
- *
  */
 export declare class QuickStopController {
     private buttonsEventManager;

package/dist/controllers/QuickStopController.js

@@ -5,8 +5,6 @@ const MAX_QUICK_STOPS = 4;
  * This controller is used to show the speed popup and handle quick stops
  * After 4 quick stops, the speed popup will be shown.
  * Number of quick spin can be adjusted in {@link MAX_QUICK_STOPS}
- *
- *
  */
 export class QuickStopController {
     buttonsEventManager;
@@ -16,7 +14,7 @@ export class QuickStopController {
     speedPopupDisabled = false;
     constructor(buttonsEventManager) {
         this.buttonsEventManager = buttonsEventManager;
-        RainMan.globals.disableSpeedPopup = this.handleSpeedPopupInvocation.bind(this);
+        RainMan.globals.disableSpeedPopup = this.setSpeedPopupDisabled.bind(this);
     }
     handleInvokingSpeedPopup() {
         if (!this.quickStopCounterLock &&

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "pixi-rainman-game-engine",
-    "version": "0.2.11",
+    "version": "0.2.13",
     "description": "This repository contains all of the mechanics that used in rainman games.",
     "main": "./dist/index.js",
     "module": "./dist/index.js",