pixi-rainman-game-engine 0.3.0 → 0.3.2

package/dist/components/AbstractMainContainer/AbstractMainContainer.js

@@ -22,6 +22,7 @@ import { MessageBox } from "../messageBox";
  * - {@link overlay} - overlay, used when modal is shown
  * - {@link gambleGame} - gamble game
  * @abstract
+ * @class AbstractMainContainer
  * @augments {Container}
  */
 export class AbstractMainContainer extends Container {
@@ -68,6 +69,7 @@ export class AbstractMainContainer extends Container {
     }
     /**
      * Function for invoking mystery win plate
+     * @public
      * @param {string} _animationName - The name of the animation to play.
      * @param {string} _popupAnimation - The name of the popup animation to play.
      * @param {WinTypeId} _winType - The type of win to display.
@@ -78,7 +80,9 @@ export class AbstractMainContainer extends Container {
     async invokeMysteryWinPlate(_animationName, _popupAnimation, _winType, _amount, _isAdditionalFreeSpins) { }
     /**
      * This function initializes the spines that should be paused when the battery saver is on
+     * @protected
      * @param {typeof RainMan.settingsStore.containersWithSpines} containersWithSpines - array of containers with spines
+     * @returns {void}
      */
     triggerStoreInitState(...containersWithSpines) {
         RainMan.settingsStore.containersWithSpines.push(...containersWithSpines);
@@ -86,6 +90,7 @@ export class AbstractMainContainer extends Container {
     }
     /**
      * Function for getting free spin plate
+     * @public
      * @returns {Nullable<AbstractFreeSpinContainer>} The container for the free spin plate, or null if not set.
      */
     get freeSpinPlate() {
@@ -93,6 +98,7 @@ export class AbstractMainContainer extends Container {
     }
     /**
      * Function for getting free spin summary
+     * @public
      * @returns {Nullable<AbstractFreeSpinContainer>} The container for the free spin summary, or null if not set.
      */
     get freeSpinSummary() {
@@ -100,6 +106,7 @@ export class AbstractMainContainer extends Container {
     }
     /**
      * Function for creating free spin container
+     * @protected
      * @param {() => void} _resolver - resolver for promise
      * @param {number} _freeSpinCount - number of free spins
      * @param {boolean} _isAdditionalFreeSpin - flag for displaying additional free spins
@@ -110,6 +117,7 @@ export class AbstractMainContainer extends Container {
     }
     /**
      * Function for creating bonus win container
+     * @protected
      * @returns {Nullable<UpdatableSpineContainer>} The container for the bonus win animation, or null.
      */
     createBonusWinContainer() {
@@ -117,6 +125,7 @@ export class AbstractMainContainer extends Container {
     }
     /**
      * Creates a container for the super bonus win animation.
+     * @protected
      * @returns {UpdatableSpineContainer | null} The container for the super bonus win animation, or null.
      */
     createSuperBonusWinContainer() {
@@ -124,6 +133,7 @@ export class AbstractMainContainer extends Container {
     }
     /**
      * Function for creating mystery win container
+     * @protected
      * @returns {Nullable<UpdatableSpineContainer>} The container for the mystery win animation, or null.
      */
     createMysteryWinContainer() {
@@ -131,6 +141,7 @@ export class AbstractMainContainer extends Container {
     }
     /**
      * Function for creating mystery bonus container
+     * @protected
      * @param {string} _animationName - animation name for the mystery bonus container
      * @returns {Nullable<UpdatableSpineContainer>} The container for the mystery bonus animation, or null.
      */
@@ -141,15 +152,20 @@ export class AbstractMainContainer extends Container {
      * Function for specifying the container for the free spin summary
      * This needs to be implemented in each game
      * In some cases there will be free spin button that should be removed during free spins
+     * @protected
+     * @returns {void}
      */
     changeContainerForFreeSpin() { }
     /**
      * Function for specifying the container for base game
      * This needs to be implemented in each game
+     * @protected
+     * @returns {void}
      */
     changeContainerForBaseGame() { }
     /**
      * Function for creating roulette win container
+     * @protected
      * @param {string} _animationName animation name for the roulette container
      * @returns {Nullable<UpdatableSpineContainer>} The container for the roulette win animation, or null.
      */
@@ -158,6 +174,7 @@ export class AbstractMainContainer extends Container {
     }
     /**
      * Function for destroying the roulette win container
+     * @protected
      * @param {WinTypeId} winType win type of jackpot roulette win
      * @returns {void}
      */
@@ -173,6 +190,7 @@ export class AbstractMainContainer extends Container {
     }
     /**
      * Function for invoking mystery bonus container
+     * @protected
      * @param {string} animationName animation name for the mystery bonus container
      * @returns {Promise<void>}
      */
@@ -196,8 +214,10 @@ export class AbstractMainContainer extends Container {
      * Function for invoking free spin plate
      * If game draw an additional free spin, you can set isAdditionalFreeSpin to true
      * and it will display additional free spin plate
+     * @public
      * @param {number} freeSpinCount - number of free spins
      * @param {boolean} isAdditionalFreeSpin - flag for displaying additional free spins
+     * @returns {Promise<void>}
      */
     async invokeFreeSpinPlate(freeSpinCount, isAdditionalFreeSpin = false) {
         const refreshButton = RainMan.componentRegistry.get(RefreshButton.registryName);
@@ -220,6 +240,7 @@ export class AbstractMainContainer extends Container {
     }
     /**
      * Function for creating free spin summary
+     * @protected
      * @param {void} _resolver - resolver for promise
      * @param {number} _freeSpinCount - number of free spins
      * @param {number} _winAmount - win amount during free spins
@@ -230,8 +251,10 @@ export class AbstractMainContainer extends Container {
     }
     /**
      * Function for invoking free spin summary
+     * @public
      * @param {number} freeSpinCount - amount of free spins
      * @param {number} winAmount - win amount during free spins
+     * @returns {Promise<void>}
      */
     async invokeFreeSpinSummary(freeSpinCount, winAmount) {
         const refreshButton = RainMan.componentRegistry.get(BUTTONS.refresh);
@@ -253,11 +276,13 @@ export class AbstractMainContainer extends Container {
     }
     /**
      * Function for hiding free spin summary
+     * @public
      * @returns {void}
      */
     hideFreeSpinSummary() {
-        if (!this.freeSpinSummary)
+        if (!this.freeSpinSummary) {
             return;
+        }
         this.freeSpinSummary.onClick();
         this.removeChild(this.freeSpinSummary);
         this._freeSpinSummary = null;
@@ -267,6 +292,8 @@ export class AbstractMainContainer extends Container {
      * Function for showing the overlay
      * This function creates a semi-transparent overlay that covers the entire screen.
      * It is used to block interactions with the game while a modal is displayed.
+     * @protected
+     * @returns {void}
      */
     showOverlay() {
         const { width, height } = RainMan.app.screen;
@@ -282,6 +309,8 @@ export class AbstractMainContainer extends Container {
     /**
      * Function for hiding the overlay
      * This function removes the overlay from the main container and sets it to null.
+     * @protected
+     * @returns {void}
      */
     hideOverlay() {
         if (this.overlay) {
@@ -291,6 +320,7 @@ export class AbstractMainContainer extends Container {
     }
     /**
      * Function for getting the time since the big win was invoked.
+     * @public
      * @returns {number} The time in milliseconds since the big win was invoked, or 0 if it has not been invoked.
      */
     get bigWinVisibleFor() {
@@ -298,6 +328,7 @@ export class AbstractMainContainer extends Container {
     }
     /**
      * Function for getting the free spin button.
+     * @public
      * @returns {typeof this.freeSpinButton} The free spin button instance.
      */
     getFreeSpinButton() {
@@ -305,6 +336,7 @@ export class AbstractMainContainer extends Container {
     }
     /**
      * Function for getting the time since the mystery win was invoked.
+     * @public
      * @returns {number} The time in milliseconds since the mystery win was invoked, or 0 if it has not been invoked.
      */
     get mysteryWinVisibleFor() {
@@ -312,6 +344,7 @@ export class AbstractMainContainer extends Container {
     }
     /**
      * Function for getting the time since the bonus win was invoked.
+     * @public
      * @returns {number} The time in milliseconds since the bonus win was invoked, or 0 if it has not been invoked.
      */
     get bonusWinVisibleFor() {
@@ -319,6 +352,7 @@ export class AbstractMainContainer extends Container {
     }
     /**
      * Function for getting the time since the super bonus win was invoked.
+     * @public
      * @returns {number} The time in milliseconds since the super bonus win was invoked, or 0 if it has not been invoked.
      */
     get superBonusWinVisibleFor() {
@@ -326,6 +360,8 @@ export class AbstractMainContainer extends Container {
     }
     /**
      * Function for invoking big win animation, using `this.createBigWinContainer()` abstract function.
+     * @public
+     * @returns {void}
      */
     invokeBigWin() {
         if (this.bigWinContainer !== null) {
@@ -343,6 +379,8 @@ export class AbstractMainContainer extends Container {
     }
     /**
      * Function for invoking big win animation, using `this.createSuperBonusWinContainer()` abstract function.
+     * @public
+     * @returns {void}
      */
     invokeSuperBonusWin() {
         if (this.superBonusWinContainer !== null) {
@@ -350,8 +388,9 @@ export class AbstractMainContainer extends Container {
         }
         const { width, height } = RainMan.app.screen;
         this.superBonusWinContainer = this.createSuperBonusWinContainer();
-        if (!this.superBonusWinContainer)
+        if (!this.superBonusWinContainer) {
             return;
+        }
         this.superBonusWinContainer.x = width / 2;
         this.superBonusWinContainer.y = height / 2;
         this.superBonusWinContainer.resize();
@@ -361,14 +400,17 @@ export class AbstractMainContainer extends Container {
     }
     /**
      * Function for invoking big win animation, using `this.createBonusWinContainer()` abstract function.
+     * @public
+     * @returns {void}
      */
     invokeBonusWin() {
         if (this.bonusWinContainer !== null) {
             throw new Error("😡 Bonus Win is already declared");
         }
         this.bonusWinContainer = this.createBonusWinContainer();
-        if (!this.bonusWinContainer)
+        if (!this.bonusWinContainer) {
             return;
+        }
         this.bonusWinContainer.resize();
         this.bonusWinContainer.parentLayer = UXLayer;
         this.addChild(this.bonusWinContainer);
@@ -376,6 +418,8 @@ export class AbstractMainContainer extends Container {
     }
     /**
      * Function for invoking mystery win animation, using `this.createMysteryWinContainer()` abstract function.
+     * @public
+     * @returns {void}
      */
     invokeMysteryWin() {
         if (this.mysteryWinContainer !== null) {
@@ -383,8 +427,9 @@ export class AbstractMainContainer extends Container {
         }
         const { width, height } = RainMan.app.screen;
         this.mysteryWinContainer = this.createMysteryWinContainer();
-        if (!this.mysteryWinContainer)
+        if (!this.mysteryWinContainer) {
             return;
+        }
         this.mysteryWinContainer.x = width / 2;
         this.mysteryWinContainer.y = height / 2;
         this.mysteryWinContainer.resize();
@@ -396,10 +441,13 @@ export class AbstractMainContainer extends Container {
      * Function for destroying the big win container
      * This function removes the big win container from the main container,
      * destroys its animations, and sets it to null.
+     * @public
+     * @returns {void}
      */
     destroyBigWin() {
-        if (this.bigWinContainer === null)
+        if (this.bigWinContainer === null) {
             return;
+        }
         this.removeChild(this.bigWinContainer);
         this.bigWinContainer.destroyAnimations();
         this.bigWinContainer.destroy({ children: true });
@@ -408,10 +456,13 @@ export class AbstractMainContainer extends Container {
     }
     /**
      * Function for destroying the mystery win container
+     * @public
+     * @returns {void}
      */
     destroyMysteryWin() {
-        if (this.mysteryWinContainer === null)
+        if (this.mysteryWinContainer === null) {
             return;
+        }
         this.removeChild(this.mysteryWinContainer);
         this.mysteryWinContainer.destroyAnimations();
         this.mysteryWinContainer.destroy({ children: true });
@@ -420,10 +471,14 @@ export class AbstractMainContainer extends Container {
     }
     /**
      * Function for destroying the bonus win container
+     * **NOTE**: This is used in game like LDE/LP, where there is different behavior for bonus wins
+     * @public
+     * @returns {void}
      */
     destroyBonusWin() {
-        if (this.bonusWinContainer === null)
+        if (this.bonusWinContainer === null) {
             return;
+        }
         this.removeChild(this.bonusWinContainer);
         this.bonusWinContainer.destroyAnimations();
         this.bonusWinContainer.destroy({ children: true });
@@ -432,19 +487,29 @@ export class AbstractMainContainer extends Container {
     }
     /**
      * Function for destroying the super bonus win container
+     * **NOTE**: This is used in game like LDE/LP, where there is different behavior for super bonus wins
+     * @public
+     * @returns {void}
      */
     destroySuperBonusWin() {
-        if (this.superBonusWinContainer === null)
+        if (this.superBonusWinContainer === null) {
             return;
+        }
         this.removeChild(this.superBonusWinContainer);
         this.superBonusWinContainer.destroyAnimations();
         this.superBonusWinContainer.destroy({ children: true });
         this.superBonusWinContainer = null;
         this._superBonusWinInvokedAt = null;
     }
+    /**
+     * This is used in game like DC where we have container that draws the bonus or jackpots
+     * @public
+     * @returns {void}
+     */
     destroyMysteryBonus() {
-        if (!this.mysteryBonusContainer)
+        if (!this.mysteryBonusContainer) {
             return;
+        }
         this.removeChild(this.mysteryBonusContainer);
         this.mysteryBonusContainer.destroyAnimations();
         this.mysteryBonusContainer.destroy({ children: true });
@@ -452,6 +517,7 @@ export class AbstractMainContainer extends Container {
     }
     /**
      * Function for invoking gamble game
+     * @public
      * @returns {Promise<void>} - A promise that resolves when the gamble game is finished.
      */
     async invokeGambleGame() {
@@ -475,6 +541,7 @@ export class AbstractMainContainer extends Container {
     /**
      * Function for creating the under frame panel.
      * This panel is used in mobile portrait mode to display additional information.
+     * @protected
      * @returns {Graphics | Sprite} The under frame panel as a Graphics or Sprite object.
      */
     createUnderFramePanel() {
@@ -486,6 +553,7 @@ export class AbstractMainContainer extends Container {
     /**
      * Function for enabling mobile portrait mode.
      * It creates the under frame panel, portrait play buttons, and adds them to the container.
+     * @public
      * @returns {void}
      */
     enableForMobile() {
@@ -502,6 +570,7 @@ export class AbstractMainContainer extends Container {
     }
     /**
      * Function for enabling landscape mode.
+     * @public
      * @returns {void}
      */
     enableForLandscape() {
@@ -511,6 +580,7 @@ export class AbstractMainContainer extends Container {
     }
     /**
      * Function for positioning the round win container.
+     * @protected
      * @returns {void}
      */
     positionRoundWinContainer() {
@@ -525,9 +595,11 @@ export class AbstractMainContainer extends Container {
     }
     /**
      * Function for invoking the roulette win plate.
+     * @public
      * @param {string} winAnimationName The name of the win animation.
      * @param {WinTypeId} winType The type of win.
      * @param {string} startAnimationName The name of the start animation defaulting to "start".
+     * @returns {Promise<void>}
      */
     async invokeRouletteWinPlate(winAnimationName, winType, startAnimationName = "start") {
         this.rouletteWinContainer = this.createRouletteContainer(startAnimationName);
@@ -563,6 +635,8 @@ export class AbstractMainContainer extends Container {
     }
     /**
      * Function for disabling components for mobile portrait orientation.
+     * @public
+     * @returns {void}
      */
     disableForMobile() {
         if (this.logo) {
@@ -580,6 +654,8 @@ export class AbstractMainContainer extends Container {
     }
     /**
      * Function for disabling components for landscape orientation.
+     * @public
+     * @returns {void}
      */
     disableForLandscape() {
         if (this.landscapePlayButtons !== null) {
@@ -592,6 +668,8 @@ export class AbstractMainContainer extends Container {
      * Function for resizing the main container and its components.
      * This function removes the current frame and any win containers,
      * resizes the message box, background, animated front,
+     * @public
+     * @returns {void}
      */
     resize() {
         this.removeChild(this._frame);
@@ -628,6 +706,7 @@ export class AbstractMainContainer extends Container {
     }
     /**
      * Function for creating the left buttons
+     * @protected
      * @returns {LeftButtons} - Returns a new instance of LeftButtons.
      */
     createLeftButtons() {
@@ -635,6 +714,7 @@ export class AbstractMainContainer extends Container {
     }
     /**
      * Function for creating the right buttons
+     * @protected
      * @returns {RightButtons} - Returns a new instance of RightButtons.
      */
     createRightButtons() {
@@ -642,6 +722,7 @@ export class AbstractMainContainer extends Container {
     }
     /**
      * Function for creating the left buttons for mobile portrait orientation
+     * @protected
      * @returns {LeftButtonsMobile} - Returns a new instance of LeftButtonsMobile for mobile portrait orientation.
      */
     createLeftButtonsMobile() {
@@ -649,6 +730,7 @@ export class AbstractMainContainer extends Container {
     }
     /**
      * Function for creating the right buttons for mobile portrait orientation
+     * @protected
      * @returns {RightButtonsMobile} - Returns a new instance of RightButtonsMobile for mobile portrait orientation.
      */
     createRightButtonsMobile() {
@@ -691,9 +773,9 @@ export class AbstractMainContainer extends Container {
      * It checks the current device orientation and creates the appropriate left and right buttons.
      * It also removes the previous left and right buttons from the container.
      * It resizes the right buttons if the current orientation is "mobile-portrait".
-     * @protected
-     * @returns {void}
+     * @private
      * @memberof AbstractMainContainer
+     * @returns {void}
      */
     initComponentsForScreenRatio() {
         const currentOrientation = getDeviceOrientation();
@@ -738,6 +820,8 @@ export class AbstractMainContainer extends Container {
      * under frame panel, overlay, big win container, super bonus win container, bonus win container,
      * mystery win container, gamble game, bottom panel, free spin plate, and
      * free spin summary.
+     * @private
+     * @returns {void}
      */
     resizeDependentComponents() {
         const resizingHelper = globalMinRatio();
@@ -804,6 +888,8 @@ export class AbstractMainContainer extends Container {
     /**
      * This method is used to refresh the layers in the main container.
      * It removes the existing layers and adds them back in the correct order.
+     * @protected
+     * @returns {void}
      */
     refreshLayers() {
         this.removeChild(BackgroundLayer);

package/dist/components/DoubleBorderText/DoubleBorderText.d.ts

@@ -0,0 +1,10 @@
+import { Container, TextStyle } from "pixi.js";
+/**
+ * Class for creating double border text
+ * @class DoubleBorderText
+ * @typedef {DoubleBorderText}
+ * @augments {Container}
+ */
+export declare class DoubleBorderText extends Container {
+    constructor(text: string, outerStyle: () => TextStyle, innerStyle: () => TextStyle);
+}

package/dist/components/DoubleBorderText/DoubleBorderText.js

@@ -0,0 +1,24 @@
+import { Container, Text } from "pixi.js";
+/**
+ * Class for creating double border text
+ * @class DoubleBorderText
+ * @typedef {DoubleBorderText}
+ * @augments {Container}
+ */
+export class DoubleBorderText extends Container {
+    constructor(text, outerStyle, innerStyle) {
+        super();
+        const outerStyleData = outerStyle();
+        const outerText = new Text(text, outerStyleData);
+        outerText.anchor.set(0.5);
+        const innerText = new Text(text, innerStyle());
+        innerText.anchor.set(0.5);
+        this.addChild(outerText);
+        this.addChild(innerText);
+        if (outerStyleData.dropShadow) {
+            const dropShadowDistance = outerStyleData.dropShadowDistance;
+            innerText.x -= dropShadowDistance / 2;
+            innerText.y -= dropShadowDistance / 2;
+        }
+    }
+}

package/dist/components/DoubleBorderText/index.d.ts

@@ -0,0 +1 @@
+export * from "./DoubleBorderText";

package/dist/components/DoubleBorderText/index.js

@@ -0,0 +1 @@
+export * from "./DoubleBorderText";

package/dist/components/GambleGame/GambleGame.d.ts

@@ -26,11 +26,50 @@ export declare class GambleGame extends Container {
     private readonly previousGamblesContainer;
     private previousGambles;
     constructor(cardSpineName: string, resolver: (newBalance: number) => void, lastWinAmount: number, balanceValue: number);
+    /**
+     * Function for showing previous gamble
+     * @private
+     * @param {GambleCard[]} previousGambles all of the available cards
+     * @returns {void}
+     */
     private showPreviousGambles;
+    /**
+     * Function for closing gamble game modal
+     * This updated also the balance value
+     * @private
+     * @returns {void}
+     */
     private closeGame;
+    /**
+     * Function for updating double and win fields
+     * @private
+     * @param {number} winAmount win amount from gamble
+     * @returns {Promise<void>}
+     */
     private updateDoubleAndWinFields;
+    /**
+     * Function for losing double and win fields
+     * @private
+     * @returns {Promise<void>}
+     */
     private loseDoubleAndWinFields;
+    /**
+     * Function for handling gamble play
+     * @private
+     * @param {GambleCardColor} choice - The color choice for the gamble
+     * @returns {Promise<void>}
+     */
     private handleGamblePlay;
+    /**
+     * Function for resizing the gamble game components
+     * @public
+     * @returns {void}
+     */
     resize(): void;
+    /**
+     * Function for initializing child positions
+     * @private
+     * @returns {void}
+     */
     private initChildPositions;
 }

package/dist/components/GambleGame/GambleGame.js

@@ -62,6 +62,12 @@ export class GambleGame extends Container {
         });
         this.resize();
     }
+    /**
+     * Function for showing previous gamble
+     * @private
+     * @param {GambleCard[]} previousGambles all of the available cards
+     * @returns {void}
+     */
     showPreviousGambles(previousGambles) {
         const { width } = RainMan.app.screen;
         this.previousGambles.forEach((gambleCard) => this.previousGamblesContainer.removeChild(gambleCard));
@@ -77,19 +83,44 @@ export class GambleGame extends Container {
         this.previousGamblesContainer.y =
             this.previousGamblesText.y + this.previousGamblesText.height + this.previousGamblesContainer.height / 2;
     }
+    /**
+     * Function for closing gamble game modal
+     * This updated also the balance value
+     * @private
+     * @returns {void}
+     */
     closeGame() {
         RainMan.componentRegistry.get(BUTTONS.gamble).flipDisabledFlag(true);
         this.resolver(this.balanceValue);
     }
-    async updateDoubleAndWinFields(value) {
-        return Promise.all([this.gambleWin.update(value), this.currentWin.update(value / 2)]);
+    /**
+     * Function for updating double and win fields
+     * @private
+     * @param {number} winAmount win amount from gamble
+     * @returns {Promise<void>}
+     */
+    async updateDoubleAndWinFields(winAmount) {
+        return Promise.all([this.gambleWin.update(winAmount), this.currentWin.update(winAmount / 2)]);
     }
+    /**
+     * Function for losing double and win fields
+     * @private
+     * @returns {Promise<void>}
+     */
     async loseDoubleAndWinFields() {
+        RainMan.settingsStore.disableSpecialButtons();
         return Promise.all([this.gambleWin.loseUpdate(), this.currentWin.loseUpdate()]);
     }
+    /**
+     * Function for handling gamble play
+     * @private
+     * @param {GambleCardColor} choice - The color choice for the gamble
+     * @returns {Promise<void>}
+     */
     async handleGamblePlay(choice) {
-        if (this.lastWinAmount === 0)
+        if (this.lastWinAmount === 0) {
             return;
+        }
         this.redButton.flipDisabledFlag(true);
         this.blackButton.flipDisabledFlag(true);
         this.card.state.addAnimation(0, "wait", true, 0);
@@ -121,6 +152,11 @@ export class GambleGame extends Container {
             ]);
         }
     }
+    /**
+     * Function for resizing the gamble game components
+     * @public
+     * @returns {void}
+     */
     resize() {
         const { width, height } = RainMan.app.screen;
         this.x = 0;
@@ -129,6 +165,11 @@ export class GambleGame extends Container {
         this.height = height;
         this.initChildPositions();
     }
+    /**
+     * Function for initializing child positions
+     * @private
+     * @returns {void}
+     */
     initChildPositions() {
         this.removeChild(this.background);
         this.removeChild(this.frame);

package/dist/components/GambleGame/types.d.ts

@@ -1,4 +1,9 @@
 import { TextureMap } from "..";
+/**
+ * Type for mapping textures used in the gamble game
+ * This includes all buttons and card textures
+ * @typedef {GambleGameTextureMaps}
+ */
 export type GambleGameTextureMaps = {
     halveButton: TextureMap;
     collectButton: TextureMap;