pixi-rainman-game-engine 0.1.35 → 0.1.37

package/README.md

@@ -117,3 +117,7 @@ In the `scripts` directory, you have three scripts:
 Code for the game engine contains in the `src` directory. For creating a feature you should add new directory into `src` directory. For example: `freeSpins` and in this folder contains all the mechanics.
 
 In utils directory there all the utility functions and types.
+
+### Creating a documentation in TypeDoc
+
+Available tags to use you can check here: https://typedoc.org/guides/tags/

package/dist/Rainman/types.d.ts

@@ -60,8 +60,12 @@ export type OptionalAppConfig = {
     };
 };
 export type AppConfig = RequiredAppConfig & DeepPartial<OptionalAppConfig>;
+/**
+ * This interface represents global variables in pixi application. Can be extended in `engine.d.ts` in each project to provide project-wide variables.
+ */
 export interface Globals {
     currency: Currency;
     disableSpeedPopup?: (value: boolean) => void;
+    handleDisablingButtons?: (value?: boolean) => void;
     throttledSpin?: () => void;
 }

package/dist/application/ButtonsEventManager/ButtonsEventManager.d.ts

@@ -1,4 +1,5 @@
 import { Nullable } from "../../utils";
+/** @ignore */
 export declare const SPEED_PREFIX = "speed-";
 /**
  * Class for managing buttons in games

package/dist/application/ButtonsEventManager/ButtonsEventManager.js

@@ -5,6 +5,7 @@ import { AutoplayButton, Background, BUTTONS, COMPONENTS, FreeSpinButton, Messag
 import { RainMan } from "../../Rainman";
 import { allUiItems, hideLayerIfPresent, UI_ITEMS } from "../../utils";
 import { SPEED_LEVELS } from "../SpeedState";
+/** @ignore */
 export const SPEED_PREFIX = "speed-";
 /**
  * Class for managing buttons in games
@@ -263,6 +264,7 @@ export class ButtonsEventManager {
             this.speedPopupShownAt = performance.now();
         const spinSpeedSettingsLayer = window.document.getElementById(UI_ITEMS.speedSettings);
         if (spinSpeedSettingsLayer !== null) {
+            RainMan.globals.handleDisablingButtons?.();
             spinSpeedSettingsLayer.style.display = displayValue;
         }
     }

package/dist/components/AbstractMainContainer/AbstractMainContainer.d.ts

@@ -11,8 +11,22 @@ import { IResizableContainer } from "../common/IResizableContainer";
 import { AbstractFrame } from "../frame";
 import { MessageBox } from "../messageBox";
 /**
- * AbstractMainContainer is a class for managing components in game
+ * AbstractMainContainer is a class for placing every components in game.
+ *   - {@link bottomPanel} - that's the bottom panel of the game, which contains buttons for changing game settings.
+ * In each game, there's two files for this panel - `bottomPanel.png` and `bottomPanelTexture.png`
+ *   - {@link frame} -  is a frame that can contain additional interface elements (such as Jackpot values) there is a `frame.json`
+ * animation in each game that has an animation that should be named `frame`.
+ *   - {@link _freeSpinPlate} {@link _freeSpinSummary} - modals responsible for showing information about free games (with the information how many
+ * free spins you have won) and how much you have won during free games.
+ *  - {@link messageBox} - message box that shows information about current win, auto spins left, free spins left, incentive message, win line indicator
+ *  - {@link leftButtons} {@link rightButtons} - buttons
+ *  - {@link logo} - logo
+ *  - {@link background} - static background
+ *  - {@link animatedFront} - animated front, need to be initialized in {@link triggerStoreInitState}
+ *  - {@link overlay} - overlay, used when modal is shown
+ *  - {@link gambleGame} - gamble game
  *
+ * @abstract
  * @class AbstractMainContainer
  * @exports
  */
