pixi-rainman-game-engine 0.2.2 → 0.2.3

package/dist/controllers/AbstractController.d.ts

@@ -11,11 +11,9 @@ import { UiController } from "./UiController";
 /**
  * Abstract controller class for games, this class control game flow
  * and handle all game logic, including wins, transformations
- *
  * @abstract
  * @class AbstractController
  * @template T
- * @exports
  */
 export declare abstract class AbstractController<T> {
     protected buttonsEventManager: ButtonsEventManager;
@@ -70,14 +68,12 @@ export declare abstract class AbstractController<T> {
     private initSpinButton;
     /**
      * This function is responsible for checking if buttons (not bet buttons) should be disabled
-     *
-     * @return {boolean}
+     * @returns {boolean} should buttons be disabled
      */
     get shouldButtonsBeDisabled(): boolean;
     /**
      * This function is responsible for checking if bet buttons should be disabled
-     *
-     * @return {boolean}
+     * @returns {boolean} should bet buttons be disabled
      */
     get shouldBetButtonsBeDisabled(): boolean;
     get lastWinAmount(): number;
@@ -97,15 +93,15 @@ export declare abstract class AbstractController<T> {
      * - dataFetch - when game is fetching data from the server
      * - bigWinInvoked - when big win is invoked
      * - gameSummary - when game is showing game summary
-     *
-     * @param {GamePhase} newPhase
+     * @param {GamePhase} newPhase - new game phase
      */
     protected changeGamePhase(newPhase: GamePhase): void;
     private setRefreshButtonBasedOnPhase;
     private setMessageBoxBasedOnPhase;
     /**
-     *  This function is responsible for getting indexes of reels which should show mystery fx, based on {@link spinLogic}
-     * @param {SpinLogic} spinLogic
+     * This function is responsible for getting indexes of reels which should show mystery fx, based on {@link spinLogic}
+     * @param {SpinLogic} spinLogic - spin logic
+     * @returns {number[]} indexes of reels which should show mystery fx
      */
     protected getReelIndexesToShowMysteryFx(spinLogic: SpinLogic): number[];
     /**
@@ -121,6 +117,7 @@ export declare abstract class AbstractController<T> {
     private getBoughtNumberOfFreeSpins;
     /**
      * Function for autoplay spin
+     * @returns {void} promise
      */
     protected autoplaySpin(): void;
     /**
@@ -135,26 +132,23 @@ export declare abstract class AbstractController<T> {
     /**
      * This function is responsible for actions while fetching data
      * If you want to add some actions while fetching data, you can override this function
-     *
-     * @param {SpinData} _spinData
-     * @param {SpinLogic} _spinLogic
+     * @param {SpinData} _spinData - spin data
+     * @param {SpinLogic} _spinLogic - spin logic
      */
     protected onDataFetch(_spinData: SpinData, _spinLogic: SpinLogic): void;
     /**
      * Getter for extra data for some games
-     *
-     * @returns {ExtraDataRequest}
+     * @returns {ExtraDataRequest} extra data
      */
     protected getExtraData(): ExtraDataRequest;
     /**
      * Function for fetching and preparing spin data
-     *
-     * @returns {SpinDataWithLogic}
+     * @returns {SpinDataWithLogic} - spin data with logic
      */
     protected fetchAndPrepareSpinData(): Promise<SpinDataWithLogic>;
     /**
      * Checks if we can skip action based on conditions. By default it checks {@link !this.isPlayingUnskippableStreak}
-     *
+     * @returns {boolean} can we skip actions
      */
     protected canSkipActions(): boolean;
     protected onSpinningStart(): Promise<void>;
@@ -171,16 +165,14 @@ export declare abstract class AbstractController<T> {
      * - updating free spins amount
      * - showing free spins summary and plate
      * - playing win action queue
-     *
      * @returns {Promise<void>}
      */
     private spin;
     /**
      *  Function for invoking free spin plate, invoked in mainContainer
-     * ```ts
-     * this.mainContainer.invokeFreeSpinPlate(numberOfFreeSpins, isAdditionalFreeSpin);
-     * ```
-     *
+     *  ```ts
+     *  this.mainContainer.invokeFreeSpinPlate(numberOfFreeSpins, isAdditionalFreeSpin);
+     *  ```
      * @param numberOfFreeSpins - number of free spins, if not provided, `RainMan.settingsStore.totalNumberOfFreeSpins` will be used
      * @param isAdditionalFreeSpin  - flag for displaying additional free spins
      */
@@ -199,48 +191,42 @@ export declare abstract class AbstractController<T> {
     protected stopPlayingSymbolsTransformation(): void;
     /**
      * Function for displaying big win. Invoking that by `this.mainContainer.invokeBigWin();` and destroying it by `this.mainContainer.destroyBigWin();`
-     *
-     * @param customAmount - amount of win, if not provided, `RainMan.settingsStore.bet` will be used
+     * @param {number | undefined} customAmount - amount of win, if not provided, `RainMan.settingsStore.bet` will be used
      */
     protected countBigWin(customAmount?: number): Promise<void>;
     /**
      * Function for displaying bonus win. Invoking that by `this.mainContainer.invokeBonusWin();` and destroying it by `this.mainContainer.destroyBonusWin();`
-     *
-     * @param customAmount - amount of win, if not provided, `RainMan.settingsStore.bet` will be used
+     * @param {number | undefined} winAmount - win amount, if not provided, `this.uiController.recentWin` will be used
      */
     protected countBonusWin(winAmount?: number): Promise<void>;
     /**
      *  Function for displaying super bonus win. Invoking that by `this.mainContainer.invokeSuperBonusWin();` and destroying it by `this.mainContainer.destroySuperBonusWin();`
-     *
-     * @param winAmount - amount of win, if not provided `RainMan.settingsStore.cumulativeWinAmount` will be used
+     * @param {number | undefined} winAmount - amount of win, if not provided `RainMan.settingsStore.cumulativeWinAmount` will be used
      */
     protected countSuperBonusWin(winAmount?: number): Promise<void>;
     /**
      *  Function for displaying mystery win. Invoking that by `this.mainContainer.invokeMysteryWin();` and destroying it by `this.mainContainer.destroyMysteryWin();`.
-     * Function requires `this.mysteryWinSymbol` to be fired.
-     *
-     * @param winAmount
-     * @param quantity  - how many symbols create mystery win, by default 3
+     *  Function requires `this.mysteryWinSymbol` to be fired.
+     * @param {number | undefined} winAmount - amount of mystery win
+     * @param {number} quantity  - how many symbols create mystery win, by default 3
      */
     protected countMysteryWin(winAmount?: number, quantity?: number): Promise<void>;
     /**
      * Parser for streaks and reels quantity
-     *
-     * @param {StreakReelsIndexes} streak
-     * @param {number} reelsQuantity
-     * @returns {StreakReelsIndexes}
+     * @param {StreakReelsIndexes} streak - streak with reels indexes
+     * @param {number} reelsQuantity - quantity of reels
+     * @returns {StreakReelsIndexes} - parsed streak
      */
     protected parseStreak(streak: StreakReelsIndexes, reelsQuantity: number): StreakReelsIndexes;
     /**
      * Function for getting symbols ids from {@link StreakReelsIndexes}
-     *
-     * @param streak
+     * @param {StreakReelsIndexes} streak - streak with reels indexes
+     * @returns {SymbolId[]} - symbols from streak
      */
     protected getSymbolIdsForStreak(streak: StreakReelsIndexes): SymbolId[];
     protected updateUiValues(value: number): void;
     /**
      * Function for composing win actions queue based on wins and transformations from {@link transformationTypes} and {@link PossibleWins}
-     *
      * @param spinLogic
      */
     protected abstract composeWinActionsQueue(spinLogic: SpinLogic): void;

package/dist/controllers/AbstractController.js

@@ -10,11 +10,9 @@ import { UiController } from "./UiController";
 /**
  * Abstract controller class for games, this class control game flow
  * and handle all game logic, including wins, transformations
- *
  * @abstract
  * @class AbstractController
  * @template T
- * @exports
  */
 export class AbstractController {
     buttonsEventManager;
@@ -123,7 +121,7 @@ export class AbstractController {
     }
     disableBetButtons(shouldBeDisabled) {
         const freeSpinButton = this.mainContainer.getFreeSpinButton();
-        if (freeSpinButton)
+        if (freeSpinButton && this.roundNumber > 0)
             freeSpinButton?.setInteractivity(!shouldBeDisabled);
         const buttonsToChange = [
             RainMan.componentRegistry.get(BUTTONS.plus),
@@ -217,8 +215,7 @@ export class AbstractController {
     }
     /**
      * This function is responsible for checking if buttons (not bet buttons) should be disabled
-     *
-     * @return {boolean}
+     * @returns {boolean} should buttons be disabled
      */
     get shouldButtonsBeDisabled() {
         if (this.quickStopController.quickStopCounterLock)
@@ -231,8 +228,7 @@ export class AbstractController {
     }
     /**
      * This function is responsible for checking if bet buttons should be disabled
-     *
-     * @return {boolean}
+     * @returns {boolean} should bet buttons be disabled
      */
     get shouldBetButtonsBeDisabled() {
         return this.shouldButtonsBeDisabled || RainMan.settingsStore.isFreeSpinsPlayEnabled;
@@ -264,8 +260,7 @@ export class AbstractController {
      * - dataFetch - when game is fetching data from the server
      * - bigWinInvoked - when big win is invoked
      * - gameSummary - when game is showing game summary
-     *
-     * @param {GamePhase} newPhase
+     * @param {GamePhase} newPhase - new game phase
      */
     changeGamePhase(newPhase) {
         logInfo(`👋🏼👋🏼👋🏼👋🏼 ${this.gamePhase} --> ${newPhase}`);
@@ -312,8 +307,9 @@ export class AbstractController {
         }
     }
     /**
-     *  This function is responsible for getting indexes of reels which should show mystery fx, based on {@link spinLogic}
-     * @param {SpinLogic} spinLogic
+     * This function is responsible for getting indexes of reels which should show mystery fx, based on {@link spinLogic}
+     * @param {SpinLogic} spinLogic - spin logic
+     * @returns {number[]} indexes of reels which should show mystery fx
      */
     getReelIndexesToShowMysteryFx(spinLogic) {
         const { onStopBlindsConfiguration } = spinLogic;
@@ -463,6 +459,7 @@ export class AbstractController {
     }
     /**
      * Function for autoplay spin
+     * @returns {void} promise
      */
     autoplaySpin() {
         if (!RainMan.settingsStore.howManyAutoSpinsLeft)
@@ -497,23 +494,20 @@ export class AbstractController {
     /**
      * This function is responsible for actions while fetching data
      * If you want to add some actions while fetching data, you can override this function
-     *
-     * @param {SpinData} _spinData
-     * @param {SpinLogic} _spinLogic
+     * @param {SpinData} _spinData - spin data
+     * @param {SpinLogic} _spinLogic - spin logic
      */
     onDataFetch(_spinData, _spinLogic) { }
     /**
      * Getter for extra data for some games
-     *
-     * @returns {ExtraDataRequest}
+     * @returns {ExtraDataRequest} extra data
      */
     getExtraData() {
         return {};
     }
     /**
      * Function for fetching and preparing spin data
-     *
-     * @returns {SpinDataWithLogic}
+     * @returns {SpinDataWithLogic} - spin data with logic
      */
     async fetchAndPrepareSpinData() {
         this.changeGamePhase(gamePhases.DATA_FETCH);
@@ -539,7 +533,7 @@ export class AbstractController {
     }
     /**
      * Checks if we can skip action based on conditions. By default it checks {@link !this.isPlayingUnskippableStreak}
-     *
+     * @returns {boolean} can we skip actions
      */
     canSkipActions() {
         return !this.isPlayingUnskippableStreak;
@@ -558,7 +552,6 @@ export class AbstractController {
      * - updating free spins amount
      * - showing free spins summary and plate
      * - playing win action queue
-     *
      * @returns {Promise<void>}
      */
     async spin() {
@@ -691,10 +684,9 @@ export class AbstractController {
     }
     /**
      *  Function for invoking free spin plate, invoked in mainContainer
-     * ```ts
-     * this.mainContainer.invokeFreeSpinPlate(numberOfFreeSpins, isAdditionalFreeSpin);
-     * ```
-     *
+     *  ```ts
+     *  this.mainContainer.invokeFreeSpinPlate(numberOfFreeSpins, isAdditionalFreeSpin);
+     *  ```
      * @param numberOfFreeSpins - number of free spins, if not provided, `RainMan.settingsStore.totalNumberOfFreeSpins` will be used
      * @param isAdditionalFreeSpin  - flag for displaying additional free spins
      */
@@ -771,8 +763,7 @@ export class AbstractController {
     }
     /**
      * Function for displaying big win. Invoking that by `this.mainContainer.invokeBigWin();` and destroying it by `this.mainContainer.destroyBigWin();`
-     *
-     * @param customAmount - amount of win, if not provided, `RainMan.settingsStore.bet` will be used
+     * @param {number | undefined} customAmount - amount of win, if not provided, `RainMan.settingsStore.bet` will be used
      */
     async countBigWin(customAmount) {
         if (RainMan.config.disableBigWinOnBonus)
@@ -799,8 +790,7 @@ export class AbstractController {
     }
     /**
      * Function for displaying bonus win. Invoking that by `this.mainContainer.invokeBonusWin();` and destroying it by `this.mainContainer.destroyBonusWin();`
-     *
-     * @param customAmount - amount of win, if not provided, `RainMan.settingsStore.bet` will be used
+     * @param {number | undefined} winAmount - win amount, if not provided, `this.uiController.recentWin` will be used
      */
     async countBonusWin(winAmount) {
         if (!winAmount)
@@ -824,8 +814,7 @@ export class AbstractController {
     }
     /**
      *  Function for displaying super bonus win. Invoking that by `this.mainContainer.invokeSuperBonusWin();` and destroying it by `this.mainContainer.destroySuperBonusWin();`
-     *
-     * @param winAmount - amount of win, if not provided `RainMan.settingsStore.cumulativeWinAmount` will be used
+     * @param {number | undefined} winAmount - amount of win, if not provided `RainMan.settingsStore.cumulativeWinAmount` will be used
      */
     async countSuperBonusWin(winAmount) {
         if (!winAmount)
@@ -849,10 +838,9 @@ export class AbstractController {
     }
     /**
      *  Function for displaying mystery win. Invoking that by `this.mainContainer.invokeMysteryWin();` and destroying it by `this.mainContainer.destroyMysteryWin();`.
-     * Function requires `this.mysteryWinSymbol` to be fired.
-     *
-     * @param winAmount
-     * @param quantity  - how many symbols create mystery win, by default 3
+     *  Function requires `this.mysteryWinSymbol` to be fired.
+     * @param {number | undefined} winAmount - amount of mystery win
+     * @param {number} quantity  - how many symbols create mystery win, by default 3
      */
     async countMysteryWin(winAmount, quantity = 3) {
         if (!winAmount || !this.mysteryWinSymbol)
@@ -883,10 +871,9 @@ export class AbstractController {
     }
     /**
      * Parser for streaks and reels quantity
-     *
-     * @param {StreakReelsIndexes} streak
-     * @param {number} reelsQuantity
-     * @returns {StreakReelsIndexes}
+     * @param {StreakReelsIndexes} streak - streak with reels indexes
+     * @param {number} reelsQuantity - quantity of reels
+     * @returns {StreakReelsIndexes} - parsed streak
      */
     parseStreak(streak, reelsQuantity) {
         const parsedStreak = [];
@@ -902,8 +889,8 @@ export class AbstractController {
     }
     /**
      * Function for getting symbols ids from {@link StreakReelsIndexes}
-     *
-     * @param streak
+     * @param {StreakReelsIndexes} streak - streak with reels indexes
+     * @returns {SymbolId[]} - symbols from streak
      */
     getSymbolIdsForStreak(streak) {
         const symbolsIds = [];

package/dist/controllers/QuickStopController.d.ts

@@ -4,7 +4,7 @@ import { ButtonsEventManager } from "../application";
  * After 4 quick stops, the speed popup will be shown.
  * Number of quick spin can be adjusted in {@link MAX_QUICK_STOPS}
  *
- * @exports
+ *
  */
 export declare class QuickStopController {
     private buttonsEventManager;

package/dist/controllers/QuickStopController.js

@@ -6,7 +6,7 @@ const MAX_QUICK_STOPS = 4;
  * After 4 quick stops, the speed popup will be shown.
  * Number of quick spin can be adjusted in {@link MAX_QUICK_STOPS}
  *
- * @exports
+ *
  */
 export class QuickStopController {
     buttonsEventManager;

package/dist/controllers/UiController.d.ts

@@ -29,14 +29,12 @@ export declare class UiController {
     resetTotalFreeSpinWinAmount(): void;
     private getNewBet;
     /**
-     *  Functions to be called before bet is updated
-     *
-     * @param _lastBet - last bet
+     * Functions to be called before bet is updated
+     * @param {number} _lastBet - last bet
      */
     protected beforeUpdateBet(_lastBet: number): void;
     /**
      * Function to be called after bet is updated
-     *
      * @param {number} _bet - new bet value
      */
     protected afterUpdateBet(_bet: number): void;

package/dist/controllers/UiController.js

@@ -71,14 +71,12 @@ export class UiController {
         }
     }
     /**
-     *  Functions to be called before bet is updated
-     *
-     * @param _lastBet - last bet
+     * Functions to be called before bet is updated
+     * @param {number} _lastBet - last bet
      */
     beforeUpdateBet(_lastBet) { }
     /**
      * Function to be called after bet is updated
-     *
      * @param {number} _bet - new bet value
      */
     afterUpdateBet(_bet) { }

package/dist/loading/AbstractLoadingContainer.d.ts

@@ -3,12 +3,10 @@ import { Background, Logo, LogoStatic } from "../components";
 import { SpriteLoadingContainer } from "./SpriteLoadingContainer";
 /**
  * Class represents the container with loading logic inside
- *
- * @export
  * @abstract
  * @class AbstractLoadingContainer
  * @typedef {AbstractLoadingContainer}
- * @extends {Container}
+ * @augments {Container}
  */
 export declare abstract class AbstractLoadingContainer extends Container {
     protected abstract background: Background;

package/dist/loading/AbstractLoadingContainer.js

@@ -3,12 +3,10 @@ import { RainMan } from "../Rainman";
 import { SpriteLoadingContainer } from "./SpriteLoadingContainer";
 /**
  * Class represents the container with loading logic inside
- *
- * @export
  * @abstract
  * @class AbstractLoadingContainer
  * @typedef {AbstractLoadingContainer}
- * @extends {Container}
+ * @augments {Container}
  */
 export class AbstractLoadingContainer extends Container {
     logo = null;

package/dist/loading/ProgressiveLoader.d.ts

@@ -1,7 +1,5 @@
 /**
  * Interface for updating progress on loading assets
- *
- * @export
  * @interface ProgressiveLoader
  * @typedef {ProgressiveLoader}
  */

package/dist/loading/SpriteLoadingContainer.d.ts

@@ -2,11 +2,9 @@ import { Container, ITextStyle } from "pixi.js";
 import { ProgressiveLoader } from "./ProgressiveLoader";
 /**
  * This class contains the loading process to pixi application
- *
- * @export
  * @class SpriteLoadingContainer
  * @typedef {SpriteLoadingContainer}
- * @extends {Container}
+ * @augments {Container}
  * @implements {ProgressiveLoader}
  */
 export declare class SpriteLoadingContainer extends Container implements ProgressiveLoader {
@@ -19,7 +17,6 @@ export declare class SpriteLoadingContainer extends Container implements Progres
     private readonly loadingStatusHeight;
     /**
      * Constructor for SpriteLoadingContainer
-     *
      * @param {string} texture path to texture for logo
      * @param {Partial<ITextStyle>} textOptions contains the options for text color blur
      */

package/dist/loading/SpriteLoadingContainer.js

@@ -2,11 +2,9 @@ import { Container, Graphics, Sprite, Text, TextStyle, Texture } from "pixi.js";
 import { RainMan } from "../Rainman";
 /**
  * This class contains the loading process to pixi application
- *
- * @export
  * @class SpriteLoadingContainer
  * @typedef {SpriteLoadingContainer}
- * @extends {Container}
+ * @augments {Container}
  * @implements {ProgressiveLoader}
  */
 export class SpriteLoadingContainer extends Container {
@@ -19,7 +17,6 @@ export class SpriteLoadingContainer extends Container {
     loadingStatusHeight = this.loadingStatusContainerHeight - 10;
     /**
      * Constructor for SpriteLoadingContainer
-     *
      * @param {string} texture path to texture for logo
      * @param {Partial<ITextStyle>} textOptions contains the options for text color blur
      */

package/dist/localStorage/localStorage.d.ts

@@ -1,7 +1,5 @@
 /**
  * Here you can specify the all of the local storage keys
- *
- * @type { readonly hiResolution: "hiResolutionLocalStorage"; readonly batterySaver: "batterySaverLocalStorage"; readonly volumeLevel: "volumeLevelLocalStorage"; readonly isSoundEnabled: "isSoundEnabledLocalStorage"; readonly isSoundFxEnabled: "isSoundFxEnabledLocalStorage"; readonly isAmbientMusicEnabled: "isAmbientMusicEna...}
  */
 export declare const LOCAL_STORAGE: {
     readonly hiResolution: "hiResolutionLocalStorage";

package/dist/localStorage/localStorage.js

@@ -1,7 +1,5 @@
 /**
  * Here you can specify the all of the local storage keys
- *
- * @type { readonly hiResolution: "hiResolutionLocalStorage"; readonly batterySaver: "batterySaverLocalStorage"; readonly volumeLevel: "volumeLevelLocalStorage"; readonly isSoundEnabled: "isSoundEnabledLocalStorage"; readonly isSoundFxEnabled: "isSoundFxEnabledLocalStorage"; readonly isAmbientMusicEnabled: "isAmbientMusicEna...}
  */
 export const LOCAL_STORAGE = {
     hiResolution: "hiResolutionLocalStorage",

package/dist/stores/SettingsStore.d.ts

@@ -4,8 +4,6 @@ import { InitDataInterface, Point, RangeQuantityValue, SpinData } from "../conne
 import { PaytableData } from "./types";
 /**
  * This class represents global state of pixi and react application
- *
- * @export
  * @class SettingsStore
  * @typedef {SettingsStore}
  */
@@ -64,16 +62,14 @@ export declare class SettingsStore {
     refreshBatterySaver(): void;
     /**
      * Sets flag for ambient music.
-     *
-     * @param flag
-     * @param saveToLocalStorage - default {@link true}, if true the flag will be saved to localStorage
+     * @param {boolean} flag - new value for ambient music flag
+     * @param {boolean} saveToLocalStorage - default {@link true}, if true the flag will be saved to localStorage
      */
     setAmbientMusicFlag(flag: boolean, saveToLocalStorage?: boolean): void;
     /**
      * Sets flag for effect sounds
-     *
-     * @param flag
-     * @param saveToLocalStorage - default {@link true}, if true the flag will be saved to localStorage
+     * @param {boolean} flag - new value for sound fx flag
+     * @param {boolean} saveToLocalStorage - default {@link true}, if true the flag will be saved to localStorage
      */
     setSoundFxFlag(flag: boolean, saveToLocalStorage?: boolean): void;
     flipSoundsEnabled(volumeLevel?: number | null): void;
@@ -94,8 +90,7 @@ export declare class SettingsStore {
     repositionSymbolPaytablePopup(x: number, y: number): void;
     /**
      * Initialize paytable map for all symbols. based on backend data {@link InitDataInterface.paytable}
-     *
-     * @param initConfigData
+     * @param {InitDataInterface} initConfigData - initial data from backend
      */
     initPaytableMap(initConfigData: InitDataInterface): void;
     decreaseAutoSpinsCount(): void;

package/dist/stores/SettingsStore.js

@@ -8,8 +8,6 @@ import { changeResolution, logError } from "../utils";
 const INITIAL_AUTO_SPIN_COUNT = 50;
 /**
  * This class represents global state of pixi and react application
- *
- * @export
  * @class SettingsStore
  * @typedef {SettingsStore}
  */
@@ -140,9 +138,8 @@ export class SettingsStore {
     }
     /**
      * Sets flag for ambient music.
-     *
-     * @param flag
-     * @param saveToLocalStorage - default {@link true}, if true the flag will be saved to localStorage
+     * @param {boolean} flag - new value for ambient music flag
+     * @param {boolean} saveToLocalStorage - default {@link true}, if true the flag will be saved to localStorage
      */
     setAmbientMusicFlag(flag, saveToLocalStorage = true) {
         this.ambientMusicFlag = flag;
@@ -155,9 +152,8 @@ export class SettingsStore {
     }
     /**
      * Sets flag for effect sounds
-     *
-     * @param flag
-     * @param saveToLocalStorage - default {@link true}, if true the flag will be saved to localStorage
+     * @param {boolean} flag - new value for sound fx flag
+     * @param {boolean} saveToLocalStorage - default {@link true}, if true the flag will be saved to localStorage
      */
     setSoundFxFlag(flag, saveToLocalStorage = true) {
         this.soundFxFlag = flag;
@@ -274,8 +270,7 @@ export class SettingsStore {
     }
     /**
      * Initialize paytable map for all symbols. based on backend data {@link InitDataInterface.paytable}
-     *
-     * @param initConfigData
+     * @param {InitDataInterface} initConfigData - initial data from backend
      */
     initPaytableMap(initConfigData) {
         for (const [key, name] of initConfigData.symbols_names.entries()) {

package/dist/utils/assets/assetGetter.d.ts

@@ -2,51 +2,43 @@ import { Texture } from "pixi.js";
 import type { LoadersSpineData, Resource } from "./types";
 /**
  * Function for getting spine data for pixi-spines package
- *
- * @param {string} resourceName
+ * @param {string} resourceName - name of the spine from Assets object
  * @throws {SpineDataNotFound}
- * @returns {LoadersSpineData}
+ * @returns {LoadersSpineData} - spine data
  */
 export declare const getSpineData: (resourceName: string) => LoadersSpineData;
 /**
  * Function for getting textures, created in `Assets.ts`
  * This function throw error when texture is not present in cache
- *
- * @param {string} name
+ * @param {string} name - name of the texture
  * @throws {TextureNotFoundError}
- * @returns {Texture}
+ * @returns {Texture} - texture from cache
  */
 export declare const getTexture: (name: string) => Texture<import("pixi.js").Resource>;
 /**
  * Function for getting textures from name
  * If given asset does not exists in cache this function will return undefined
- *
  * @param {string} name - name of the texture
- * @returns {Texture | undefined}
+ * @returns {Texture | undefined} - texture from cache or undefined
  */
 export declare const getTextureSafely: (name: string) => Texture<import("pixi.js").Resource> | undefined;
 /**
  * Function for loading assets with Assets object from pixi
  * To insert progress into separate loading container, please specify callback to update progress
- *
- * @async
- * @param {Resource} assets
- * @param {(progress: number) => void | undefined} [updateProgress]
+ * @param {Resource} assets - game assets that should be loaded into game
+ * @param {(progress: number) => void | undefined} [updateProgress] - callback for updating progress
  * @returns {Promise<void>}
  */
 export declare const loadAssets: (assets: Resource, updateProgress?: ((progress: number) => void) | undefined) => Promise<void>;
 /**
  * Helper function for checking if given resources are present in pixi assets cache
- *
- * @param {Resource} assets
- * @returns {boolean}
+ * @param {Resource} assets - game assets that should be loaded into game
+ * @returns {boolean} - true if all assets are present in cache
  */
 export declare const checkIfAssetsLoaded: (assets: Resource) => boolean;
 /**
  * Function for checking if assets are loaded into the game
- *
- * @async
- * @param {Resource} assets
+ * @param {Resource} assets - game assets that should be loaded into game
  * @returns {Promise<void>}
  */
 export declare const waitForAssetsToLoad: (assets: Resource) => Promise<void>;