pixi-rainman-game-engine 0.3.0 → 0.3.2

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

@@ -16,20 +16,91 @@ export declare class BaseButton extends Sprite {
     private isActive;
     private isOver;
     private isDisabled;
-    private _onClick;
+    protected _onClick: () => void;
     private _customClickHandler;
     constructor(name: string, textureMap: TextureMap, stateful?: boolean, clickSound?: Nullable<SoundTrack>);
+    /**
+     * Getter for active state
+     * @public
+     * @returns {boolean} true if button is active
+     */
     get active(): boolean;
+    /**
+     * Function for forcing the button to change state
+     * This is based on isActive flag
+     * @public
+     * @returns {void}
+     */
     forceTextureUpdate(): void;
+    /**
+     * Setter for onClick callback
+     * @public
+     * @param {() => void} callback callback for the button click event
+     * @returns {void}
+     */
     setOnClick(callback: () => void): void;
-    activate(flag: boolean): void;
+    /**
+     * Activate button to make it clickable
+     * @public
+     * @param {boolean} shouldActivate flag for the flag activation
+     * @returns {void}
+     */
+    activate(shouldActivate: boolean): void;
+    /**
+     * Function for changing state of the button
+     * @public
+     * @param {boolean} makeDisabled flag for disabling the button
+     * @returns {void}
+     */
     flipDisabledFlag(makeDisabled: boolean): void;
+    /**
+     * Function for switching texture based on the state
+     * @protected
+     * @param {keyof typeof ButtonStates} state button state that we want to change
+     * @returns {void}
+     */
     protected switchTexture(state: keyof typeof ButtonStates): void;
+    /**
+     * Function for setting the texture map
+     * @protected
+     * @param {TextureMap} textureMap textures map used for button states
+     * @returns {void}
+     */
     protected setTextureMap(textureMap: TextureMap): void;
+    /**
+     * Getter for disabled state
+     * @public
+     * @returns {boolean} true if button is disabled
+     */
     get disabled(): boolean;
+    /**
+     * Getter for onClick callback
+     * @public
+     * @returns {typeof this._onClick} onClick callback
+     */
     get onClick(): typeof this._onClick;
+    /**
+     * Function for managing the state when the pointer is released
+     * @private
+     * @returns {void}
+     */
     private _manageStateUp;
+    /**
+     * Function for managing the state when the pointer is over (hovering) the button
+     * @private
+     * @returns {void}
+     */
     private _manageStateOver;
+    /**
+     * Function for managing the state when the pointer is clicked on the button
+     * @private
+     * @returns {void}
+     */
     private _manageStateDown;
+    /**
+     * Function for managing the state when the pointer is out of the button
+     * @private
+     * @returns {void}
+     */
     private _manageStateOut;
 }

package/dist/components/buttons/BaseButton/BaseButton.js

@@ -38,9 +38,20 @@ export class BaseButton extends Sprite {
         this.eventMode = "dynamic";
         this.isActive = false;
     }
+    /**
+     * Getter for active state
+     * @public
+     * @returns {boolean} true if button is active
+     */
     get active() {
         return this.isActive;
     }
