pixi-rainman-game-engine 0.2.2 → 0.2.3

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

@@ -1,7 +1,7 @@
 import { BaseButton, ButtonStates } from "../BaseButton";
 /**
  * Button for handling autoplay
- *  It needs following textures:
+ * It needs following textures:
  * - normal - `normal/autoplay.png`
  * - hover - `hover/autoplay.png`
  * - clicked - `clicked/autoplay.png`
@@ -9,9 +9,8 @@ import { BaseButton, ButtonStates } from "../BaseButton";
  * - 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}
+ * @augments {BaseButton}
  */
 export declare class AutoplayButton extends BaseButton {
     private mobile;

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

@@ -5,7 +5,7 @@ import { getTexture, getTextureSafely } from "../../../utils";
 import { BaseButton, ButtonStates } from "../BaseButton";
 /**
  * Button for handling autoplay
- *  It needs following textures:
+ * It needs following textures:
  * - normal - `normal/autoplay.png`
  * - hover - `hover/autoplay.png`
  * - clicked - `clicked/autoplay.png`
@@ -13,9 +13,8 @@ import { BaseButton, ButtonStates } from "../BaseButton";
  * - 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}
+ * @augments {BaseButton}
  */
 export class AutoplayButton extends BaseButton {
     mobile;

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

@@ -1,11 +1,10 @@
 import { BaseButton } from "../BaseButton";
 /**
  * Button for handling black figure in Gamble Mechanic
- *  It needs following textures:
+ * It needs following textures:
  * - normal - `black-n.png`
  * - hover - `black-h.png`
  * - clicked - `black-c.png`
- *
  * @class
  */
 export declare class BlackButton extends BaseButton {

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

@@ -2,11 +2,10 @@ import { Texture } from "pixi.js";
 import { BaseButton, ButtonStates } from "../BaseButton";
 /**
  * Button for handling black figure in Gamble Mechanic
- *  It needs following textures:
+ * It needs following textures:
  * - normal - `black-n.png`
  * - hover - `black-h.png`
  * - clicked - `black-c.png`
- *
  * @class
  */
 export class BlackButton extends BaseButton {

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

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

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

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

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

@@ -7,8 +7,8 @@ import { BaseButton } from "../BaseButton";
  * - clicked - `clicked/info.png`
  * - mobile - `mobile/info.png`
  * - mobile/clicked - `mobile/clicked/info.png`
- *
  * @class
+ * @augments {BaseButton}
  */
 export declare class InfoButton extends BaseButton {
     static readonly registryName = "infoButton";

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

@@ -8,8 +8,8 @@ import { BaseButton, ButtonStates } from "../BaseButton";
  * - clicked - `clicked/info.png`
  * - mobile - `mobile/info.png`
  * - mobile/clicked - `mobile/clicked/info.png`
- *
  * @class
+ * @augments {BaseButton}
  */
 export class InfoButton extends BaseButton {
     static registryName = "infoButton";

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

@@ -7,8 +7,8 @@ import { BaseButton } from "../BaseButton";
  * - clicked - `clicked/menu.png`
  * - mobile - `mobile/menu.png`
  * - mobile/clicked - `mobile/clicked/menu.png`
- *
  * @class
+ * @augments {BaseButton}
  */
 export declare class MoreButton extends BaseButton {
     static readonly registryName = "moreButton";

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

@@ -8,8 +8,8 @@ import { BaseButton, ButtonStates } from "../BaseButton";
  * - clicked - `clicked/menu.png`
  * - mobile - `mobile/menu.png`
  * - mobile/clicked - `mobile/clicked/menu.png`
- *
  * @class
+ * @augments {BaseButton}
  */
 export class MoreButton extends BaseButton {
     static registryName = "moreButton";

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

@@ -5,8 +5,8 @@ import { BaseButton } from "../BaseButton";
  * - normal - `normal/minus.png`
  * - hover - `hover/minus.png`
  * - clicked - `clicked/minus.png`
- *
  * @class
+ * @augments {BaseButton}
  */
 export declare class NegButton extends BaseButton {
     static readonly registryName = "negButton";

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

@@ -7,8 +7,8 @@ import { BaseButton, ButtonStates } from "../BaseButton";
  * - normal - `normal/minus.png`
  * - hover - `hover/minus.png`
  * - clicked - `clicked/minus.png`
- *
  * @class
+ * @augments {BaseButton}
  */
 export class NegButton extends BaseButton {
     static registryName = "negButton";

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

@@ -7,8 +7,8 @@ import { BaseButton } from "../BaseButton";
  * - clicked - `clicked/plus.png`
  * - mobile - `mobile/bet.png`
  * - mobile/clicked - `mobile/clicked/bet.png`
- *
  * @class
+ * @augments {BaseButton}
  */
 export declare class PlusButton extends BaseButton {
     static readonly registryName = "plusButton";

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

@@ -9,8 +9,8 @@ import { BaseButton, ButtonStates } from "../BaseButton";
  * - clicked - `clicked/plus.png`
  * - mobile - `mobile/bet.png`
  * - mobile/clicked - `mobile/clicked/bet.png`
- *
  * @class
+ * @augments {BaseButton}
  */
 export class PlusButton extends BaseButton {
     static registryName = "plusButton";

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

@@ -5,8 +5,8 @@ import { BaseButton } from "../BaseButton";
  * - normal - `red-n.png`
  * - hover - `red-h.png`
  * - clicked - `red-c.png`
- *
  * @class
+ * @augments {BaseButton}
  */
 export declare class RedButton extends BaseButton {
     static readonly registryName = "gambleCollectButton";

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

@@ -6,8 +6,8 @@ import { BaseButton, ButtonStates } from "../BaseButton";
  * - normal - `red-n.png`
  * - hover - `red-h.png`
  * - clicked - `red-c.png`
- *
  * @class
+ * @augments {BaseButton}
  */
 export class RedButton extends BaseButton {
     static registryName = "gambleCollectButton";

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

@@ -14,8 +14,9 @@ import { BaseButton, ButtonStates } from "../BaseButton";
  * Also 2 more sprites:
  * - arrows - `normal/arrows.png`
  * - stop - `normal/stop.png`
- *
  * @class
+ * @augments {BaseButton}
+ * @implements {IncentiveComponent}
  */
 export declare class RefreshButton extends BaseButton implements IncentiveComponent {
     static readonly registryName = "refreshButton";

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

@@ -17,8 +17,9 @@ import { BaseButton, ButtonStates } from "../BaseButton";
  * Also 2 more sprites:
  * - arrows - `normal/arrows.png`
  * - stop - `normal/stop.png`
- *
  * @class
+ * @augments {BaseButton}
+ * @implements {IncentiveComponent}
  */
 export class RefreshButton extends BaseButton {
     static registryName = "refreshButton";

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

@@ -6,7 +6,6 @@ import { BaseButton, TextureMap } from "../BaseButton";
  * - turtle - `speed-turtle.png`
  * - rabbit - `speed-rabbit.png`
  * - cheetah - `speed-cheetah.png`
- *
  * @class
  */
 export declare class SpeedControlButton extends BaseButton implements SpeedAdapterInterface<TextureMap> {
@@ -15,6 +14,7 @@ export declare class SpeedControlButton extends BaseButton implements SpeedAdapt
     constructor();
     /**
      * Change button's texture according to speed level
+     * @param {SpeedLevel} speedLevel - new speed level
      */
     adaptToSpeed(speedLevel: SpeedLevel): void;
 }

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

@@ -13,7 +13,6 @@ const createTextureMap = (speedLevel) => {
  * - turtle - `speed-turtle.png`
  * - rabbit - `speed-rabbit.png`
  * - cheetah - `speed-cheetah.png`
- *
  * @class
  */
 export class SpeedControlButton extends BaseButton {
@@ -29,6 +28,7 @@ export class SpeedControlButton extends BaseButton {
     }
     /**
      * Change button's texture according to speed level
+     * @param {SpeedLevel} speedLevel - new speed level
      */
     adaptToSpeed(speedLevel) {
         this.setTextureMap(this.speedLevelMapper[speedLevel]);

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

@@ -5,6 +5,7 @@ import { BaseButton } from "../BaseButton";
  * - normal - `freeSpin_confirm_normal.png`
  * - hover - `freeSpin_confirm_hover.png`
  * - clicked - `freeSpin_confirm_clicked.png`
+ * @augments {BaseButton}
  */
 export declare class SpinConfirmationButton extends BaseButton {
     static registryName: string;

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

@@ -6,6 +6,7 @@ import { BaseButton, ButtonStates } from "../BaseButton";
  * - normal - `freeSpin_confirm_normal.png`
  * - hover - `freeSpin_confirm_hover.png`
  * - clicked - `freeSpin_confirm_clicked.png`
+ * @augments {BaseButton}
  */
 export class SpinConfirmationButton extends BaseButton {
     static registryName = "spinConfirmationButton";

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

@@ -8,8 +8,8 @@ import { BaseButton } from "../BaseButton";
  * - mute - `mute.png`
  * - mute-h - `mute-h.png`
  * - mute-c - `mute-c.png`
- *
  * @class
+ * @augments {BaseButton}
  */
 export declare class VolumeButton extends BaseButton {
     static readonly registryName = "volumeButton";

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

@@ -10,8 +10,8 @@ import { BaseButton, ButtonStates } from "../BaseButton";
  * - mute - `mute.png`
  * - mute-h - `mute-h.png`
  * - mute-c - `mute-c.png`
- *
  * @class
+ * @augments {BaseButton}
  */
 export class VolumeButton extends BaseButton {
     static registryName = "volumeButton";

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

@@ -3,11 +3,9 @@ import { ResumableContainer } from "./ResumableContainers";
 /**
  * Every game have animated background with animation
  * This class represents the animated background that have every game
- *
- * @export
  * @class AnimatedBackground
  * @typedef {AnimatedBackground}
- * @extends {ResumableContainer}
+ * @augments {ResumableContainer}
  */
 export declare class AnimatedBackground extends ResumableContainer {
     private desktopSpineName;
@@ -21,7 +19,6 @@ export declare class AnimatedBackground extends ResumableContainer {
      * 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
      */
     protected changeForFreeSpins(): void;
@@ -29,7 +26,6 @@ export declare class AnimatedBackground extends ResumableContainer {
      * This method is called when base game is triggered
      * It is used to change the background animation
      * Remember to change resize for this method
-     *
      * @protected
      */
     protected changeForBaseGame(): void;

package/dist/components/common/AnimatedBackground.js

@@ -6,11 +6,9 @@ import { ResumableContainer } from "./ResumableContainers";
 /**
  * Every game have animated background with animation
  * This class represents the animated background that have every game
- *
- * @export
  * @class AnimatedBackground
  * @typedef {AnimatedBackground}
- * @extends {ResumableContainer}
+ * @augments {ResumableContainer}
  */
 export class AnimatedBackground extends ResumableContainer {
     desktopSpineName;
@@ -37,7 +35,6 @@ export class AnimatedBackground extends ResumableContainer {
      * 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
      */
     changeForFreeSpins() { }
@@ -45,7 +42,6 @@ export class AnimatedBackground extends ResumableContainer {
      * This method is called when base game is triggered
      * It is used to change the background animation
      * Remember to change resize for this method
-     *
      * @protected
      */
     changeForBaseGame() { }

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

@@ -1,13 +1,11 @@
 import { Sprite } from "pixi.js";
 /**
  * This class represents background image while loading game
- *  - backgroundDesktop - name of desktop background png
- *  - backgroundMobile - name of mobile background png
- *
- * @export
+ * - backgroundDesktop - name of desktop background png
+ * - backgroundMobile - name of mobile background png
  * @class Background
  * @typedef {Background}
- * @extends {Sprite}
+ * @augments {Sprite}
  */
 export declare class Background extends Sprite {
     private backgroundDesktop;

package/dist/components/common/Background.js

@@ -4,13 +4,11 @@ import { RainMan } from "../../Rainman";
 import { getDeviceOrientation, getTexture } from "../../utils";
 /**
  * This class represents background image while loading game
- *  - backgroundDesktop - name of desktop background png
- *  - backgroundMobile - name of mobile background png
- *
- * @export
+ * - backgroundDesktop - name of desktop background png
+ * - backgroundMobile - name of mobile background png
  * @class Background
  * @typedef {Background}
- * @extends {Sprite}
+ * @augments {Sprite}
  */
 export class Background extends Sprite {
     backgroundDesktop;

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

@@ -1,11 +1,9 @@
 import { ResumableContainer } from "./ResumableContainers";
 /**
  * This class represents button/box with ability to buy free games
- *
- * @export
  * @class FreeSpinButton
  * @typedef {FreeSpinButton}
- * @extends {ResumableContainer}
+ * @augments {ResumableContainer}
  */
 export declare class FreeSpinButton extends ResumableContainer {
     private spineName;

package/dist/components/common/FreeSpinButton.js

@@ -7,11 +7,9 @@ import { getDeviceOrientation, getSpineData } from "../../utils";
 import { ResumableContainer } from "./ResumableContainers";
 /**
  * This class represents button/box with ability to buy free games
- *
- * @export
  * @class FreeSpinButton
  * @typedef {FreeSpinButton}
- * @extends {ResumableContainer}
+ * @augments {ResumableContainer}
  */
 export class FreeSpinButton extends ResumableContainer {
     spineName;

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

@@ -2,11 +2,9 @@ import { Spine } from "pixi-spine";
 import { ResumableContainer } from "./ResumableContainers";
 /**
  * This logo is animated logo that will display after loading the game
- *
- * @export
  * @class Logo
  * @typedef {Logo}
- * @extends {ResumableContainer}
+ * @augments {ResumableContainer}
  */
 export declare class Logo extends ResumableContainer {
     private desktopSpineName;

package/dist/components/common/Logo.js

@@ -5,11 +5,9 @@ import { getDeviceOrientation, getSpineData, globalMinRatio } from "../../utils"
 import { ResumableContainer } from "./ResumableContainers";
 /**
  * This logo is animated logo that will display after loading the game
- *
- * @export
  * @class Logo
  * @typedef {Logo}
- * @extends {ResumableContainer}
+ * @augments {ResumableContainer}
  */
 export class Logo extends ResumableContainer {
     desktopSpineName;

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

@@ -1,11 +1,9 @@
 import { Sprite } from "pixi.js";
 /**
  * This class is used to display game logo at LoadingScreen
- *
- * @export
  * @class LogoStatic
  * @typedef {LogoStatic}
- * @extends {Sprite}
+ * @augments {Sprite}
  */
 export declare class LogoStatic extends Sprite {
     private maxScale;

package/dist/components/common/LogoStatic.js

@@ -3,11 +3,9 @@ import { RainMan } from "../../Rainman";
 import { getTexture, globalMinRatio } from "../../utils";
 /**
  * This class is used to display game logo at LoadingScreen
- *
- * @export
  * @class LogoStatic
  * @typedef {LogoStatic}
- * @extends {Sprite}
+ * @augments {Sprite}
  */
 export class LogoStatic extends Sprite {
     maxScale;

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

@@ -2,40 +2,40 @@ import { Container, Sprite } from "pixi.js";
 import { Spine } from "pixi-spine";
 /**
  * Class representing container with all spines. Every used spine have to be put in `allSpines` array to enable battery saver functionality
- *
- * @extends {Spine}
+ * @augments {Spine}
  * @class
  */
 export declare abstract class SpineWithResumableContainer extends Spine {
     protected allSpines: Spine[];
     /**
      * Sets animation timescale for all spines
+     * @param {boolean} flag - flag to set timescale
      */
     setAnimationTimescale(flag: boolean): void;
 }
 /**
  * Class representing container with all spines array
- *
- * @extends {Container}
+ * @augments {Container}
  * @class
  */
 export declare abstract class ResumableContainer extends Container {
     protected allSpines: Spine[];
     /**
      * Sets animation timescale for all spines
+     * @param {boolean} flag - flag to set timescale
      */
     setAnimationTimescale(flag: boolean): void;
 }
 /**
  * Class representing container with all spines array
- *
- * @extends {Sprite}
+ * @augments {Sprite}
  * @class
  */
 export declare abstract class SpriteWithResumableContainer extends Sprite {
     protected allSpines: Spine[];
     /**
      * Sets animation timescale for all spines
+     * @param {boolean} flag - flag to set timescale
      */
     setAnimationTimescale(flag: boolean): void;
 }

package/dist/components/common/ResumableContainers.js

@@ -3,14 +3,14 @@ import { Spine } from "pixi-spine";
 import { setTimeScale } from "../../utils";
 /**
  * Class representing container with all spines. Every used spine have to be put in `allSpines` array to enable battery saver functionality
- *
- * @extends {Spine}
+ * @augments {Spine}
  * @class
  */
 export class SpineWithResumableContainer extends Spine {
     allSpines = [];
     /**
      * Sets animation timescale for all spines
+     * @param {boolean} flag - flag to set timescale
      */
     setAnimationTimescale(flag) {
         this.allSpines.forEach((spine) => setTimeScale(spine, flag));
@@ -18,14 +18,14 @@ export class SpineWithResumableContainer extends Spine {
 }
 /**
  * Class representing container with all spines array
- *
- * @extends {Container}
+ * @augments {Container}
  * @class
  */
 export class ResumableContainer extends Container {
     allSpines = [];
     /**
      * Sets animation timescale for all spines
+     * @param {boolean} flag - flag to set timescale
      */
     setAnimationTimescale(flag) {
         this.allSpines.forEach((spine) => setTimeScale(spine, flag));
@@ -33,14 +33,14 @@ export class ResumableContainer extends Container {
 }
 /**
  * Class representing container with all spines array
- *
- * @extends {Sprite}
+ * @augments {Sprite}
  * @class
  */
 export class SpriteWithResumableContainer extends Sprite {
     allSpines = [];
     /**
      * Sets animation timescale for all spines
+     * @param {boolean} flag - flag to set timescale
      */
     setAnimationTimescale(flag) {
         this.allSpines.forEach((spine) => setTimeScale(spine, flag));

package/dist/components/frame/AbstractColumnsContainer.d.ts

@@ -5,12 +5,10 @@ import { PlayableAction } from "../../utils";
 import { AbstractSymbolsColumn } from "../symbols";
 /**
  * Class represents columns container in game
- *
- * @export
  * @abstract
  * @class AbstractColumnsContainer
  * @typedef {AbstractColumnsContainer}
- * @extends {Container}
+ * @augments {Container}
  * @implements {SpeedAdapterInterface<number>}
  */
 export declare abstract class AbstractColumnsContainer extends Container implements SpeedAdapterInterface<number> {
@@ -40,9 +38,7 @@ export declare abstract class AbstractColumnsContainer extends Container impleme
     blindSpin(): void;
     /**
      * This function is responsible for setting symbols in columns
-     *
      * @public
-     * @async
      * @param {SymbolReels} finalSymbolReels
      * @param {(value: void | PromiseLike<void>) => void} afterSpinResolver
      * @param {number[]} indexesOfReelsToExtendSpinningTime
@@ -55,13 +51,11 @@ export declare abstract class AbstractColumnsContainer extends Container impleme
     protected playStreakSound(symbols: SymbolId[]): void;
     /**
      * Function for playing animation of streak
-     *
      * @public
-     * @async
      * @param {StreakReelsIndexes} streak
      * @param {number} reelsQuantity
-     * @param {number} [multiplier=1]
-     * @param {string} [suffix=""]
+     * @param {number} [multiplier]
+     * @param {string} [suffix]
      * @returns {Promise<void>}
      */
     playStreak(streak: StreakReelsIndexes, reelsQuantity: number, multiplier?: number, suffix?: string): Promise<void>;