pixi-rainman-game-engine 0.3.0 → 0.3.2

package/dist/components/buttons/buttonGroups/RightButtonsLandscape.d.ts

@@ -2,6 +2,7 @@ import { ResponsiveContainer } from "../../common";
 import { InfoButton, MoreButton, NegButton, SpeedControlButton, VolumeButton } from "../default";
 /**
  * Buttons for mobile landscape. It has a settings button and game information button.
+ * @augments {ResponsiveContainer}
  */
 export declare class RightButtonsLandscape extends ResponsiveContainer {
     protected readonly moreButton: MoreButton;
@@ -10,6 +11,16 @@ export declare class RightButtonsLandscape extends ResponsiveContainer {
     protected readonly negButton: NegButton;
     protected readonly speedControlButton: SpeedControlButton;
     constructor();
+    /**
+     * Function for removing children from the registry.
+     * @public
+     * @returns {void}
+     */
     removeChildrenFromRegistry(): void;
+    /**
+     * Function for repositioning the container.
+     * @protected
+     * @returns {void}
+     */
     protected reposition(): void;
 }

package/dist/components/buttons/buttonGroups/RightButtonsLandscape.js

@@ -6,6 +6,7 @@ import { REGISTRY } from "../registrynames";
 import { MOBILE_BUTTONS_GAP, MOBILE_PANEL_BUTTON_SCALE, MOBILE_X_OFFSET, MOBILE_Y_BOTTOM_OFFSET } from "./constants";
 /**
  * Buttons for mobile landscape. It has a settings button and game information button.
+ * @augments {ResponsiveContainer}
  */
 export class RightButtonsLandscape extends ResponsiveContainer {
     moreButton = new MoreButton(true);
@@ -34,6 +35,11 @@ export class RightButtonsLandscape extends ResponsiveContainer {
         ]);
         this.resize();
     }
