pixi-rainman-game-engine 0.3.0 → 0.3.2

package/dist/components/common/AnimatedNumber.js

@@ -4,6 +4,11 @@ import { getSpineData } from "../../utils";
 /**
  * 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 class AnimatedNumber extends Container {
     spineName;
@@ -15,6 +20,11 @@ export class AnimatedNumber extends Container {
         this.number = number;
         this.setDigits();
     }
+    /**
+     * Function for setting position of digits in row
+     * @private
+     * @returns {void}
+     */
     setDigits() {
         this.removeDigits();
         Array.from(this.number.toString()).forEach((digit) => {
@@ -31,6 +41,11 @@ export class AnimatedNumber extends Container {
         });
         this.pivot.set(this.width / 2, this.height / 2);
     }
+    /**
+     * Function for setting move animation for digits.
+     * @public
+     * @returns {void}
+     */
     setMoveAnimation() {
         this.removeDigits();
         Array.from(this.number.toString()).forEach((digit) => {
@@ -47,17 +62,38 @@ export class AnimatedNumber extends Container {
         });
         this.pivot.set(this.width / 2, this.height / 2);
     }
+    /**
+     * Function for removing digits from the display.
+     * @public
+     * @returns {void}
+     */
     removeDigits() {
         this.digits.forEach((digit) => this.removeChild(digit));
         this.digits = [];
     }
+    /**
+     * Getter for displayed value
+     * @public
+     * @returns {number | string} current displayed value
+     */
     get value() {
         return this.number;
     }
+    /**
+     * Setter for displayed value
+     * @public
+     * @param {number | string} value new displayed value
+     * @returns {void}
+     */
     set value(value) {
         this.number = value;
         this.setDigits();
     }
+    /**
+     * Function for playing the animation.
+     * @public
+     * @returns {void}
+     */
     play() {
         this.digits.forEach((digit) => (digit.state.timeScale = 1));
     }

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

@@ -13,8 +13,28 @@ export declare class Background extends Sprite {
     static readonly registryName = "background";
     private lastDeviceOrientation?;
     constructor(backgroundDesktop: string, backgroundMobile: string);
+    /**
+     * Function for resizing the background.
+     * @public
+     * @returns {void}
+     */
     resize(): void;
+    /**
+     * Function for setting texture for background on desktop
+     * @private
+     * @returns {void}
+     */
     private setDesktopBackground;
+    /**
+     * Function for setting texture for background on mobile
+     * @private
+     * @returns {void}
+     */
     private setMobileBackground;
+    /**
+     * Function for changing the background based on device orientation
+     * @private
+     * @returns {void}
+     */
     private changeSpineForOrientation;
 }

package/dist/components/common/Background.js

@@ -26,22 +26,43 @@ export class Background extends Sprite {
         this.anchor.set(0, 0);
         this.resize();
     }
+    /**
+     * Function for resizing the background.
+     * @public
+     * @returns {void}
+     */
     resize() {
         this.changeSpineForOrientation();
         const backgroundOffset = 10;
         this.width = RainMan.app.screen.width + backgroundOffset;
         this.height = RainMan.app.screen.height + backgroundOffset;
     }
+    /**
+     * Function for setting texture for background on desktop
+     * @private
+     * @returns {void}
+     */
     setDesktopBackground() {
         this.texture = getTexture(this.backgroundDesktop);
     }
+    /**
+     * Function for setting texture for background on mobile
+     * @private
+     * @returns {void}
+     */
     setMobileBackground() {
         this.texture = getTexture(this.backgroundMobile);
     }
+    /**
+     * Function for changing the background based on device orientation
+     * @private
+     * @returns {void}
+     */
     changeSpineForOrientation() {
         const deviceOrientation = getDeviceOrientation();
-        if (deviceOrientation === this.lastDeviceOrientation)
+        if (deviceOrientation === this.lastDeviceOrientation) {
             return;
+        }
         this.lastDeviceOrientation = deviceOrientation;
         deviceOrientation === "mobile-portrait" ? this.setMobileBackground() : this.setDesktopBackground();
     }

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

@@ -13,10 +13,42 @@ export declare class FreeSpinButton extends ResumableContainer {
     private spine;
     private lastDeviceOrientation?;
     constructor(spineName: string, animationName: string, mobileSpineName?: string);
+    /**
+     * Setter for onClick callback
+     * @public
+     * @param {() => void} onClick callback for onclick
+     * @returns {void}
+     */
     setOnClick(onClick: () => void): void;
-    setInteractivity(newValue: boolean): void;
+    /**
+     * Setter for interactivity
+     * @public
+     * @param {boolean} shouldBeInteractive flag for setting interactivity
+     * @returns {void}
+     */
+    setInteractivity(shouldBeInteractive: boolean): void;
+    /**
+     * Function for resizing the button.
+     * @public
+     * @returns {void}
+     */
     resize(): void;
+    /**
+     * Function for setting the spine for desktop
+     * @private
+     * @returns {void}
+     */
     private setDesktopSpine;
+    /**
+     * Function for setting the spine for mobile
+     * @private
+     * @returns {void}
+     */
     private setMobileSpine;
+    /**
+     * Function for changing the spine based on device orientation
+     * @private
+     * @returns {void}
+     */
     private changeSpineForOrientation;
 }

package/dist/components/common/FreeSpinButton.js

@@ -32,27 +32,60 @@ export class FreeSpinButton extends ResumableContainer {
         this.y = 0;
         this.resize();
     }
+    /**
+     * Setter for onClick callback
+     * @public
+     * @param {() => void} onClick callback for onclick
+     * @returns {void}
+     */
     setOnClick(onClick) {
         this.addListener("pointerdown", onClick);
     }
-    setInteractivity(newValue) {
-        this.eventMode = newValue ? "static" : "auto";
-        this.spine.tint = new Color(newValue ? TINT_ENABLED : TINT_DISABLED).toNumber();
+    /**
+     * Setter for interactivity
+     * @public
+     * @param {boolean} shouldBeInteractive flag for setting interactivity
+     * @returns {void}
+     */
+    setInteractivity(shouldBeInteractive) {
+        this.eventMode = shouldBeInteractive ? "static" : "auto";
+        this.spine.tint = new Color(shouldBeInteractive ? TINT_ENABLED : TINT_DISABLED).toNumber();
     }
+    /**
+     * Function for resizing the button.
+     * @public
+     * @returns {void}
+     */
     resize() {
         this.changeSpineForOrientation();
     }
+    /**
+     * Function for setting the spine for desktop
+     * @private
+     * @returns {void}
+     */
     setDesktopSpine() {
         this.spine = new Spine(getSpineData(this.spineName));
         this.spine.state.setAnimation(0, this.animationName, true);
     }
+    /**
+     * Function for setting the spine for mobile
+     * @private
+     * @returns {void}
+     */
     setMobileSpine() {
         this.spine = new Spine(getSpineData(this.mobileSpineName));
         this.spine.state.setAnimation(0, this.animationName, true);
     }
+    /**
+     * Function for changing the spine based on device orientation
+     * @private
+     * @returns {void}
+     */
     changeSpineForOrientation() {
-        if (getDeviceOrientation() === this.lastDeviceOrientation)
+        if (getDeviceOrientation() === this.lastDeviceOrientation) {
             return;
+        }
         this.lastDeviceOrientation = getDeviceOrientation();
         this.removeChildren();
         getDeviceOrientation() === "mobile-portrait" ? this.setMobileSpine() : this.setDesktopSpine();

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

@@ -1,3 +1,7 @@
+/**
+ * Interface for resizable containers.
+ * @typedef {IResizableContainer}
+ */
 export interface IResizableContainer {
     resize(): void;
 }

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

@@ -13,8 +13,29 @@ export declare class Logo extends ResumableContainer {
     static readonly registryName = "logo";
     protected spine: Spine;
     constructor(desktopSpineName: string, animationName: string, mobileSpineName?: string);
+    /**
+     * Function for resizing the logo.
+     * @public
+     * @returns {void}
+     */
     resize(): void;
+    /**
+     * Function for repositioning the logo.
+     * @private
+     * @returns {void}
+     */
     private reposition;
+    /**
+     * Function for setting the spine
+     * @private
+     * @param {string} spineName spine name
+     * @returns {void}
+     */
     private setSpine;
+    /**
+     * Function for changing the spine based on device orientation
+     * @private
+     * @returns {void}
+     */
     private changeSpineForOrientation;
 }

package/dist/components/common/Logo.js

@@ -25,6 +25,11 @@ export class Logo extends ResumableContainer {
         this.setSpine(this.desktopSpineName);
         this.resize();
     }
+    /**
+     * Function for resizing the logo.
+     * @public
+     * @returns {void}
+     */
     resize() {
         this.changeSpineForOrientation();
         this.y = 0; // reset position
@@ -32,15 +37,31 @@ export class Logo extends ResumableContainer {
         this.scale.set(Math.min(1.5, globalMinRatio()));
         this.reposition();
     }
+    /**
+     * Function for repositioning the logo.
+     * @private
+     * @returns {void}
+     */
     reposition() {
         this.y = this.spine.getBounds().height / 2;
         this.x = RainMan.app.screen.width / 2;
     }
+    /**
+     * Function for setting the spine
+     * @private
+     * @param {string} spineName spine name
+     * @returns {void}
+     */
     setSpine(spineName) {
         this.spine = new Spine(getSpineData(spineName));
         this.spine.state.setAnimation(0, this.animationName, true);
         this.spine.visible = true;
     }
+    /**
+     * Function for changing the spine based on device orientation
+     * @private
+     * @returns {void}
+     */
     changeSpineForOrientation() {
         this.removeChildren();
         getDeviceOrientation() === "mobile-portrait"

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

@@ -8,6 +8,16 @@ import { Sprite } from "pixi.js";
 export declare class LogoStatic extends Sprite {
     private maxScale;
     constructor(textureName: string, maxScale?: number);
+    /**
+     * Function for resizing the logo.
+     * @public
+     * @returns {void}
+     */
     resize(): void;
+    /**
+     * Function for repositioning the logo.
+     * @private
+     * @returns {void}
+     */
     private reposition;
 }

package/dist/components/common/LogoStatic.js

@@ -17,10 +17,20 @@ export class LogoStatic extends Sprite {
         this.name = "logo";
         this.anchor.x = 0.5;
     }
+    /**
+     * Function for resizing the logo.
+     * @public
+     * @returns {void}
+     */
     resize() {
         this.scale.set(Math.min(this.maxScale, globalMinRatio()));
         this.reposition();
     }
+    /**
+     * Function for repositioning the logo.
+     * @private
+     * @returns {void}
+     */
     reposition() {
         this.x = RainMan.app.screen.width / 2;
     }

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

@@ -1,8 +1,30 @@
 import { Container } from "pixi.js";
+/**
+ * Abstract class for responsive containers.
+ * @class ResponsiveContainer
+ * @augments {Container}
+ */
 export declare abstract class ResponsiveContainer extends Container {
     protected scaleMultiplier: number;
     protected constructor(scaleMultiplier?: number);
+    /**
+     * Function for resizing the container.
+     * @public
+     * @returns {void}
+     */
     resize(): void;
+    /**
+     * Function for repositioning the container.
+     * @protected
+     * @abstract
+     * @returns {void}
+     */
     protected abstract reposition(): void;
+    /**
+     * Function for removing children from the registry.
+     * @public
+     * @abstract
+     * @returns {void}
+     */
     abstract removeChildrenFromRegistry(): void;
 }

package/dist/components/common/ResponsiveComponent.js

@@ -1,11 +1,21 @@
 import { Container } from "pixi.js";
 import { globalMinRatio } from "../../utils";
+/**
+ * Abstract class for responsive containers.
+ * @class ResponsiveContainer
+ * @augments {Container}
+ */
 export class ResponsiveContainer extends Container {
     scaleMultiplier;
     constructor(scaleMultiplier = 1) {
         super();
         this.scaleMultiplier = scaleMultiplier;
     }
+    /**
+     * Function for resizing the container.
+     * @public
+     * @returns {void}
+     */
     resize() {
         this.y = 0;
         this.x = 0;

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

@@ -9,7 +9,9 @@ export declare abstract class SpineWithResumableContainer extends Spine {
     protected allSpines: Spine[];
     /**
      * Sets animation timescale for all spines
+     * @public
      * @param {boolean} flag - flag to set timescale
+     * @returns {void}
      */
     setAnimationTimescale(flag: boolean): void;
 }
@@ -22,7 +24,9 @@ export declare abstract class ResumableContainer extends Container {
     protected allSpines: Spine[];
     /**
      * Sets animation timescale for all spines
+     * @public
      * @param {boolean} flag - flag to set timescale
+     * @returns {void}
      */
     setAnimationTimescale(flag: boolean): void;
 }
@@ -35,7 +39,9 @@ export declare abstract class SpriteWithResumableContainer extends Sprite {
     protected allSpines: Spine[];
     /**
      * Sets animation timescale for all spines
+     * @public
      * @param {boolean} flag - flag to set timescale
+     * @returns {void}
      */
     setAnimationTimescale(flag: boolean): void;
 }

package/dist/components/common/ResumableContainers.js

@@ -10,7 +10,9 @@ export class SpineWithResumableContainer extends Spine {
     allSpines = [];
     /**
      * Sets animation timescale for all spines
+     * @public
      * @param {boolean} flag - flag to set timescale
+     * @returns {void}
      */
     setAnimationTimescale(flag) {
         this.allSpines.forEach((spine) => setTimeScale(spine, flag));
@@ -25,7 +27,9 @@ export class ResumableContainer extends Container {
     allSpines = [];
     /**
      * Sets animation timescale for all spines
+     * @public
      * @param {boolean} flag - flag to set timescale
+     * @returns {void}
      */
     setAnimationTimescale(flag) {
         this.allSpines.forEach((spine) => setTimeScale(spine, flag));
@@ -40,7 +44,9 @@ export class SpriteWithResumableContainer extends Sprite {
     allSpines = [];
     /**
      * Sets animation timescale for all spines
+     * @public
      * @param {boolean} flag - flag to set timescale
+     * @returns {void}
      */
     setAnimationTimescale(flag) {
         this.allSpines.forEach((spine) => setTimeScale(spine, flag));

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

@@ -1,5 +1,16 @@
 import { Spine } from "pixi-spine";
+/**
+ * Class representing a scalable spine.
+ * @class ScalableSpine
+ * @augments {Spine}
+ */
 export declare class ScalableSpine extends Spine {
     constructor(spineName: string, animationName: string);
+    /**
+     * Function for setting the scale
+     * @public
+     * @param {number} scale scale value to set
+     * @returns {void}
+     */
     setScale(scale: number): void;
 }

package/dist/components/common/ScalableSpine.js

@@ -1,5 +1,10 @@
 import { Spine } from "pixi-spine";
 import { getSpineData } from "../../utils";
+/**
+ * Class representing a scalable spine.
+ * @class ScalableSpine
+ * @augments {Spine}
+ */
 export class ScalableSpine extends Spine {
     constructor(spineName, animationName) {
         super(getSpineData(spineName));
@@ -11,6 +16,12 @@ export class ScalableSpine extends Spine {
         this.x = 0;
         this.y = 0;
     }
+    /**
+     * Function for setting the scale
+     * @public
+     * @param {number} scale scale value to set
+     * @returns {void}
+     */
     setScale(scale) {
         this.scale.set(scale);
     }

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

@@ -40,12 +40,15 @@ export declare abstract class AbstractColumnsContainer extends Container impleme
     /**
      * Function for resolving changing symbols in columns
      * This is used in games i.e. BoW and MB
+     * @public
+     * @returns {void}
      */
     resolveMysterySpeedUp(): void;
     /**
      * Method for adapting to speed level
-     * @param {SpeedLevel} speedLevel new speed level
      * @public
+     * @param {SpeedLevel} speedLevel new speed level
+     * @returns {void}
      */
     adaptToSpeed(speedLevel: SpeedLevel): void;
     /**
@@ -57,11 +60,13 @@ export declare abstract class AbstractColumnsContainer extends Container impleme
     /**
      * Function for clearing quick reels stop
      * @public
+     * @returns {void}
      */
     clearQuickReelsStop(): void;
     /**
      * Function for blind spinning all columns
      * @public
+     * @returns {void}
      */
     blindSpin(): void;
     /**
@@ -75,11 +80,11 @@ export declare abstract class AbstractColumnsContainer extends Container impleme
     configBlindSpin(finalSymbolReels: SymbolReels, afterSpinResolver: (value: void | PromiseLike<void>) => void, indexesOfReelsToExtendSpinningTime: number[]): Promise<void>;
     /**
      * Function for playing all streaks
+     * @public
      * @param {StreakReelsIndexes[]} streaks - The streaks to play
      * @param {number} amount - The amount to play
      * @param {SymbolId[]} allSymbols - All symbols to consider
      * @returns {Promise<void>} - A promise that resolves when all streaks are played
-     * @public
      */
     playAllStreaks(streaks: StreakReelsIndexes[], amount: number, allSymbols?: SymbolId[]): Promise<void>;
     /**
@@ -90,12 +95,18 @@ export declare abstract class AbstractColumnsContainer extends Container impleme
     resetPlayedSounds(): void;
     /**
      * Function for playing sound depending on the amount
-     * @public
+     * @protected
      * @param {number} amount - The amount to check
      * @param {SymbolId[]} _allSymbols - All symbols to consider
      * @returns {void}
      */
     protected playSoundDependingOnAmount(amount: number, _allSymbols?: SymbolId[]): void;
+    /**
+     * Function for playing streak sounds
+     * @protected
+     * @param {SymbolId[]} symbols symbols of the streak
+     * @returns {void}
+     */
     protected playStreakSound(symbols: SymbolId[]): void;
     /**
      * Function for playing animation of streak
@@ -123,10 +134,10 @@ export declare abstract class AbstractColumnsContainer extends Container impleme
     animate(delta: number): void;
     /**
      * Function for getting column at specific position
-     * @param {number} column index of column
-     * @returns {AbstractSymbolsColumn} column at specific position
      * @public
      * @abstract
+     * @param {number} column index of column
+     * @returns {AbstractSymbolsColumn} column at specific position
      */
     abstract getColumnAtPosition(column: number): AbstractSymbolsColumn;
     /**
@@ -143,13 +154,14 @@ export declare abstract class AbstractColumnsContainer extends Container impleme
     stopPlayingSymbolsTransformationInColumns(): void;
     /**
      * Function for setting interactivity for all symbols in columns
-     * @param {boolean} flag - flag for setting interactivity
      * @public
+     * @param {boolean} flag - flag for setting interactivity
      * @returns {void}
      */
     setInteractivityForSymbols(flag: boolean): void;
     /**
      * Function for handling multiple symbol transformations
+     * @public
      * @param {DropTransformationDetails} transformations - array of transformations to apply
      * @param {boolean} skipAnimations - flag for skipping animations
      * @param {boolean} isStandalone - flag for standalone mode
@@ -166,10 +178,12 @@ export declare abstract class AbstractColumnsContainer extends Container impleme
     /**
      * Function for fixing symbols columns position
      * @public
+     * @returns {void}
      */
     fixSymbolsColumnsPosition(): void;
     /**
      * Function for preparing configuring reels end
+     * @protected
      * @param {SymbolReels} finalSymbolReels - final symbol reels
      * @returns {PlayableAction[]} - array of playable actions
      */