@@ -54,17 +68,22 @@ export declare abstract class AbstractMainContainer extends Container {
     protected triggerStoreInitState(...containersWithSpines: typeof RainMan.settingsStore.containersWithSpines): void;
     get freeSpinPlate(): Nullable<AbstractFreeSpinContainer>;
     get freeSpinSummary(): Nullable<AbstractFreeSpinContainer>;
+    /**
+     * Function for creating free spin container
+     *
+     * @returns {AbstractFreeSpinContainer | null}  The container for the free spin plate, or null.
+     */
     protected createFreeSpinPlate(_resolver: () => void, _freeSpinCount: number, _isAdditionalFreeSpin: boolean): AbstractFreeSpinContainer | null;
     /**
      * Function for creating bonus win container
      *
-     * @returns {Nullable<UpdatableSpineContainer>}
+     * @returns {Nullable<UpdatableSpineContainer>} The container for the bonus win animation, or null.
      */
     protected createBonusWinContainer(): Nullable<UpdatableSpineContainer>;
     /**
-     * Function for creating super bonus win container
+     * Creates a container for the super bonus win animation.
      *
-     * @returns {Nullable<UpdatableSpineContainer>}
+     * @returns {UpdatableSpineContainer | null} The container for the super bonus win animation, or null.
      */
     protected createSuperBonusWinContainer(): Nullable<UpdatableSpineContainer>;
     /**
@@ -82,6 +101,11 @@ export declare abstract class AbstractMainContainer extends Container {
      * @param {boolean} isAdditionalFreeSpin - flag for displaying additional free spins
      */
     invokeFreeSpinPlate(freeSpinCount: number, isAdditionalFreeSpin?: boolean): Promise<void>;
+    /**
+     * Function for creating free spin summary
+     *
+     * @returns {AbstractFreeSpinContainer | null} The container for the free spin summary, or null
+     */
     protected createFreeSpinSummary(_resolver: () => void, _freeSpinCount: number, _winAmount: number): AbstractFreeSpinContainer | null;
     /**
      * Function for invoking free spin summary
@@ -98,8 +122,20 @@ export declare abstract class AbstractMainContainer extends Container {
     get bonusWinVisibleFor(): number;
     get superBonusWinVisibleFor(): number;
     protected abstract createBigWinContainer(): UpdatableSpineContainer;
+    /**
+     * Function for invoking big win animation, using `this.createBigWinContainer()` abstract function.
+     *
+     */
     invokeBigWin(): void;
+    /**
+     * Function for invoking big win animation, using `this.createSuperBonusWinContainer()` abstract function.
+     *
+     */
     invokeSuperBonusWin(): void;
+    /**
+     * Function for invoking big win animation, using `this.createBonusWinContainer()` abstract function.
+     *
+     */
     invokeBonusWin(): void;
     invokeMysteryWin(): void;
     destroyBigWin(): void;

package/dist/components/AbstractMainContainer/AbstractMainContainer.js

@@ -8,8 +8,22 @@ import { BUTTONS, LeftButtons, LeftButtonsLandscape, LeftButtonsMobile, MiddleBu
 import { GambleGame } from "../GambleGame";
 import { MessageBox } from "../messageBox";
 /**
- * AbstractMainContainer is a class for managing components in game
+ * AbstractMainContainer is a class for placing every components in game.
+ *   - {@link bottomPanel} - that's the bottom panel of the game, which contains buttons for changing game settings.
+ * In each game, there's two files for this panel - `bottomPanel.png` and `bottomPanelTexture.png`
+ *   - {@link frame} -  is a frame that can contain additional interface elements (such as Jackpot values) there is a `frame.json`
+ * animation in each game that has an animation that should be named `frame`.
+ *   - {@link _freeSpinPlate} {@link _freeSpinSummary} - modals responsible for showing information about free games (with the information how many
+ * free spins you have won) and how much you have won during free games.
+ *  - {@link messageBox} - message box that shows information about current win, auto spins left, free spins left, incentive message, win line indicator
+ *  - {@link leftButtons} {@link rightButtons} - buttons
+ *  - {@link logo} - logo
+ *  - {@link background} - static background
+ *  - {@link animatedFront} - animated front, need to be initialized in {@link triggerStoreInitState}
+ *  - {@link overlay} - overlay, used when modal is shown
+ *  - {@link gambleGame} - gamble game
  *
+ * @abstract
  * @class AbstractMainContainer
  * @exports
  */
@@ -62,21 +76,26 @@ export class AbstractMainContainer extends Container {
     get freeSpinSummary() {
         return this._freeSpinSummary;
     }
+    /**
+     * Function for creating free spin container
+     *
+     * @returns {AbstractFreeSpinContainer | null}  The container for the free spin plate, or null.
+     */
     createFreeSpinPlate(_resolver, _freeSpinCount, _isAdditionalFreeSpin) {
         return null;
     }
     /**
      * Function for creating bonus win container
      *
-     * @returns {Nullable<UpdatableSpineContainer>}
+     * @returns {Nullable<UpdatableSpineContainer>} The container for the bonus win animation, or null.
      */
     createBonusWinContainer() {
         return null;
     }
     /**
-     * Function for creating super bonus win container
+     * Creates a container for the super bonus win animation.
      *
-     * @returns {Nullable<UpdatableSpineContainer>}
+     * @returns {UpdatableSpineContainer | null} The container for the super bonus win animation, or null.
      */
     createSuperBonusWinContainer() {
         return null;
@@ -116,6 +135,11 @@ export class AbstractMainContainer extends Container {
         this.hideOverlay();
         refreshButton.flipDisabledFlag(false);
     }
+    /**
+     * Function for creating free spin summary
+     *
+     * @returns {AbstractFreeSpinContainer | null} The container for the free spin summary, or null
+     */
     createFreeSpinSummary(_resolver, _freeSpinCount, _winAmount) {
         return null;
     }
@@ -178,6 +202,10 @@ export class AbstractMainContainer extends Container {
     get superBonusWinVisibleFor() {
         return this._superBonusWinInvokedAt == null ? 0 : performance.now() - this._superBonusWinInvokedAt;
     }
+    /**
+     * Function for invoking big win animation, using `this.createBigWinContainer()` abstract function.
+     *
+     */
     invokeBigWin() {
         if (this.bigWinContainer !== null) {
             throw new Error("😡 Big Win is already declared");
@@ -192,6 +220,10 @@ export class AbstractMainContainer extends Container {
         SoundManager.play(SoundTracks.bigWin);
         this._bigWinInvokedAt = performance.now();
     }
+    /**
+     * Function for invoking big win animation, using `this.createSuperBonusWinContainer()` abstract function.
+     *
+     */
     invokeSuperBonusWin() {
         if (this.superBonusWinContainer !== null) {
             throw new Error("😡 Super Bonus Win is already declared");
@@ -207,6 +239,10 @@ export class AbstractMainContainer extends Container {
         this.addChild(this.superBonusWinContainer);
         this._superBonusWinInvokedAt = performance.now();
     }
+    /**
+     * Function for invoking big win animation, using `this.createBonusWinContainer()` abstract function.
+     *
+     */
     invokeBonusWin() {
         if (this.bonusWinContainer !== null) {
             throw new Error("😡 Bonus Win is already declared");

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

@@ -3,13 +3,14 @@ import { UpdatableTextComponent } from "../../updatable";
 import { InfoButton, MoreButton, VolumeButton } from "../default";
 /**
  * Class for managing left buttons in game
- * The class uses VolumeButton, MoreButton, InfoButton, UpdatableTextComponent
+ * The class uses {@link VolumeButton}, {@link MoreButton}, {@link InfoButton}, {@link UpdatableTextComponent}
  * to create left buttons
  * This container have bet and credit texts
  *
  * @class
  * @extends {ResponsiveContainer}
  * @export
+ * @document LeftButtons.md
  */
 export declare class LeftButtons extends ResponsiveContainer {
     protected readonly volumeButton: VolumeButton;

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

@@ -7,13 +7,14 @@ import { InfoButton, MoreButton, VolumeButton } from "../default";
 import { COMPONENTS, REGISTRY } from "../registrynames";
 /**
  * Class for managing left buttons in game
- * The class uses VolumeButton, MoreButton, InfoButton, UpdatableTextComponent
+ * The class uses {@link VolumeButton}, {@link MoreButton}, {@link InfoButton}, {@link UpdatableTextComponent}
  * to create left buttons
  * This container have bet and credit texts
  *
  * @class
  * @extends {ResponsiveContainer}
  * @export
+ * @document LeftButtons.md
  */
 export class LeftButtons extends ResponsiveContainer {
     volumeButton = new VolumeButton();

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

@@ -1,5 +1,8 @@
 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}.
+ */
 export declare class LeftButtonsLandscape extends ResponsiveContainer {
     protected readonly credit: UpdatableTextComponent;
     protected readonly bet: UpdatableTextComponent;

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

@@ -4,6 +4,9 @@ import { RainMan } from "../../../Rainman";
 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}.
+ */
 export class LeftButtonsLandscape extends ResponsiveContainer {
     credit = new UpdatableTextComponent(COMPONENTS.creditText, i18next.t("credit"), UPDATABLE_MODES.money, RainMan.config.mobileFontSize);
     bet = new UpdatableTextComponent(COMPONENTS.betText, i18next.t("bet"), UPDATABLE_MODES.money, RainMan.config.mobileFontSize);

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

@@ -2,6 +2,9 @@ import { ITextStyle } from "pixi.js";
 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}.
+ */
 export declare class LeftButtonsMobile extends ResponsiveContainer {
     protected readonly credit: UpdatableTextComponent;
     protected readonly moreButton: MoreButton;

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

@@ -6,6 +6,9 @@ import { UPDATABLE_MODES, UpdatableTextComponent } from "../../updatable";
 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}.
+ */
 export class LeftButtonsMobile extends ResponsiveContainer {
     credit = new UpdatableTextComponent(COMPONENTS.creditText, i18next.t("credit"), UPDATABLE_MODES.money, RainMan.config.mobileFontSize);
     moreButton = new MoreButton(true);

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

@@ -1,6 +1,10 @@
 import { Graphics } from "pixi.js";
 import { ResponsiveContainer } from "../../common";
 import { AutoplayButton, PlusButton, RefreshButton } from "../default";
+/**
+ * Class for managing middle buttons in game (MOBILE ONLY). The class uses {@link AutoplayButton}, {@link PlusButton}, {@link RefreshButton}
+ *
+ */
 export declare class MiddleButtons extends ResponsiveContainer {
     private landscape;
     protected readonly autoplayButton: AutoplayButton;

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

@@ -4,6 +4,10 @@ import { RainMan } from "../../../Rainman";
 import { ResponsiveContainer } from "../../common";
 import { AutoplayButton, PlusButton, RefreshButton } from "../default";
 import { REGISTRY } from "../registrynames";
+/**
+ * Class for managing middle buttons in game (MOBILE ONLY). The class uses {@link AutoplayButton}, {@link PlusButton}, {@link RefreshButton}
+ *
+ */
 export class MiddleButtons extends ResponsiveContainer {
     landscape;
     autoplayButton = new AutoplayButton(true);

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

@@ -2,6 +2,14 @@ import { Nullable } from "../../../utils";
 import { ResponsiveContainer } from "../../common";
 import { BaseButton } from "../BaseButton";
 import { AutoplayButton, NegButton, PlusButton, RefreshButton, SpeedControlButton } from "../default";
+/**
+ * Class for managing right buttons in game. The class uses {@link AutoplayButton}, {@link NegButton}, {@link PlusButton},
+ * {@link RefreshButton}, {@link SpeedControlButton} and {@link gambleButton} if exists.
+ *
+ * @class
+ * @extends {ResponsiveContainer}
+ * @document RightButtons.md
+ */
 export declare class RightButtons extends ResponsiveContainer {
     protected readonly autoplayButton: AutoplayButton;
     protected readonly negButton: NegButton;

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

@@ -3,6 +3,14 @@ import { RainMan } from "../../../Rainman";
 import { ResponsiveContainer } from "../../common";
 import { AutoplayButton, NegButton, PlusButton, RefreshButton, SpeedControlButton } from "../default";
 import { REGISTRY } from "../registrynames";
+/**
+ * Class for managing right buttons in game. The class uses {@link AutoplayButton}, {@link NegButton}, {@link PlusButton},
+ * {@link RefreshButton}, {@link SpeedControlButton} and {@link gambleButton} if exists.
+ *
+ * @class
+ * @extends {ResponsiveContainer}
+ * @document RightButtons.md
+ */
 export class RightButtons extends ResponsiveContainer {
     autoplayButton = new AutoplayButton();
     negButton = new NegButton();

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

@@ -1,5 +1,8 @@
 import { ResponsiveContainer } from "../../common";
 import { InfoButton, MoreButton, NegButton, SpeedControlButton, VolumeButton } from "../default";
+/**
+ * Buttons for mobile version- landscape. It has a settings button and game information button.
+ */
 export declare class RightButtonsLandscape extends ResponsiveContainer {
     protected readonly moreButton: MoreButton;
     protected readonly volumeButton: VolumeButton;

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

@@ -4,6 +4,9 @@ import { ResponsiveContainer } from "../../common";
 import { InfoButton, MoreButton, NegButton, SpeedControlButton, VolumeButton } from "../default";
 import { REGISTRY } from "../registrynames";
 import { MOBILE_BUTTONS_GAP, MOBILE_PANEL_BUTTON_SCALE, MOBILE_X_OFFSET, MOBILE_Y_BOTTOM_OFFSET } from "./constants";
+/**
+ * Buttons for mobile version- landscape. It has a settings button and game information button.
+ */
 export class RightButtonsLandscape extends ResponsiveContainer {
     moreButton = new MoreButton(true);
     volumeButton = new VolumeButton();

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

@@ -2,6 +2,9 @@ import { ITextStyle } from "pixi.js";
 import { ResponsiveContainer } from "../../common";
 import { UpdatableTextComponent } from "../../updatable";
 import { InfoButton, NegButton, SpeedControlButton } from "../default";
+/**
+ * Buttons for mobile version. It has a current bet and game information button.
+ */
 export declare class RightButtonsMobile extends ResponsiveContainer {
     protected readonly infoButton: InfoButton;
     protected readonly negButton: NegButton;

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

@@ -6,6 +6,9 @@ import { UPDATABLE_MODES, UpdatableTextComponent } from "../../updatable";
 import { InfoButton, NegButton, SpeedControlButton } 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 current bet and game information button.
+ */
 export class RightButtonsMobile extends ResponsiveContainer {
     infoButton = new InfoButton(true);
     negButton = new NegButton();

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

@@ -1,4 +1,8 @@
+/** @ignore */
 export declare const MOBILE_Y_BOTTOM_OFFSET = 70;
+/** @ignore */
 export declare const MOBILE_X_OFFSET = 20;
+/** @ignore */
 export declare const MOBILE_PANEL_BUTTON_SCALE = 0.8;
+/** @ignore */
 export declare const MOBILE_BUTTONS_GAP = 30;

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

@@ -1,4 +1,8 @@
+/** @ignore */
 export const MOBILE_Y_BOTTOM_OFFSET = 70;
+/** @ignore */
 export const MOBILE_X_OFFSET = 20;
+/** @ignore */
 export const MOBILE_PANEL_BUTTON_SCALE = 0.8;
+/** @ignore */
 export const MOBILE_BUTTONS_GAP = 30;

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

@@ -1,4 +1,18 @@
 import { BaseButton, ButtonStates } from "../BaseButton";
+/**
+ * Button for handling autoplay
+ *  It needs following textures:
+ * - normal - `normal/autoplay.png`
+ * - hover - `hover/autoplay.png`
+ * - clicked - `clicked/autoplay.png`
+ * - mobile - `mobile/autoplay.png`
+ * - mobile/clicked - `mobile/clicked/autoplay.png`
+ * - mobile/autoplay-on - `mobile/autoplay-on.png`
+ * - mobile/clicked/autoplay-on - `mobile/clicked/autoplay-on.png`
+ *
+ * @class
+ * @extends {BaseButton}
+ */
 export declare class AutoplayButton extends BaseButton {
     private mobile;
     static readonly registryName = "autoplayButton";

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

@@ -3,6 +3,20 @@ import { SoundTracks } from "../../../application";
 import { RainMan } from "../../../Rainman";
 import { getTexture, getTextureSafely } from "../../../utils";
 import { BaseButton, ButtonStates } from "../BaseButton";
+/**
+ * Button for handling autoplay
+ *  It needs following textures:
+ * - normal - `normal/autoplay.png`
+ * - hover - `hover/autoplay.png`
+ * - clicked - `clicked/autoplay.png`
+ * - mobile - `mobile/autoplay.png`
+ * - mobile/clicked - `mobile/clicked/autoplay.png`
+ * - mobile/autoplay-on - `mobile/autoplay-on.png`
+ * - mobile/clicked/autoplay-on - `mobile/clicked/autoplay-on.png`
+ *
+ * @class
+ * @extends {BaseButton}
+ */
 export class AutoplayButton extends BaseButton {
     mobile;
     static registryName = "autoplayButton";

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

@@ -1,4 +1,13 @@
 import { BaseButton } from "../BaseButton";
+/**
+ * Button for handling black figure in Gamble Mechanic
+ *  It needs following textures:
+ * - normal - `black-n.png`
+ * - hover - `black-h.png`
+ * - clicked - `black-c.png`
+ *
+ * @class
+ */
 export declare class BlackButton extends BaseButton {
     static readonly registryName = "gambleCollectButton";
     constructor();

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

@@ -1,5 +1,14 @@
 import { Texture } from "pixi.js";
 import { BaseButton, ButtonStates } from "../BaseButton";
+/**
+ * Button for handling black figure in Gamble Mechanic
+ *  It needs following textures:
+ * - normal - `black-n.png`
+ * - hover - `black-h.png`
+ * - clicked - `black-c.png`
+ *
+ * @class
+ */
 export class BlackButton extends BaseButton {
     static registryName = "gambleCollectButton";
     constructor() {

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

@@ -1,4 +1,14 @@
 import { BaseButton } from "../BaseButton";
+/**
+ * Button for collecting win in Gamble Mechanic
+ *  It needs following textures:
+ * - normal - `collect-button-n.png`
+ * - hover - `collect-button-h.png`
+ * - clicked - `collect-button-c.png`
+ *
+ *
+ * @class
+ */
 export declare class CollectButton extends BaseButton {
     static readonly registryName = "gambleCollectButton";
     constructor();

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

@@ -1,5 +1,15 @@
 import { Texture } from "pixi.js";
 import { BaseButton, ButtonStates } from "../BaseButton";
+/**
+ * Button for collecting win in Gamble Mechanic
+ *  It needs following textures:
+ * - normal - `collect-button-n.png`
+ * - hover - `collect-button-h.png`
+ * - clicked - `collect-button-c.png`
+ *
+ *
+ * @class
+ */
 export class CollectButton extends BaseButton {
     static registryName = "gambleCollectButton";
     constructor() {

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

@@ -1,4 +1,15 @@
 import { BaseButton } from "../BaseButton";
+/**
+ * Button for displaying game info.
+ * It needs following textures:
+ * - normal - `normal/info.png`
+ * - hover - `hover/info.png`
+ * - clicked - `clicked/info.png`
+ * - mobile - `mobile/info.png`
+ * - mobile/clicked - `mobile/clicked/info.png`
+ *
+ * @class
+ */
 export declare class InfoButton extends BaseButton {
     static readonly registryName = "infoButton";
     constructor(mobile?: boolean);

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

@@ -1,5 +1,16 @@
 import { getTexture } from "../../../utils";
 import { BaseButton, ButtonStates } from "../BaseButton";
+/**
+ * Button for displaying game info.
+ * It needs following textures:
+ * - normal - `normal/info.png`
+ * - hover - `hover/info.png`
+ * - clicked - `clicked/info.png`
+ * - mobile - `mobile/info.png`
+ * - mobile/clicked - `mobile/clicked/info.png`
+ *
+ * @class
+ */
 export class InfoButton extends BaseButton {
     static registryName = "infoButton";
     constructor(mobile = false) {

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

@@ -1,4 +1,15 @@
 import { BaseButton } from "../BaseButton";
+/**
+ * Button for displaying game settings.
+ * It needs following textures:
+ * - normal - `normal/menu.png`
+ * - hover - `hover/menu.png`
+ * - clicked - `clicked/menu.png`
+ * - mobile - `mobile/menu.png`
+ * - mobile/clicked - `mobile/clicked/menu.png`
+ *
+ * @class
+ */
 export declare class MoreButton extends BaseButton {
     static readonly registryName = "moreButton";
     constructor(mobile?: boolean);

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

@@ -1,5 +1,16 @@
 import { getTexture } from "../../../utils";
 import { BaseButton, ButtonStates } from "../BaseButton";
+/**
+ * Button for displaying game settings.
+ * It needs following textures:
+ * - normal - `normal/menu.png`
+ * - hover - `hover/menu.png`
+ * - clicked - `clicked/menu.png`
+ * - mobile - `mobile/menu.png`
+ * - mobile/clicked - `mobile/clicked/menu.png`
+ *
+ * @class
+ */
 export class MoreButton extends BaseButton {
     static registryName = "moreButton";
     constructor(mobile = false) {

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

@@ -1,4 +1,13 @@
 import { BaseButton } from "../BaseButton";
+/**
+ * Button for decreasing bet value.
+ * It needs following textures:
+ * - normal - `normal/minus.png`
+ * - hover - `hover/minus.png`
+ * - clicked - `clicked/minus.png`
+ *
+ * @class
+ */
 export declare class NegButton extends BaseButton {
     static readonly registryName = "negButton";
     constructor();

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

@@ -1,6 +1,15 @@
 import { SoundTracks } from "../../../application";
 import { getTexture } from "../../../utils";
 import { BaseButton, ButtonStates } from "../BaseButton";
+/**
+ * Button for decreasing bet value.
+ * It needs following textures:
+ * - normal - `normal/minus.png`
+ * - hover - `hover/minus.png`
+ * - clicked - `clicked/minus.png`
+ *
+ * @class
+ */
 export class NegButton extends BaseButton {
     static registryName = "negButton";
     constructor() {

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

@@ -1,4 +1,15 @@
 import { BaseButton } from "../BaseButton";
+/**
+ * Button for increasing bet value.
+ *  It needs following textures:
+ * - normal - `normal/plus.png`
+ * - hover - `hover/plus.png`
+ * - clicked - `clicked/plus.png`
+ * - mobile - `mobile/bet.png`
+ * - mobile/clicked - `mobile/clicked/bet.png`
+ *
+ * @class
+ */
 export declare class PlusButton extends BaseButton {
     static readonly registryName = "plusButton";
     constructor(mobile?: boolean);