+    /**
+     * Function for removing children from the registry.
+     * @public
+     * @returns {void}
+     */
     removeChildrenFromRegistry() {
         RainMan.componentRegistry.removeMany([
             this.moreButton,
@@ -43,6 +49,11 @@ export class RightButtonsLandscape extends ResponsiveContainer {
             this.speedControlButton
         ]);
     }
+    /**
+     * Function for repositioning the container.
+     * @protected
+     * @returns {void}
+     */
     reposition() {
         this.y = RainMan.app.screen.height;
         this.x = RainMan.app.screen.width;

package/dist/components/buttons/buttonGroups/RightButtonsMobile.d.ts

@@ -4,6 +4,7 @@ import { UpdatableTextComponent } from "../../updatable";
 import { InfoButton, NegButton, SpeedControlButton } from "../default";
 /**
  * Buttons for mobile version. It has a current bet and game information button.
+ * @augments {ResponsiveContainer}
  */
 export declare class RightButtonsMobile extends ResponsiveContainer {
     protected readonly infoButton: InfoButton;
@@ -11,7 +12,23 @@ export declare class RightButtonsMobile extends ResponsiveContainer {
     protected readonly speedControlButton: SpeedControlButton;
     protected bet: UpdatableTextComponent;
     constructor();
+    /**
+     * Function for removing children from the registry.
+     * @public
+     * @returns {void}
+     */
     removeChildrenFromRegistry(): void;
+    /**
+     * Function for repositioning components on mobile screens.
+     * @protected
+     * @returns {void}
+     */
     protected reposition(): void;
+    /**
+     * Function for updating the bet text style.
+     * @public
+     * @param {Partial<ITextStyle>} style new style that we want to override
+     * @returns {void}
+     */
     updateBetStyle(style: Partial<ITextStyle>): void;
 }

package/dist/components/buttons/buttonGroups/RightButtonsMobile.js

@@ -8,6 +8,7 @@ import { COMPONENTS, REGISTRY } from "../registrynames";
 import { MOBILE_BUTTONS_GAP, MOBILE_PANEL_BUTTON_SCALE, MOBILE_X_OFFSET, MOBILE_Y_BOTTOM_OFFSET } from "./constants";
 /**
  * Buttons for mobile version. It has a current bet and game information button.
+ * @augments {ResponsiveContainer}
  */
 export class RightButtonsMobile extends ResponsiveContainer {
     infoButton = new InfoButton(true);
@@ -28,9 +29,19 @@ export class RightButtonsMobile extends ResponsiveContainer {
         RainMan.componentRegistry.addMany([this.infoButton, this.bet, this.negButton, this.speedControlButton]);
         this.resize();
     }
+    /**
+     * Function for removing children from the registry.
+     * @public
+     * @returns {void}
+     */
     removeChildrenFromRegistry() {
         RainMan.componentRegistry.removeMany([this.infoButton, this.bet, this.negButton, this.speedControlButton]);
     }
+    /**
+     * Function for repositioning components on mobile screens.
+     * @protected
+     * @returns {void}
+     */
     reposition() {
         this.y = RainMan.app.screen.height;
         this.x = RainMan.app.screen.width;
@@ -39,6 +50,12 @@ export class RightButtonsMobile extends ResponsiveContainer {
         this.bet.y = MOBILE_Y_BOTTOM_OFFSET;
         this.bet.x = this.infoButton.x + this.infoButton.width + MOBILE_BUTTONS_GAP;
     }
+    /**
+     * Function for updating the bet text style.
+     * @public
+     * @param {Partial<ITextStyle>} style new style that we want to override
+     * @returns {void}
+     */
     updateBetStyle(style) {
         this.bet.updateBaseTextStyle(style);
     }

package/dist/components/buttons/default/AutoplayButton.d.ts

@@ -16,5 +16,11 @@ export declare class AutoplayButton extends BaseButton {
     private mobile;
     static readonly registryName = "autoplayButton";
     constructor(mobile?: boolean);
+    /**
+     * Function for switching the button texture
+     * @public
+     * @param {keyof typeof ButtonStates} state - The state to switch to
+     * @returns {void}
+     */
     switchTexture(state: keyof typeof ButtonStates): void;
 }

package/dist/components/buttons/default/AutoplayButton.js

@@ -39,10 +39,17 @@ export class AutoplayButton extends BaseButton {
         this.mobile = mobile;
         this.clickSound = SoundTracks.deactivationAutostart;
     }
+    /**
+     * Function for switching the button texture
+     * @public
+     * @param {keyof typeof ButtonStates} state - The state to switch to
+     * @returns {void}
+     */
     switchTexture(state) {
         super.switchTexture(state);
-        if (this.mobile)
+        if (this.mobile) {
             return;
+        }
         if (state === ButtonStates.ACTIVE ||
             state === ButtonStates.ACTIVE_OVER ||
             state === ButtonStates.ACTIVE_CLICKED) {

package/dist/components/buttons/default/GambleButton.d.ts

@@ -0,0 +1,13 @@
+import { BaseButton } from "../BaseButton";
+/**
+ * Class for a Gamble button in the game.
+ * Textures names should be "gamble.png", "gamble-over.png", and "gamble-clicked.png".
+ *  @class TakeButton
+ *  @augments {BaseButton}
+ */
+export declare class GambleButton extends BaseButton {
+    static readonly registryName = "gambleButton";
+    private mobile;
+    constructor(mobile?: boolean);
+    flipDisabledFlag(disabled: boolean): void;
+}

package/dist/components/buttons/default/GambleButton.js

@@ -0,0 +1,43 @@
+import { RainMan } from "../../../Rainman";
+import { getTexture } from "../../../utils";
+import { BaseButton, ButtonStates } from "../BaseButton";
+import { BUTTONS } from "../registrynames";
+/**
+ * Class for a Gamble button in the game.
+ * Textures names should be "gamble.png", "gamble-over.png", and "gamble-clicked.png".
+ *  @class TakeButton
+ *  @augments {BaseButton}
+ */
+export class GambleButton extends BaseButton {
+    static registryName = "gambleButton";
+    mobile;
+    constructor(mobile = false) {
+        const textureMap = mobile
+            ? {
+                [ButtonStates.NORMAL]: getTexture("mobile-gamble.png")
+            }
+            : {
+                [ButtonStates.NORMAL]: getTexture("gamble.png"),
+                [ButtonStates.OVER]: getTexture("gamble-over.png"),
+                [ButtonStates.CLICKED]: getTexture("gamble-clicked.png")
+            };
+        super(GambleButton.registryName, textureMap);
+        this.mobile = mobile;
+    }
+    flipDisabledFlag(disabled) {
+        super.flipDisabledFlag(disabled);
+        this.alpha = disabled ? 0 : 1;
+        if (!disabled && this.mobile) {
+            RainMan.componentRegistry.get(BUTTONS.autoplay).alpha = 0;
+        }
+        else {
+            RainMan.componentRegistry.get(BUTTONS.autoplay).alpha = 1;
+        }
+        if (!disabled && !this.mobile) {
+            RainMan.componentRegistry.get(BUTTONS.neg).alpha = 0;
+        }
+        else {
+            RainMan.componentRegistry.get(BUTTONS.neg).alpha = 1;
+        }
+    }
+}

package/dist/components/buttons/default/RefreshButton.d.ts

@@ -25,9 +25,39 @@ export declare class RefreshButton extends BaseButton implements IncentiveCompon
     private readonly arrowsSprite;
     private readonly stopSprite;
     constructor(mobile?: boolean);
+    /**
+     * Function for activating the button.
+     * @public
+     * @param {boolean} flag flag for activating
+     * @returns {void}
+     */
     activate(flag: boolean): void;
+    /**
+     * Function for animating the button.
+     * @public
+     * @returns {void}
+     */
     animate(): void;
+    /**
+     * Function for initializing the incentive action.
+     * @public
+     * @param {Record<string, boolean>} incentiveJobFlag flags for incentive jobs
+     * @param {() => void} afterAllDoneCallback callback for after all incentive jobs are done
+     * @returns {void}
+     */
     initIncentiveAction(incentiveJobFlag: Record<string, boolean>, afterAllDoneCallback: () => void): void;
+    /**
+     * Function for switching the button texture.
+     * @protected
+     * @param {keyof typeof ButtonStates} state state of the button
+     * @returns {void}
+     */
     protected switchTexture(state: keyof typeof ButtonStates): void;
+    /**
+     * Updates the arrows sprite texture based on the refresh button texture.
+     * @private
+     * @param {Texture} refreshButtonTexture new texture for refresh button
+     * @returns {void}
+     */
     private updateArrowsSprite;
 }

package/dist/components/buttons/default/RefreshButton.js

@@ -57,18 +57,38 @@ export class RefreshButton extends BaseButton {
             this.hitArea = new Circle(this.arrowsSprite.x, this.arrowsSprite.y - 5, this.arrowsSprite.width / 2 + 40);
         }
     }
+    /**
+     * Function for activating the button.
+     * @public
+     * @param {boolean} flag flag for activating
+     * @returns {void}
+     */
     activate(flag) {
         super.activate(flag);
-        if (this.arrowsSprite)
+        if (this.arrowsSprite) {
             this.arrowsSprite.visible = !flag;
-        if (this.stopSprite)
+        }
+        if (this.stopSprite) {
             this.stopSprite.visible = flag;
+        }
     }
+    /**
+     * Function for animating the button.
+     * @public
+     * @returns {void}
+     */
     animate() {
         if (this.spinTween !== null) {
             this.spinTween.update(RainMan.app.ticker.lastTime);
         }
     }
+    /**
+     * Function for initializing the incentive action.
+     * @public
+     * @param {Record<string, boolean>} incentiveJobFlag flags for incentive jobs
+     * @param {() => void} afterAllDoneCallback callback for after all incentive jobs are done
+     * @returns {void}
+     */
     initIncentiveAction(incentiveJobFlag, afterAllDoneCallback) {
         const fullRotation = (2 * (360 * Math.PI)) / 180;
         this.spinTween = new TWEEN.Tween({
@@ -98,15 +118,28 @@ export class RefreshButton extends BaseButton {
             }
         });
     }
+    /**
+     * Function for switching the button texture.
+     * @protected
+     * @param {keyof typeof ButtonStates} state state of the button
+     * @returns {void}
+     */
     switchTexture(state) {
         if (this.textures[state]) {
             this.texture = this.textures[state];
             this.updateArrowsSprite(this.texture);
         }
     }
+    /**
+     * Updates the arrows sprite texture based on the refresh button texture.
+     * @private
+     * @param {Texture} refreshButtonTexture new texture for refresh button
+     * @returns {void}
+     */
     updateArrowsSprite(refreshButtonTexture) {
-        if (!this.arrowsSprite)
+        if (!this.arrowsSprite) {
             return;
+        }
         const textureStatePrefix = refreshButtonTexture.textureCacheIds[0].split("/")[0];
         this.arrowsSprite.texture = getTexture(`${textureStatePrefix}/arrows.png`);
     }

package/dist/components/buttons/default/SpeedControlButton.d.ts

@@ -14,7 +14,9 @@ export declare class SpeedControlButton extends BaseButton implements SpeedAdapt
     constructor();
     /**
      * Change button's texture according to speed level
+     * @public
      * @param {SpeedLevel} speedLevel - new speed level
+     * @returns {void}
      */
     adaptToSpeed(speedLevel: SpeedLevel): void;
 }

package/dist/components/buttons/default/SpeedControlButton.js

@@ -28,7 +28,9 @@ export class SpeedControlButton extends BaseButton {
     }
     /**
      * Change button's texture according to speed level
+     * @public
      * @param {SpeedLevel} speedLevel - new speed level
+     * @returns {void}
      */
     adaptToSpeed(speedLevel) {
         this.setTextureMap(this.speedLevelMapper[speedLevel]);

package/dist/components/buttons/default/TakeButton.d.ts

@@ -0,0 +1,13 @@
+import { BaseButton } from "../BaseButton";
+/**
+ *  Class for a Take button in the game.
+ *  Textures names should be "take.png", "take-over.png", and "take-clicked.png".
+ *  @class TakeButton
+ *  @augments {BaseButton}
+ */
+export declare class TakeButton extends BaseButton {
+    static readonly registryName = "takeButton";
+    private mobile;
+    constructor(mobile?: boolean);
+    flipDisabledFlag(disabled: boolean): void;
+}

package/dist/components/buttons/default/TakeButton.js

@@ -0,0 +1,37 @@
+import { RainMan } from "../../../Rainman";
+import { getTexture } from "../../../utils";
+import { BaseButton, ButtonStates } from "../BaseButton";
+import { BUTTONS } from "../registrynames";
+/**
+ *  Class for a Take button in the game.
+ *  Textures names should be "take.png", "take-over.png", and "take-clicked.png".
+ *  @class TakeButton
+ *  @augments {BaseButton}
+ */
+export class TakeButton extends BaseButton {
+    static registryName = "takeButton";
+    mobile;
+    constructor(mobile = false) {
+        const textureMap = mobile
+            ? {
+                [ButtonStates.NORMAL]: getTexture("mobile-take.png")
+            }
+            : {
+                [ButtonStates.NORMAL]: getTexture("take.png"),
+                [ButtonStates.OVER]: getTexture("take-over.png"),
+                [ButtonStates.CLICKED]: getTexture("take-clicked.png")
+            };
+        super(TakeButton.registryName, textureMap);
+        this.mobile = mobile;
+    }
+    flipDisabledFlag(disabled) {
+        super.flipDisabledFlag(disabled);
+        this.alpha = disabled ? 0 : 1;
+        if (!disabled) {
+            RainMan.componentRegistry.get(BUTTONS.plus).alpha = 0;
+        }
+        else {
+            RainMan.componentRegistry.get(BUTTONS.plus).alpha = 1;
+        }
+    }
+}

package/dist/components/buttons/default/VolumeButton.d.ts

@@ -18,6 +18,8 @@ export declare class VolumeButton extends BaseButton {
     constructor();
     /**
      * Changes volume texture based on volume between `MUTED` and `NORMAL`
+     * @public
+     * @returns {void}
      */
     changeTextureDependOnVolume(): void;
 }

package/dist/components/buttons/default/VolumeButton.js

@@ -34,6 +34,8 @@ export class VolumeButton extends BaseButton {
     }
     /**
      * Changes volume texture based on volume between `MUTED` and `NORMAL`
+     * @public
+     * @returns {void}
      */
     changeTextureDependOnVolume() {
         if (RainMan.settingsStore.isSoundEnabled()) {

package/dist/components/buttons/default/index.d.ts

@@ -1,6 +1,7 @@
 export * from "./AutoplayButton";
 export * from "./BlackButton";
 export * from "./CollectButton";
+export * from "./GambleButton";
 export * from "./InfoButton";
 export * from "./MoreButton";
 export * from "./NegButton";
@@ -9,4 +10,5 @@ export * from "./RedButton";
 export * from "./RefreshButton";
 export * from "./SpeedControlButton";
 export * from "./SpinConfirmationButton";
+export * from "./TakeButton";
 export * from "./VolumeButton";

package/dist/components/buttons/default/index.js

@@ -1,6 +1,7 @@
 export * from "./AutoplayButton";
 export * from "./BlackButton";
 export * from "./CollectButton";
+export * from "./GambleButton";
 export * from "./InfoButton";
 export * from "./MoreButton";
 export * from "./NegButton";
@@ -9,4 +10,5 @@ export * from "./RedButton";
 export * from "./RefreshButton";
 export * from "./SpeedControlButton";
 export * from "./SpinConfirmationButton";
+export * from "./TakeButton";
 export * from "./VolumeButton";

package/dist/components/buttons/registrynames.d.ts

@@ -9,7 +9,9 @@ export declare const BUTTONS: {
     readonly info: "infoButton";
     readonly more: "moreButton";
     readonly gamble: "gambleButton";
+    readonly take: "takeButton";
     readonly volume: "volumeButton";
+    readonly autoplay: "autoplayButton";
 };
 /**
  *  Button groups in Rainman Registry

package/dist/components/buttons/registrynames.js

@@ -9,7 +9,9 @@ export const BUTTONS = {
     info: "infoButton",
     more: "moreButton",
     gamble: "gambleButton",
-    volume: "volumeButton"
+    take: "takeButton",
+    volume: "volumeButton",
+    autoplay: "autoplayButton"
 };
 /**
  *  Button groups in Rainman Registry

package/dist/components/common/AnimatedBackground.d.ts

@@ -14,12 +14,18 @@ export declare class AnimatedBackground extends ResumableContainer {
     static readonly registryName = "animatedBackground";
     protected spine: Spine;
     constructor(desktopSpineName: string, animationName: string, mobileSpineName?: string);
+    /**
+     * Function for resizing the background.
+     * @public
+     * @returns {void}
+     */
     resize(): void;
     /**
      * This method is called when free spins are triggered
      * It is used to change the background animation
      * Remember to change resize for this method
      * @protected
+     * @returns {void}
      */
     protected changeForFreeSpins(): void;
     /**
@@ -27,9 +33,25 @@ export declare class AnimatedBackground extends ResumableContainer {
      * It is used to change the background animation
      * Remember to change resize for this method
      * @protected
+     * @returns {void}
      */
     protected changeForBaseGame(): void;
+    /**
+     * Function for setting the desktop background.
+     * @private
+     * @returns {void}
+     */
     private setDesktopBackground;
+    /**
+     * Function for setting the mobile background.
+     * @private
+     * @returns {void}
+     */
     private setMobileBackground;
+    /**
+     * Function for changing spines depending on device orientation.
+     * @private
+     * @returns {void}
+     */
     private changeSpineForOrientation;
 }

package/dist/components/common/AnimatedBackground.js

@@ -24,6 +24,11 @@ export class AnimatedBackground extends ResumableContainer {
         this.name = AnimatedBackground.registryName;
         this.parentLayer = BackgroundLayer;
     }
+    /**
+     * Function for resizing the background.
+     * @public
+     * @returns {void}
+     */
     resize() {
         this.changeSpineForOrientation();
         this.x = 0;
@@ -36,6 +41,7 @@ export class AnimatedBackground extends ResumableContainer {
      * It is used to change the background animation
      * Remember to change resize for this method
      * @protected
+     * @returns {void}
      */
     changeForFreeSpins() { }
     /**
@@ -43,16 +49,32 @@ export class AnimatedBackground extends ResumableContainer {
      * It is used to change the background animation
      * Remember to change resize for this method
      * @protected
+     * @returns {void}
      */
     changeForBaseGame() { }
+    /**
+     * Function for setting the desktop background.
+     * @private
+     * @returns {void}
+     */
     setDesktopBackground() {
         this.spine = new Spine(getSpineData(this.desktopSpineName));
         this.spine.state.setAnimation(0, this.animationName, true);
     }
+    /**
+     * Function for setting the mobile background.
+     * @private
+     * @returns {void}
+     */
     setMobileBackground() {
         this.spine = new Spine(getSpineData(this.mobileSpineName));
         this.spine.state.setAnimation(0, this.animationName, true);
     }
+    /**
+     * Function for changing spines depending on device orientation.
+     * @private
+     * @returns {void}
+     */
     changeSpineForOrientation() {
         this.removeChildren();
         getDeviceOrientation() === "mobile-portrait" ? this.setMobileBackground() : this.setDesktopBackground();

package/dist/components/common/AnimatedNumber.d.ts

@@ -3,16 +3,52 @@ import { Spine } from "pixi-spine";
 /**
  * Class representing animated number, based on spine animation.
  * Animation names should be exact the same as a represented symbol.
+ * This class is used in games like: LDE, LP, POBJ, POBWW, 5CC, 20CC and RC5.
+ * This represents the value of wins in this games in e.g. super bonus game (LDE, LP)
+ * and total win in free spin game (5CC, 20CC, RC5).
+ * @class AnimatedNumber
+ * @augments {Container}
  */
 export declare class AnimatedNumber extends Container {
     spineName: string;
     number: number | string;
     digits: Spine[];
     constructor(spineName: string, number: number | string);
+    /**
+     * Function for setting position of digits in row
+     * @private
+     * @returns {void}
+     */
     private setDigits;
+    /**
+     * Function for setting move animation for digits.
+     * @public
+     * @returns {void}
+     */
     setMoveAnimation(): void;
+    /**
+     * Function for removing digits from the display.
+     * @public
+     * @returns {void}
+     */
     removeDigits(): void;
+    /**
+     * Getter for displayed value
+     * @public
+     * @returns {number | string} current displayed value
+     */
     get value(): number | string;
+    /**
+     * Setter for displayed value
+     * @public
+     * @param {number | string} value new displayed value
+     * @returns {void}
+     */
     set value(value: number | string);
+    /**
+     * Function for playing the animation.
+     * @public
+     * @returns {void}
+     */
     play(): void;
 }