+    /**
+     * Function for forcing the button to change state
+     * This is based on isActive flag
+     * @public
+     * @returns {void}
+     */
     forceTextureUpdate() {
         this.isOver = false;
         if (this.isActive) {
@@ -50,6 +61,12 @@ export class BaseButton extends Sprite {
             this.switchTexture("NORMAL");
         }
     }
+    /**
+     * Setter for onClick callback
+     * @public
+     * @param {() => void} callback callback for the button click event
+     * @returns {void}
+     */
     setOnClick(callback) {
         this.removeAllListeners();
         this._customClickHandler = callback;
@@ -67,29 +84,68 @@ export class BaseButton extends Sprite {
             .on("touchcancel", this._manageStateUp)
             .on("pointerdown", () => this.clickSound && SoundManager.play(this.clickSound));
     }
-    activate(flag) {
-        this.isActive = flag;
+    /**
+     * Activate button to make it clickable
+     * @public
+     * @param {boolean} shouldActivate flag for the flag activation
+     * @returns {void}
+     */
+    activate(shouldActivate) {
+        this.isActive = shouldActivate;
         this.forceTextureUpdate();
     }
+    /**
+     * Function for changing state of the button
+     * @public
+     * @param {boolean} makeDisabled flag for disabling the button
+     * @returns {void}
+     */
     flipDisabledFlag(makeDisabled) {
         this.isDisabled = makeDisabled;
         this.eventMode = makeDisabled ? "auto" : "static";
         this.tint = makeDisabled ? TINT_DISABLED : TINT_ENABLED;
     }
+    /**
+     * Function for switching texture based on the state
+     * @protected
+     * @param {keyof typeof ButtonStates} state button state that we want to change
+     * @returns {void}
+     */
     switchTexture(state) {
         if (this.textures[state]) {
             this.texture = this.textures[state];
         }
     }
+    /**
+     * Function for setting the texture map
+     * @protected
+     * @param {TextureMap} textureMap textures map used for button states
+     * @returns {void}
+     */
     setTextureMap(textureMap) {
         this.textures = textureMap;
     }
+    /**
+     * Getter for disabled state
+     * @public
+     * @returns {boolean} true if button is disabled
+     */
     get disabled() {
         return this.isDisabled;
     }
+    /**
+     * Getter for onClick callback
+     * @public
+     * @returns {typeof this._onClick} onClick callback
+     */
     get onClick() {
         return this._onClick;
     }
+    /**
+     * Function for managing the state when the pointer is released
+     * @private
+     * @returns {void}
+     */
     _manageStateUp() {
         if (this.isActive) {
             if (this.isOver) {
@@ -106,6 +162,11 @@ export class BaseButton extends Sprite {
             this.switchTexture("OVER");
         }
     }
+    /**
+     * Function for managing the state when the pointer is over (hovering) the button
+     * @private
+     * @returns {void}
+     */
     _manageStateOver() {
         this.isOver = true;
         if (this.isActive) {
@@ -115,6 +176,11 @@ export class BaseButton extends Sprite {
             this.switchTexture("OVER");
         }
     }
+    /**
+     * Function for managing the state when the pointer is clicked on the button
+     * @private
+     * @returns {void}
+     */
     _manageStateDown() {
         if (this.isActive) {
             this.switchTexture("ACTIVE_CLICKED");
@@ -123,6 +189,11 @@ export class BaseButton extends Sprite {
             this.switchTexture("CLICKED");
         }
     }
+    /**
+     * Function for managing the state when the pointer is out of the button
+     * @private
+     * @returns {void}
+     */
     _manageStateOut() {
         this.isOver = false;
         if (this.isActive) {

package/dist/components/buttons/BaseButton/types.d.ts

@@ -1,5 +1,10 @@
 import { Texture } from "pixi.js";
 import { ButtonStates } from "./ButtonState";
+/**
+ * Texture map for button states
+ * This map holds the textures for each button state
+ * @typedef {TextureMap}
+ */
 export type TextureMap = {
     [ButtonStates.NORMAL]: Texture;
     [ButtonStates.CLICKED]?: Texture;

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

@@ -17,6 +17,17 @@ export declare class LeftButtons extends ResponsiveContainer {
     protected readonly credit: UpdatableTextComponent;
     protected readonly bet: UpdatableTextComponent;
     constructor(scaleMultiplier?: number);
+    /**
+     * Function for removing children from the registry
+     * This function removes the credit and bet text components from the RainMan component registry
+     * @public
+     * @returns {void}
+     */
     removeChildrenFromRegistry(): void;
+    /**
+     * Function for reposition of the left buttons
+     * @protected
+     * @returns {void}
+     */
     protected reposition(): void;
 }

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

@@ -30,6 +30,12 @@ export class LeftButtons extends ResponsiveContainer {
         this.addChild(this.volumeButton, this.moreButton, this.infoButton, this.credit, this.bet);
         RainMan.componentRegistry.addMany([this.volumeButton, this.moreButton, this.infoButton, this.credit, this.bet]);
     }
+    /**
+     * Function for removing children from the registry
+     * This function removes the credit and bet text components from the RainMan component registry
+     * @public
+     * @returns {void}
+     */
     removeChildrenFromRegistry() {
         RainMan.componentRegistry.removeMany([
             this.credit,
@@ -39,6 +45,11 @@ export class LeftButtons extends ResponsiveContainer {
             this.infoButton
         ]);
     }
+    /**
+     * Function for reposition of the left buttons
+     * @protected
+     * @returns {void}
+     */
     reposition() {
         const margin = 15;
         this.y = RainMan.app.screen.height - this.height;

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

@@ -1,12 +1,24 @@
 import { ResponsiveContainer } from "../../common";
 import { UpdatableTextComponent } from "../../updatable";
 /**
- *  Buttons for mobile version. It's similar to PC, it has a bet value and total credit text, both created by {@link UpdatableTextComponent}.
+ * Buttons for mobile version.
+ * It's similar to PC, it has a bet value and total credit text, both created by {@link UpdatableTextComponent}.
+ * @augments {ResponsiveContainer}
  */
 export declare class LeftButtonsLandscape extends ResponsiveContainer {
     protected readonly credit: UpdatableTextComponent;
     protected readonly bet: UpdatableTextComponent;
     constructor();
+    /**
+     * Function for removing children from the registry
+     * @public
+     * @returns {void}
+     */
     removeChildrenFromRegistry(): void;
+    /**
+     * Function for repositioning the left buttons
+     * @protected
+     * @returns {void}
+     */
     protected reposition(): void;
 }

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

@@ -5,7 +5,9 @@ import { ResponsiveContainer } from "../../common";
 import { UPDATABLE_MODES, UpdatableTextComponent } from "../../updatable";
 import { COMPONENTS, REGISTRY } from "../registrynames";
 /**
- *  Buttons for mobile version. It's similar to PC, it has a bet value and total credit text, both created by {@link UpdatableTextComponent}.
+ * Buttons for mobile version.
+ * It's similar to PC, it has a bet value and total credit text, both created by {@link UpdatableTextComponent}.
+ * @augments {ResponsiveContainer}
  */
 export class LeftButtonsLandscape extends ResponsiveContainer {
     credit = new UpdatableTextComponent(COMPONENTS.creditText, i18next.t("credit"), UPDATABLE_MODES.money, RainMan.config.mobileFontSize);
@@ -19,9 +21,19 @@ export class LeftButtonsLandscape extends ResponsiveContainer {
         RainMan.componentRegistry.addMany([this.credit, this.bet]);
         this.resize();
     }
+    /**
+     * Function for removing children from the registry
+     * @public
+     * @returns {void}
+     */
     removeChildrenFromRegistry() {
         RainMan.componentRegistry.removeMany([this.credit, this.bet]);
     }
+    /**
+     * Function for repositioning the left buttons
+     * @protected
+     * @returns {void}
+     */
     reposition() {
         this.y = RainMan.app.screen.height - this.height;
         this.credit.x = 70;

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

@@ -3,14 +3,32 @@ import { ResponsiveContainer } from "../../common";
 import { UpdatableTextComponent } from "../../updatable";
 import { MoreButton, VolumeButton } from "../default";
 /**
- *  Buttons for mobile version. It has a settings button and total credit text {@link UpdatableTextComponent}.
+ * Buttons for mobile version. It has a settings button and total credit text {@link UpdatableTextComponent}.
+ * @augments {ResponsiveContainer}
  */
 export declare class LeftButtonsMobile extends ResponsiveContainer {
     protected readonly credit: UpdatableTextComponent;
     protected readonly moreButton: MoreButton;
     protected readonly volumeButton: VolumeButton;
     constructor();
+    /**
+     * Function for removing children from the registry
+     * @public
+     * @returns {void}
+     */
     removeChildrenFromRegistry(): void;
+    /**
+     * Function for repositions the buttons
+     * This function repositions the buttons in the mobile layout
+     * @protected
+     * @returns {void}
+     */
     protected reposition(): void;
+    /**
+     * Function for updating the credit text style
+     * @public
+     * @param {Partial<ITextStyle>} style new style of credit text
+     * @returns {void}
+     */
     updateCreditTextStyle(style: Partial<ITextStyle>): void;
 }

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

@@ -7,7 +7,8 @@ import { MoreButton, VolumeButton } from "../default";
 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 settings button and total credit text {@link UpdatableTextComponent}.
+ * Buttons for mobile version. It has a settings button and total credit text {@link UpdatableTextComponent}.
+ * @augments {ResponsiveContainer}
  */
 export class LeftButtonsMobile extends ResponsiveContainer {
     credit = new UpdatableTextComponent(COMPONENTS.creditText, i18next.t("credit"), UPDATABLE_MODES.money, RainMan.config.mobileFontSize);
@@ -24,9 +25,20 @@ export class LeftButtonsMobile extends ResponsiveContainer {
         this.addChild(this.credit, this.moreButton);
         RainMan.componentRegistry.addMany([this.credit, this.moreButton, this.volumeButton]);
     }
+    /**
+     * Function for removing children from the registry
+     * @public
+     * @returns {void}
+     */
     removeChildrenFromRegistry() {
         RainMan.componentRegistry.removeMany([this.credit, this.volumeButton, this.moreButton]);
     }
+    /**
+     * Function for repositions the buttons
+     * This function repositions the buttons in the mobile layout
+     * @protected
+     * @returns {void}
+     */
     reposition() {
         this.y = RainMan.app.screen.height;
         this.moreButton.y = -MOBILE_Y_BOTTOM_OFFSET;
@@ -34,6 +46,12 @@ export class LeftButtonsMobile extends ResponsiveContainer {
         this.credit.y = -MOBILE_Y_BOTTOM_OFFSET;
         this.credit.x = this.moreButton.x + this.moreButton.width + MOBILE_BUTTONS_GAP;
     }
+    /**
+     * Function for updating the credit text style
+     * @public
+     * @param {Partial<ITextStyle>} style new style of credit text
+     * @returns {void}
+     */
     updateCreditTextStyle(style) {
         this.credit.updateBaseTextStyle(style);
     }

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

@@ -1,8 +1,10 @@
 import { Graphics } from "pixi.js";
 import { ResponsiveContainer } from "../../common";
-import { AutoplayButton, PlusButton, RefreshButton } from "../default";
+import { AutoplayButton, GambleButton, PlusButton, RefreshButton, TakeButton } from "../default";
 /**
- * Class for managing middle buttons in game (MOBILE ONLY). The class uses {@link AutoplayButton}, {@link PlusButton}, {@link RefreshButton}
+ * Class for managing middle buttons in game (MOBILE ONLY).
+ * The class uses {@link AutoplayButton}, {@link PlusButton}, {@link RefreshButton}.
+ * @augments {ResponsiveContainer}
  */
 export declare class MiddleButtons extends ResponsiveContainer {
     private landscape;
@@ -10,8 +12,31 @@ export declare class MiddleButtons extends ResponsiveContainer {
     protected readonly betButton: PlusButton;
     protected readonly refreshButton: RefreshButton;
     protected readonly positioningFrame: Graphics;
+    protected readonly gambleButton: GambleButton;
+    protected readonly takeButton: TakeButton;
     constructor(landscape?: boolean);
+    /**
+     * Function for removing children from the registry
+     * @public
+     * @returns {void}
+     */
     removeChildrenFromRegistry(): void;
+    /**
+     *  Function for adding Gamble and Take buttons if they are defined
+     * @protected
+     * @returns {void}
+     */
+    protected addGambleAndTakeButtons(): void;
+    /**
+     * Function for initializing child positions
+     * @private
+     * @returns {void}
+     */
     private initChildPositions;
+    /**
+     * Function for repositioning the middle buttons
+     * @protected
+     * @returns {void}
+     */
     protected reposition(): void;
 }

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

@@ -2,10 +2,12 @@ import { Graphics } from "pixi.js";
 import { UXLayer } from "../../../layers";
 import { RainMan } from "../../../Rainman";
 import { ResponsiveContainer } from "../../common";
-import { AutoplayButton, PlusButton, RefreshButton } from "../default";
+import { AutoplayButton, GambleButton, PlusButton, RefreshButton, TakeButton } from "../default";
 import { REGISTRY } from "../registrynames";
 /**
- * Class for managing middle buttons in game (MOBILE ONLY). The class uses {@link AutoplayButton}, {@link PlusButton}, {@link RefreshButton}
+ * Class for managing middle buttons in game (MOBILE ONLY).
+ * The class uses {@link AutoplayButton}, {@link PlusButton}, {@link RefreshButton}.
+ * @augments {ResponsiveContainer}
  */
 export class MiddleButtons extends ResponsiveContainer {
     landscape;
@@ -13,6 +15,8 @@ export class MiddleButtons extends ResponsiveContainer {
     betButton = new PlusButton(true);
     refreshButton = new RefreshButton(true);
     positioningFrame = new Graphics();
+    gambleButton = new GambleButton(true);
+    takeButton = new TakeButton(true);
     constructor(landscape = false) {
         super();
         this.landscape = landscape;
@@ -21,35 +25,69 @@ export class MiddleButtons extends ResponsiveContainer {
         const buttons = [this.autoplayButton, this.betButton, this.refreshButton];
         this.addChild(...buttons);
         RainMan.componentRegistry.addMany(buttons);
+        this.addGambleAndTakeButtons();
         this.positioningFrame.beginFill(0x000000, 0);
         this.positioningFrame.drawRect(0, 0, 800, 250);
         this.addChild(this.positioningFrame);
         this.refreshButton.scale.set(0.75);
         this.autoplayButton.scale.set(0.75);
         this.betButton.scale.set(0.75);
+        this.takeButton.scale.set(0.75);
+        this.gambleButton.scale.set(0.75);
         if (this.landscape) {
             this.betButton.anchor.set(0.5, 2);
             this.refreshButton.anchor.set(0.5, 0.5);
             this.autoplayButton.anchor.set(0.5, -1);
+            this.takeButton.anchor.set(0.5, 2);
+            this.gambleButton.anchor.set(0.5, -1);
         }
         else {
             this.autoplayButton.anchor.set(2, 0.5);
             this.refreshButton.anchor.set(0.5, 0.5);
             this.betButton.anchor.set(-1, 0.5);
+            this.takeButton.anchor.set(-1, 0.5);
+            this.gambleButton.anchor.set(2, 0.5);
         }
         this.initChildPositions();
         if (this.landscape) {
             this.scale.set(-1);
         }
     }
+    /**
+     * Function for removing children from the registry
+     * @public
+     * @returns {void}
+     */
     removeChildrenFromRegistry() {
         RainMan.componentRegistry.removeMany([
             this.refreshButton,
             this.autoplayButton,
             this.betButton,
-            this.positioningFrame
+            this.positioningFrame,
+            ...(this.gambleButton && RainMan.config.gambleGameEnabled ? [this.gambleButton] : []),
+            ...(this.takeButton ? [this.takeButton] : [])
         ]);
     }
+    /**
+     *  Function for adding Gamble and Take buttons if they are defined
+     * @protected
+     * @returns {void}
+     */
+    addGambleAndTakeButtons() {
+        if (this.gambleButton && RainMan.config.gambleGameEnabled) {
+            this.addChild(this.gambleButton);
+            RainMan.componentRegistry.add(this.gambleButton);
+        }
+        if (this.takeButton) {
+            this.addChild(this.takeButton);
+            RainMan.componentRegistry.add(this.takeButton);
+        }
+    }
+    /**
+     * Function for initializing child positions
+     * @private
+     * @returns {void}
+     */
     initChildPositions() {
         const { width, height } = this.positioningFrame;
         this.refreshButton.x = width / 2;
@@ -67,5 +105,10 @@ export class MiddleButtons extends ResponsiveContainer {
             this.betButton.y = height;
         }
     }
+    /**
+     * Function for repositioning the middle buttons
+     * @protected
+     * @returns {void}
+     */
     reposition() { }
 }

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

@@ -1,7 +1,6 @@
 import { Nullable } from "../../../utils";
 import { ResponsiveContainer } from "../../common";
-import { BaseButton } from "../BaseButton";
-import { AutoplayButton, NegButton, PlusButton, RefreshButton, SpeedControlButton } from "../default";
+import { AutoplayButton, GambleButton, NegButton, PlusButton, RefreshButton, SpeedControlButton, TakeButton } from "../default";
 /**
  * Class for managing right buttons in game. The class uses {@link AutoplayButton}, {@link NegButton}, {@link PlusButton},
  * {@link RefreshButton}, {@link SpeedControlButton} and gamble button {@link BaseButton} if exists.
@@ -15,8 +14,25 @@ export declare class RightButtons extends ResponsiveContainer {
     protected readonly plusButton: PlusButton;
     protected readonly refreshButton: RefreshButton;
     protected readonly speedControlButton: SpeedControlButton;
-    protected readonly gambleButton: Nullable<BaseButton>;
+    protected readonly gambleButton: Nullable<GambleButton>;
+    protected readonly takeButton: Nullable<TakeButton>;
     constructor();
+    /**
+     * Function for removing the components from the registry
+     * @public
+     * @returns {void}
+     */
     removeChildrenFromRegistry(): void;
+    /**
+     * Function for repositioning the right buttons
+     * @protected
+     * @returns {void}
+     */
     protected reposition(): void;
+    /**
+     *  Function for adding Gamble and Take buttons if they are defined
+     * @protected
+     * @returns {void}
+     */
+    protected addGambleAndTakeButtons(): void;
 }

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

@@ -17,6 +17,7 @@ export class RightButtons extends ResponsiveContainer {
     refreshButton = new RefreshButton();
     speedControlButton = new SpeedControlButton();
     gambleButton = null;
+    takeButton = null;
     constructor() {
         super(-1);
         this.name = REGISTRY.rightButtons;
@@ -31,17 +32,44 @@ export class RightButtons extends ResponsiveContainer {
         ]);
         this.resize();
     }
+    /**
+     * Function for removing the components from the registry
+     * @public
+     * @returns {void}
+     */
     removeChildrenFromRegistry() {
         RainMan.componentRegistry.removeMany([
             this.autoplayButton,
             this.negButton,
             this.plusButton,
             this.refreshButton,
-            this.speedControlButton
+            this.speedControlButton,
+            ...(this.gambleButton ? [this.gambleButton] : []),
+            ...(this.takeButton ? [this.takeButton] : [])
         ]);
     }
+    /**
+     * Function for repositioning the right buttons
+     * @protected
+     * @returns {void}
+     */
     reposition() {
         this.y = RainMan.app.screen.height;
         this.x = RainMan.app.screen.width;
     }
+    /**
+     *  Function for adding Gamble and Take buttons if they are defined
+     * @protected
+     * @returns {void}
+     */
+    addGambleAndTakeButtons() {
+        if (this.gambleButton && RainMan.config.gambleGameEnabled) {
+            this.addChild(this.gambleButton);
+            RainMan.componentRegistry.add(this.gambleButton);
+        }
+        if (this.takeButton) {
+            this.addChild(this.takeButton);
+            RainMan.componentRegistry.add(this.takeButton);
+        }
+    }
 }