pixi-rainman-game-engine 0.2.2 → 0.2.3

package/dist/application/ApiConfig/TransformationTypesId.d.ts

@@ -1,8 +1,6 @@
 /**
  * Interface for specifying transformation in game
  * This type can be modified for each game in engine.d.ts file
- *
- * @export
  * @interface SymbolIds
  * @typedef {SymbolIds}
  */
@@ -10,8 +8,6 @@ export interface TransformationTypesId {
 }
 /**
  * Type for accessing symbols in game
- *
- * @export
  * @typedef {TransformationTypeId}
  */
 export type TransformationTypeId = TransformationTypesId[keyof TransformationTypesId];

package/dist/application/ApiConfig/WinTypeId.d.ts

@@ -7,8 +7,6 @@
  *  streak: "streak";
  *   }
  * ```
- *
- * @export
  * @interface WinTypeIds
  * @typedef {WinTypeIds}
  */
@@ -16,8 +14,6 @@ export interface WinTypeIds {
 }
 /**
  * Interface for specifying symbols in game
- *
- * @export
  * @typedef {WinTypeId}
  */
 export type WinTypeId = WinTypeIds[keyof WinTypeIds];

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

@@ -14,8 +14,6 @@ export declare const SPEED_PREFIX = "speed-";
  * - More Button
  * - Autoplay Button
  * - Volume Button
- *
- * @exports
  */
 export declare class ButtonsEventManager {
     private settingsPlusButton;
@@ -26,21 +24,18 @@ export declare class ButtonsEventManager {
     private settingsSpeedCheetah;
     /**
      * Last layer invoked
-     *
      * @memberof ButtonsEventManager
      */
     private lastLayerInvoked;
     /**
      * Speed popup shown at for measuring time of showing speed popup
-     *
      * @memberof ButtonsEventManager
      */
     speedPopupShownAt: number;
     /**
      * Function for enabling/disabling buttons in game
-     *
-     * @param {boolean} makeDisabled
-     * @returns {() => void}
+     * @param {boolean} makeDisabled - flag for enabling/disabling buttons
+     * @returns {() => void} function for enabling/disabling buttons
      */
     private setButtonAvailability;
     enableButtons: () => void;
@@ -48,35 +43,30 @@ export declare class ButtonsEventManager {
     constructor();
     /**
      * Method for initializing events in Settings UI
-     *
      * @public
      */
     initSettingsEvents(): void;
     /**
      * Method for setting up animated background
-     *
      * @public
      */
     setUpUIElementsInteractivity(): void;
     /**
      * Method for initializing Plus button
      * This method changes bet in game based on given strategy
-     *
      * @public
-     * @param {(strategy: "first" | "increase" | "decrease") => void} setBetCallback
+     * @param {(strategy: "first" | "increase" | "decrease") => void} setBetCallback - callback for setting bet
      */
     initBetPlusButtonEvent(setBetCallback: (strategy: "first" | "increase" | "decrease") => void): void;
     /**
      * Method for initializing Neg button
      * This method changes bet in game based on given strategy
-     *
      * @public
-     * @param {(strategy: "first" | "increase" | "decrease") => void} setBetCallback
+     * @param {(strategy: "first" | "increase" | "decrease") => void} setBetCallback - callback for setting bet
      */
     initBetMinusButtonEvent(setBetCallback: (strategy: "first" | "increase" | "decrease") => void): void;
     /**
      * Method for enabling ability to buy free spins in game
-     *
      * @public
      */
     initFreeSpinModal(): void;
@@ -84,72 +74,61 @@ export declare class ButtonsEventManager {
      * Method for initializing volume button
      * This method changes texture of Volume button based on volume level
      * If music was muted, it will be resumed
-     *
      * @public
      */
     initVolumeButtonEvent(): void;
     /**
      * Method for initializing button with information about mechanics in game
-     *
      * @public
      */
     initInfoButtonEvent(): void;
     /**
      * Method for initializing more button
-     *
      * @public
      */
     initMoreButtonEvent(): void;
     /**
      * Method for initializing Autoplay button
-     *
      * @public
      */
     initAutoplayButtonEvent(): void;
     /**
      * Initializing gamble game button
-     *
      * @public
-     * @param {() => void} onClick
-     * @param {boolean} disabled
+     * @param {() => void} onClick - callback for gamble game
+     * @param {boolean} disabled - flag for enabling/disabling button
      */
     initGambleButton(onClick: () => void, disabled: boolean): void;
     /**
      * Function for displaying speed modal
      * This modal is used while doing turbo spin
-     *
      * @public
-     * @param {("flex" | "none")} displayValue
+     * @param {("flex" | "none")} displayValue - flag for displaying modal
      */
     setSpeedPopupVisibility(displayValue: "flex" | "none"): void;
     /**
      * Function for handling autostart conformation
-     *
      * @public
-     * @param {() => void} confirmAutoplayButtonCallback
+     * @param {() => void} confirmAutoplayButtonCallback - callback for confirming autoplay
      */
     setConfirmAutoplayButton(confirmAutoplayButtonCallback: () => void): void;
     /**
      * Getter for displayed modal
-     *
      * @public
-     * @returns {Nullable<HTMLElement>}
+     * @returns {Nullable<HTMLElement>} - displayed modal
      */
     getInvokedSettingItem(): Nullable<HTMLElement>;
     /**
      * Function for disabling action while on given promise
-     *
      * @public
-     * @async
-     * @param {() => Promise<void>} actionToWait
+     * @param {() => Promise<void>} actionToWait - action to wait
      * @returns {Promise<void>}
      */
     disableButtonsForAction(actionToWait: () => Promise<void>): Promise<void>;
     /**
      * Function for displaying modal layer with given name
-     *
      * @private
-     * @param {string} layerName
+     * @param {string} layerName - name of layer
      */
     private handleModalInvocation;
     private checkAnyLayerIsPresent;

package/dist/application/ButtonsEventManager/ButtonsEventManager.js

@@ -20,8 +20,6 @@ export const SPEED_PREFIX = "speed-";
  * - More Button
  * - Autoplay Button
  * - Volume Button
- *
- * @exports
  */
 export class ButtonsEventManager {
     settingsPlusButton = null;
@@ -32,21 +30,18 @@ export class ButtonsEventManager {
     settingsSpeedCheetah = null;
     /**
      * Last layer invoked
-     *
      * @memberof ButtonsEventManager
      */
     lastLayerInvoked = "";
     /**
      * Speed popup shown at for measuring time of showing speed popup
-     *
      * @memberof ButtonsEventManager
      */
     speedPopupShownAt = 0;
     /**
      * Function for enabling/disabling buttons in game
-     *
-     * @param {boolean} makeDisabled
-     * @returns {() => void}
+     * @param {boolean} makeDisabled - flag for enabling/disabling buttons
+     * @returns {() => void} function for enabling/disabling buttons
      */
     setButtonAvailability = (makeDisabled) => () => {
         const buttonsToDisable = [SpeedControlButton.registryName, BUTTONS.neg, BUTTONS.plus];
@@ -61,7 +56,6 @@ export class ButtonsEventManager {
     }
     /**
      * Method for initializing events in Settings UI
-     *
      * @public
      */
     initSettingsEvents() {
@@ -130,7 +124,6 @@ export class ButtonsEventManager {
     }
     /**
      * Method for setting up animated background
-     *
      * @public
      */
     setUpUIElementsInteractivity() {
@@ -145,9 +138,8 @@ export class ButtonsEventManager {
     /**
      * Method for initializing Plus button
      * This method changes bet in game based on given strategy
-     *
      * @public
-     * @param {(strategy: "first" | "increase" | "decrease") => void} setBetCallback
+     * @param {(strategy: "first" | "increase" | "decrease") => void} setBetCallback - callback for setting bet
      */
     initBetPlusButtonEvent(setBetCallback) {
         if (this.settingsPlusButton === null) {
@@ -160,9 +152,8 @@ export class ButtonsEventManager {
     /**
      * Method for initializing Neg button
      * This method changes bet in game based on given strategy
-     *
      * @public
-     * @param {(strategy: "first" | "increase" | "decrease") => void} setBetCallback
+     * @param {(strategy: "first" | "increase" | "decrease") => void} setBetCallback - callback for setting bet
      */
     initBetMinusButtonEvent(setBetCallback) {
         if (this.settingsMinusButton === null) {
@@ -174,7 +165,6 @@ export class ButtonsEventManager {
     }
     /**
      * Method for enabling ability to buy free spins in game
-     *
      * @public
      */
     initFreeSpinModal() {
@@ -186,7 +176,6 @@ export class ButtonsEventManager {
      * Method for initializing volume button
      * This method changes texture of Volume button based on volume level
      * If music was muted, it will be resumed
-     *
      * @public
      */
     initVolumeButtonEvent() {
@@ -201,7 +190,6 @@ export class ButtonsEventManager {
     }
     /**
      * Method for initializing button with information about mechanics in game
-     *
      * @public
      */
     initInfoButtonEvent() {
@@ -214,7 +202,6 @@ export class ButtonsEventManager {
     }
     /**
      * Method for initializing more button
-     *
      * @public
      */
     initMoreButtonEvent() {
@@ -227,7 +214,6 @@ export class ButtonsEventManager {
     }
     /**
      * Method for initializing Autoplay button
-     *
      * @public
      */
     initAutoplayButtonEvent() {
@@ -248,10 +234,9 @@ export class ButtonsEventManager {
     }
     /**
      * Initializing gamble game button
-     *
      * @public
-     * @param {() => void} onClick
-     * @param {boolean} disabled
+     * @param {() => void} onClick - callback for gamble game
+     * @param {boolean} disabled - flag for enabling/disabling button
      */
     initGambleButton(onClick, disabled) {
         if (!RainMan.componentRegistry.has(BUTTONS.gamble))
@@ -262,9 +247,8 @@ export class ButtonsEventManager {
     /**
      * Function for displaying speed modal
      * This modal is used while doing turbo spin
-     *
      * @public
-     * @param {("flex" | "none")} displayValue
+     * @param {("flex" | "none")} displayValue - flag for displaying modal
      */
     setSpeedPopupVisibility(displayValue) {
         if (displayValue === "flex")
@@ -277,9 +261,8 @@ export class ButtonsEventManager {
     }
     /**
      * Function for handling autostart conformation
-     *
      * @public
-     * @param {() => void} confirmAutoplayButtonCallback
+     * @param {() => void} confirmAutoplayButtonCallback - callback for confirming autoplay
      */
     setConfirmAutoplayButton(confirmAutoplayButtonCallback) {
         const confirmAutoplayButton = window.document.getElementById(COMPONENTS.autoSpinConfirm);
@@ -292,9 +275,8 @@ export class ButtonsEventManager {
     }
     /**
      * Getter for displayed modal
-     *
      * @public
-     * @returns {Nullable<HTMLElement>}
+     * @returns {Nullable<HTMLElement>} - displayed modal
      */
     getInvokedSettingItem() {
         for (const itemId of allUiItems) {
@@ -307,10 +289,8 @@ export class ButtonsEventManager {
     }
     /**
      * Function for disabling action while on given promise
-     *
      * @public
-     * @async
-     * @param {() => Promise<void>} actionToWait
+     * @param {() => Promise<void>} actionToWait - action to wait
      * @returns {Promise<void>}
      */
     async disableButtonsForAction(actionToWait) {
@@ -320,9 +300,8 @@ export class ButtonsEventManager {
     }
     /**
      * Function for displaying modal layer with given name
-     *
      * @private
-     * @param {string} layerName
+     * @param {string} layerName - name of layer
      */
     handleModalInvocation(layerName) {
         if (this.checkAnyLayerIsPresent(layerName))

package/dist/application/SoundManager/SoundManager.d.ts

@@ -6,7 +6,6 @@ export declare const pixiSoundContext: typeof sound.context;
  * Class for managing sound in game, uses the pixi sound library
  * The class uses SoundTrack enum to access specified sounds
  *
- * @exports
  */
 export declare class SoundManagerInstance implements SpeedAdapterInterface<SoundOverrides> {
     private static instance;
@@ -17,15 +16,12 @@ export declare class SoundManagerInstance implements SpeedAdapterInterface<Sound
     constructor();
     /**
      * Function for loading sounds into pixi
-     *
-     * @async
-     * @param {Record<string, string>} assets
+     * @param {Record<string, string>} assets - sound assets
      */
     loadSounds(assets: Record<string, string>): Promise<void>;
     /**
      * Function for setting volume level for each sound in game
-     *
-     * @param {number} volumeLevel
+     * @param {number} volumeLevel - volume level from 0-1
      */
     setVolume(volumeLevel: number): void;
     /**
@@ -34,15 +30,13 @@ export declare class SoundManagerInstance implements SpeedAdapterInterface<Sound
     stopPlayingFxSounds(): void;
     /**
      * Function for resuming and pausing sound in game
-     *
-     * @param {SoundTrack} soundName
-     * @param {boolean} flag
+     * @param {SoundTrack} soundName - sound name
+     * @param {boolean} flag - flag for playing or pausing sound
      */
     setPlayStatus(soundName: SoundTrack, flag: boolean): void;
     /**
      * Function for playing sound with given name
-     *
-     * @param {SoundTrack} soundName
+     * @param {SoundTrack} soundName - name of the sound
      */
     play(soundName: SoundTrack): void;
     /**
@@ -57,25 +51,21 @@ export declare class SoundManagerInstance implements SpeedAdapterInterface<Sound
     pauseAll(): void;
     /**
      * Function for pausing sound with given name
-     *
-     * @param {SoundTrack} soundName
+     * @param {SoundTrack} soundName - name of the sound
      */
     pause(soundName: SoundTrack): void;
     /**
      * Function for resuming sound with given name
-     *
-     * @param {SoundTrack} soundName
+     * @param {SoundTrack} soundName - name of the sound
      */
     resume(soundName: SoundTrack): void;
     /**
      * Function for adapting sound into the speed of animations
-     *
-     * @param {SpeedLevel} speedLevel
+     * @param {SpeedLevel} speedLevel - speed level
      */
     adaptToSpeed(speedLevel: SpeedLevel): void;
     /**
      * Function for stopping sound with given name
-     *
      * @param {SoundTrack} soundName - name of the sound
      */
     stop(soundName: SoundTrack): void;

package/dist/application/SoundManager/SoundManager.js

@@ -7,7 +7,6 @@ export const pixiSoundContext = sound.context;
  * Class for managing sound in game, uses the pixi sound library
  * The class uses SoundTrack enum to access specified sounds
  *
- * @exports
  */
 export class SoundManagerInstance {
     static instance;
@@ -29,9 +28,7 @@ export class SoundManagerInstance {
     }
     /**
      * Function for loading sounds into pixi
-     *
-     * @async
-     * @param {Record<string, string>} assets
+     * @param {Record<string, string>} assets - sound assets
      */
     async loadSounds(assets) {
         const loadingSoundsPromises = [];
@@ -52,8 +49,7 @@ export class SoundManagerInstance {
     }
     /**
      * Function for setting volume level for each sound in game
-     *
-     * @param {number} volumeLevel
+     * @param {number} volumeLevel - volume level from 0-1
      */
     setVolume(volumeLevel) {
         this.musicCatalogue.forEach((sound) => (sound.volume = volumeLevel));
@@ -70,17 +66,15 @@ export class SoundManagerInstance {
     }
     /**
      * Function for resuming and pausing sound in game
-     *
-     * @param {SoundTrack} soundName
-     * @param {boolean} flag
+     * @param {SoundTrack} soundName - sound name
+     * @param {boolean} flag - flag for playing or pausing sound
      */
     setPlayStatus(soundName, flag) {
         flag ? this.play(soundName) : this.pause(soundName);
     }
     /**
      * Function for playing sound with given name
-     *
-     * @param {SoundTrack} soundName
+     * @param {SoundTrack} soundName - name of the sound
      */
     play(soundName) {
         if (!RainMan.settingsStore.soundFxFlag)
@@ -117,31 +111,27 @@ export class SoundManagerInstance {
     }
     /**
      * Function for pausing sound with given name
-     *
-     * @param {SoundTrack} soundName
+     * @param {SoundTrack} soundName - name of the sound
      */
     pause(soundName) {
         this.musicCatalogue.get(soundName)?.pause();
     }
     /**
      * Function for resuming sound with given name
-     *
-     * @param {SoundTrack} soundName
+     * @param {SoundTrack} soundName - name of the sound
      */
     resume(soundName) {
         this.musicCatalogue.get(soundName)?.resume();
     }
     /**
      * Function for adapting sound into the speed of animations
-     *
-     * @param {SpeedLevel} speedLevel
+     * @param {SpeedLevel} speedLevel - speed level
      */
     adaptToSpeed(speedLevel) {
         this.overrides = this.speedLevelMapper[speedLevel];
     }
     /**
      * Function for stopping sound with given name
-     *
      * @param {SoundTrack} soundName - name of the sound
      */
     stop(soundName) {

package/dist/application/SoundManager/types.d.ts

@@ -26,8 +26,7 @@
  * @property {string} mediumWin - on medium win - this sound is played when win of all streaks is more than x1.1 * bet and less than x5 * bet
  * @property {string} highWin - on high win - this sound is played when win of all streaks is more than x5.1 * bet and less than x15 * bet
  * @property {string} veryHighWin - on very high win - this sound is played when win of all streaks is more than x15.1 * bet
- *
- * @exports SoundTracks
+ * @typedef {SoundTracks}
  */
 export declare const SoundTracks: SoundTracks;
 export interface SoundTracks {
@@ -84,7 +83,6 @@ export type SoundTrack = SoundTracks[keyof SoundTracks];
 export type GameSoundAssets = Record<SoundTrack, string>;
 /**
  * Type for overriding sound tracks in game
- *
- * @exports SoundOverrides
+ * @typedef {SoundOverrides}
  */
 export type SoundOverrides = Partial<Record<SoundTrack, SoundTrack>>;

package/dist/application/SoundManager/types.js

@@ -26,8 +26,7 @@
  * @property {string} mediumWin - on medium win - this sound is played when win of all streaks is more than x1.1 * bet and less than x5 * bet
  * @property {string} highWin - on high win - this sound is played when win of all streaks is more than x5.1 * bet and less than x15 * bet
  * @property {string} veryHighWin - on very high win - this sound is played when win of all streaks is more than x15.1 * bet
- *
- * @exports SoundTracks
+ * @typedef {SoundTracks}
  */
 export const SoundTracks = {
     button: "button",

package/dist/application/SpeedState/SpeedLevelHandler.d.ts

@@ -1,8 +1,6 @@
 import { SpeedLevel } from "./SpeedLevel";
 /**
  * Class for handling speed levels
- *
- * @export SpeedLevelHandler
  */
 export declare class SpeedLevelHandler {
     private chosenSpeedLevel;
@@ -10,21 +8,18 @@ export declare class SpeedLevelHandler {
     static defaultSpeedLevel: SpeedLevel;
     /**
      * Function for initializing SpeedLevelHandler with default speed levels
-     *
      * @returns {SpeedLevelHandler} instance of SpeedLevelHandler with default speed levels
      */
     static initWithDefaultSpeedLevels(): SpeedLevelHandler;
     constructor(chosenSpeedLevel: number, speedLevels: SpeedLevel[]);
     /**
      * Getter for current speed level
-     *
      * @returns {SpeedLevel} current speed level
      */
     get currentSpeed(): SpeedLevel;
     /**
      * Setter for speed level
-     *
-     * @param newSpeedLevel
+     * @param {SpeedLevel} newSpeedLevel - new speed level
      */
     setSpeed(newSpeedLevel: SpeedLevel): void;
     /**
@@ -33,8 +28,7 @@ export declare class SpeedLevelHandler {
     nextSpeed(): void;
     /**
      * Helper function for checking if speed options loop should be reset
-     *
-     * @returns {boolean}
+     * @returns {boolean} - true if speed options loop should be reset
      */
     private shouldResetSpeedOptionsLoop;
 }

package/dist/application/SpeedState/SpeedLevelHandler.js

@@ -1,8 +1,6 @@
 import { DEFAULT_SPEED, SPEED_LEVELS } from "./SpeedLevel";
 /**
  * Class for handling speed levels
- *
- * @export SpeedLevelHandler
  */
 export class SpeedLevelHandler {
     chosenSpeedLevel;
@@ -10,7 +8,6 @@ export class SpeedLevelHandler {
     static defaultSpeedLevel = DEFAULT_SPEED;
     /**
      * Function for initializing SpeedLevelHandler with default speed levels
-     *
      * @returns {SpeedLevelHandler} instance of SpeedLevelHandler with default speed levels
      */
     static initWithDefaultSpeedLevels() {
@@ -24,7 +21,6 @@ export class SpeedLevelHandler {
     }
     /**
      * Getter for current speed level
-     *
      * @returns {SpeedLevel} current speed level
      */
     get currentSpeed() {
@@ -32,8 +28,7 @@ export class SpeedLevelHandler {
     }
     /**
      * Setter for speed level
-     *
-     * @param newSpeedLevel
+     * @param {SpeedLevel} newSpeedLevel - new speed level
      */
     setSpeed(newSpeedLevel) {
         switch (newSpeedLevel) {
@@ -62,8 +57,7 @@ export class SpeedLevelHandler {
     }
     /**
      * Helper function for checking if speed options loop should be reset
-     *
-     * @returns {boolean}
+     * @returns {boolean} - true if speed options loop should be reset
      */
     shouldResetSpeedOptionsLoop() {
         return this.chosenSpeedLevel === this.speedLevels.length - 1;

package/dist/application/SpinLogic/SpinLogic.d.ts

@@ -4,8 +4,6 @@ import { AdaptedSpinResponse } from "./types";
 import { WinScenarios } from "./WinScenarios";
 /**
  * This class represents mapped data from backend
- *
- * @export
  * @class SpinLogic
  * @typedef {SpinLogic}
  */

package/dist/application/SpinLogic/SpinLogic.js

@@ -3,8 +3,6 @@ import { logInfo } from "../../utils";
 import { SpinLogicDTO } from "./SpinLogicDTO";
 /**
  * This class represents mapped data from backend
- *
- * @export
  * @class SpinLogic
  * @typedef {SpinLogic}
  */