pixi-rainman-game-engine 0.2.1 → 0.2.3

package/dist/ComponentRegistry/ComponentRegistry.d.ts

@@ -3,8 +3,6 @@ import { SpeedLevel } from "../application";
 import { RegistryMap } from "./types";
 /**
  * Class for managing components in game
- *
- * @exports
  * @class ComponentRegistry
  */
 export declare class ComponentRegistry {
@@ -15,53 +13,45 @@ export declare class ComponentRegistry {
     constructor(app: Application);
     /**
      * Method for changing temporarily speed for turbo spin
-     *
      * @public
      * @param {SpeedLevel} newSpeedLevel
      */
     setTemporarySpeedLevel(newSpeedLevel: SpeedLevel): void;
     /**
      * Method for reverting speed level for turbo spin
-     *
      * @public
      */
     revertTemporarySpeedLevel(): void;
     /**
      * Setter fo speed level
-     *
      * @public
      * @param {SpeedLevel} newSpeedLevel
      */
     setSpeedLevel(newSpeedLevel: SpeedLevel): void;
     /**
      * Setting the next available speed level
-     *
      * @public
      */
     nextSpeedLevel(): void;
     /**
      * Getter for current speed level
-     *
      * @public
      * @returns {SpeedLevel}
      */
     getSpeedLevel(): SpeedLevel;
     /**
      * Setter for user activity time
-     *
      * @public
      */
     setUserActivityTime(): void;
     /**
      * Function for adding components into ComponentRegistry
-     *
      * @public
      * @param {Container} component
      */
     add(component: Container): void;
     /**
      * Function for updating component that are in ComponentRegistry
-     *
      * @public
      * @param {Container} oldComponent
      * @param {Container} newComponent
@@ -69,14 +59,12 @@ export declare class ComponentRegistry {
     update(oldComponent: Container, newComponent: Container): void;
     /**
      * Function for removing components from Component Registry
-     *
      * @public
      * @param {Container} component
      */
     remove(component: Container): void;
     /**
      * Function that adapt speed of all components
-     *
      * @public
      * @param {SpeedLevel} speedLevel
      */
@@ -84,7 +72,6 @@ export declare class ComponentRegistry {
     /**
      * Getter for components that are in ComponentRegistry
      * Throws error if component is not present
-     *
      * @public
      * @template {keyof RegistryMap} T
      * @param {T} componentName
@@ -93,7 +80,6 @@ export declare class ComponentRegistry {
     get<T extends keyof RegistryMap>(componentName: T): RegistryMap[T];
     /**
      * Getter for existing components that are in ComponentRegistry
-     *
      * @public
      * @template {keyof RegistryMap} T
      * @param {T} componentName
@@ -102,7 +88,6 @@ export declare class ComponentRegistry {
     getIfExists<T extends keyof RegistryMap>(componentName: T): RegistryMap[T];
     /**
      * Helper function to check if the component is present in ComponentRegistry
-     *
      * @public
      * @template {keyof RegistryMap} T
      * @param {T} componentName
@@ -111,14 +96,12 @@ export declare class ComponentRegistry {
     has<T extends keyof RegistryMap>(componentName: T): boolean;
     /**
      * Function for adding components
-     *
      * @public
      * @param {Container[]} components
      */
     addMany(components: Container[]): void;
     /**
      * Function for removing components
-     *
      * @public
      * @param {Container[]} components
      */

package/dist/ComponentRegistry/ComponentRegistry.js

@@ -4,8 +4,6 @@ import { RainMan } from "../Rainman";
 import { openFullscreen } from "../utils";
 /**
  * Class for managing components in game
- *
- * @exports
  * @class ComponentRegistry
  */
 export class ComponentRegistry {
@@ -22,7 +20,6 @@ export class ComponentRegistry {
     }
     /**
      * Method for changing temporarily speed for turbo spin
-     *
      * @public
      * @param {SpeedLevel} newSpeedLevel
      */
@@ -32,7 +29,6 @@ export class ComponentRegistry {
     }
     /**
      * Method for reverting speed level for turbo spin
-     *
      * @public
      */
     revertTemporarySpeedLevel() {
@@ -41,7 +37,6 @@ export class ComponentRegistry {
     }
     /**
      * Setter fo speed level
-     *
      * @public
      * @param {SpeedLevel} newSpeedLevel
      */
@@ -53,7 +48,6 @@ export class ComponentRegistry {
     }
     /**
      * Setting the next available speed level
-     *
      * @public
      */
     nextSpeedLevel() {
@@ -64,7 +58,6 @@ export class ComponentRegistry {
     }
     /**
      * Getter for current speed level
-     *
      * @public
      * @returns {SpeedLevel}
      */
@@ -73,7 +66,6 @@ export class ComponentRegistry {
     }
     /**
      * Setter for user activity time
-     *
      * @public
      */
     setUserActivityTime() {
@@ -81,7 +73,6 @@ export class ComponentRegistry {
     }
     /**
      * Function for adding components into ComponentRegistry
-     *
      * @public
      * @param {Container} component
      */
@@ -103,7 +94,6 @@ export class ComponentRegistry {
     }
     /**
      * Function for updating component that are in ComponentRegistry
-     *
      * @public
      * @param {Container} oldComponent
      * @param {Container} newComponent
@@ -123,7 +113,6 @@ export class ComponentRegistry {
     }
     /**
      * Function for removing components from Component Registry
-     *
      * @public
      * @param {Container} component
      */
@@ -133,7 +122,6 @@ export class ComponentRegistry {
     }
     /**
      * Function that adapt speed of all components
-     *
      * @public
      * @param {SpeedLevel} speedLevel
      */
@@ -145,7 +133,6 @@ export class ComponentRegistry {
     /**
      * Getter for components that are in ComponentRegistry
      * Throws error if component is not present
-     *
      * @public
      * @template {keyof RegistryMap} T
      * @param {T} componentName
@@ -160,7 +147,6 @@ export class ComponentRegistry {
     }
     /**
      * Getter for existing components that are in ComponentRegistry
-     *
      * @public
      * @template {keyof RegistryMap} T
      * @param {T} componentName
@@ -172,7 +158,6 @@ export class ComponentRegistry {
     }
     /**
      * Helper function to check if the component is present in ComponentRegistry
-     *
      * @public
      * @template {keyof RegistryMap} T
      * @param {T} componentName
@@ -183,7 +168,6 @@ export class ComponentRegistry {
     }
     /**
      * Function for adding components
-     *
      * @public
      * @param {Container[]} components
      */
@@ -194,7 +178,6 @@ export class ComponentRegistry {
     }
     /**
      * Function for removing components
-     *
      * @public
      * @param {Container[]} components
      */

package/dist/ComponentRegistry/types.d.ts

@@ -3,7 +3,7 @@ import { AbstractColumnsContainer, AbstractFrame, AbstractInnerFrame, AutoplayBu
  * RegistryMap is a map of all components that are registered in the ComponentRegistry.
  * It is used to type-check the components that are registered in the ComponentRegistry.
  *
- * @exports
+ *
  */
 export interface RegistryMap {
     [MessageBox.autoSpinTextRegistryName]: UpdatableValueComponent;

package/dist/Money/MoneyText.d.ts

@@ -1,7 +1,5 @@
 /**
  * This class represents money in pixi application
- *
- * @export
  * @class MoneyText
  * @typedef {MoneyText}
  */

package/dist/Money/MoneyText.js

@@ -2,8 +2,6 @@ import { Money } from "ts-money";
 import { RainMan } from "../Rainman";
 /**
  * This class represents money in pixi application
- *
- * @export
  * @class MoneyText
  * @typedef {MoneyText}
  */

package/dist/Rainman/Rainman.d.ts

@@ -10,8 +10,6 @@ import { AppConfig, Globals, OptionalAppConfig, RequiredAppConfig } from "./type
  * - {@link RequiredAppConfig} and {@link OptionalAppConfig}
  * - {@link SymbolIds} present in `gameEngineConfig`
  * - {@link WinTypeIds} present in `gameEngineConfig`
- *
- * @export
  * @class RainMan
  */
 export declare class RainMan {

package/dist/Rainman/Rainman.js

@@ -10,8 +10,6 @@ import { defaultAppConfig } from "./appConfig";
  * - {@link RequiredAppConfig} and {@link OptionalAppConfig}
  * - {@link SymbolIds} present in `gameEngineConfig`
  * - {@link WinTypeIds} present in `gameEngineConfig`
- *
- * @export
  * @class RainMan
  */
 export class RainMan {

package/dist/Rainman/appConfig.d.ts

@@ -2,7 +2,6 @@ import { OptionalAppConfig } from "./types";
 /**
  * This object represents default object for pixi application
  * Here you can specify the default font, color of text etc.
- *
  * @type {OptionalAppConfig}
  */
 export declare const defaultAppConfig: OptionalAppConfig;

package/dist/Rainman/appConfig.js

@@ -2,7 +2,6 @@ import { Color } from "pixi.js";
 /**
  * This object represents default object for pixi application
  * Here you can specify the default font, color of text etc.
- *
  * @type {OptionalAppConfig}
  */
 export const defaultAppConfig = {

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

@@ -5,8 +5,6 @@ import { TransformationTypeId } from "./TransformationTypesId";
 import { WinTypeId } from "./WinTypeId";
 /**
  * Class representing config for connection to API
- *
- * @export
  * @class ApiConfig
  * @typedef {ApiConfig}
  */
@@ -20,126 +18,110 @@ export declare class ApiConfig {
     extraData: InitExtraData;
     /**
      * Create instance of ApiConfig, requires InitDataInterface
-     *
-     * @param {InitDataInterface} data
+     * @param {InitDataInterface} data - initail data from backend
      */
     constructor(data: InitDataInterface);
     /**
      * Function to generate metadata for a particular spin
-     *
      * @public
-     * @param {SpinDataInterface} spinLogicResponse
-     * @returns AdaptedSpinResponse without results and standalone results, these should be created in each game
+     * @param {SpinDataInterface} spinLogicResponse - initial data from backend
+     * @returns {Omit<AdaptedSpinResponse, "results" | "standaloneTransformations">} AdaptedSpinResponse without results and standalone results, these should be created in each game
      */
     generateMetadata(spinLogicResponse: SpinDataInterface): Omit<AdaptedSpinResponse, "results" | "standaloneTransformations">;
     /**
      * Getter for win line number
-     *
      * @public
-     * @param winLineAnimationName
-     * @param defaultNumber
-     * @returns {string | number}
+     * @param {string} winLineAnimationName - name of win line
+     * @param {string} defaultNumber - default number if not found
+     * @returns {string | number} - number of win line
      */
     getWinLineNumber(winLineAnimationName: string, defaultNumber?: string): number | string;
     /**
      * Function for getting next bet from config
-     *
      * @public
      * @param {number} currentBet current bet
-     * @returns {number}
+     * @returns {number} - next bet
      */
     getNextBet(currentBet: number): number;
     /**
      * Function for getting previous bet from config
-     *
      * @public
      * @param {number} currentBet current bet
-     * @returns {number}
+     * @returns {number} - previous bet
      */
     getPreviousBet(currentBet: number): number;
     /**
      * Getting first bet from config
      * This functions is use for mechanic that getting the first available bet
-     *
      * @public
-     * @returns {number}
+     * @returns {number} - first bet
      */
     getFirstBet(): number;
     /**
      * Getting highest bet in config
-     *
      * @public
-     * @param {number} [limit=Number.POSITIVE_INFINITY] limit for the biggest available bet
-     * @returns {number}
+     * @param {number} [limit] limit for the biggest available bet
+     * @returns {number} - highest bet
      */
     getHighestBet(limit?: number): number;
     /**
      * Mapper for symbolIds present in the game
-     *
      * @public
      * @param {number} backendSymbolId id from backend to map
-     * @returns {SymbolId}
+     * @returns {SymbolId} - symbol name
      */
     getSymbolId(backendSymbolId: number): SymbolId;
     /**
      * Function that maps backend win id into more readable one
-     *
      * @public
-     * @param {number} backendWinId
-     * @returns {WinTypeId}
+     * @param {number} backendWinId - win id from backend
+     * @returns {WinTypeId} - win type name
      */
     getWinId(backendWinId: number): WinTypeId;
     /**
      * Function that maps backend win id into more readable one
-     *
      * @public
-     * @param {number} transformationBackendId
-     * @returns {TransformationTypeId}
+     * @param {number} transformationBackendId - transformation id from backend
+     * @returns {TransformationTypeId} - transformation type name
      */
     getTransformationById(transformationBackendId: number): TransformationTypeId;
     /**
      * Mapper for symbol ids into symbol names
-     *
      * @public
-     * @param {number[][]} symbols_on_reels
-     * @returns {SymbolId[][]}
+     * @param {number[][]} symbols_on_reels - symbols on reels
+     * @returns {SymbolId[][]} - symbols on reels
      */
     mapSymbolIdsToSymbolNames(symbols_on_reels: number[][]): SymbolId[][];
     /**
      * Getter for bet that placed in current position
-     *
      * @private
-     * @param {number} primaryPosition
-     * @param {number} fallbackPosition
-     * @returns {number}
+     * @param {number} primaryPosition - primary position
+     * @param {number} fallbackPosition - fallback position
+     * @returns {number} - bet
      */
     private getBetAtPosition;
     /**
      * Method for initializing symbol map in game
-     *
      * @private
-     * @param {InitDataInterface} data
+     * @param {InitDataInterface} data - initial data from backend
      */
     private initSymbolMap;
     /**
      * Method for initializing streak map in game
-     *
      * @private
-     * @param {InitDataInterface} data
+     * @param {InitDataInterface} data - initial data from backend
      */
     private initStreakMap;
     /**
      * Method for initializing win map in game
-     *
      * @private
-     * @param {InitDataInterface} data
+     * @param {InitDataInterface} data - initial data from backend
      */
     private initWinMap;
     /**
      * Method for initializing transformation map in game
-     *
      * @private
-     * @param {InitDataInterface} data
+     * @param {InitDataInterface} data - initial data from backend
      */
     private initTransformationMap;
 }

package/dist/application/ApiConfig/ApiConfig.js

@@ -3,8 +3,6 @@ import { logError } from "../../utils";
 import { isBlindsConfiguredByTransformations } from "../SpinLogic";
 /**
  * Class representing config for connection to API
- *
- * @export
  * @class ApiConfig
  * @typedef {ApiConfig}
  */
@@ -18,8 +16,7 @@ export class ApiConfig {
     extraData;
     /**
      * Create instance of ApiConfig, requires InitDataInterface
-     *
-     * @param {InitDataInterface} data
+     * @param {InitDataInterface} data - initail data from backend
      */
     constructor(data) {
         if (data.action !== "init") {
@@ -35,10 +32,9 @@ export class ApiConfig {
     }
     /**
      * Function to generate metadata for a particular spin
-     *
      * @public
-     * @param {SpinDataInterface} spinLogicResponse
-     * @returns AdaptedSpinResponse without results and standalone results, these should be created in each game
+     * @param {SpinDataInterface} spinLogicResponse - initial data from backend
+     * @returns {Omit<AdaptedSpinResponse, "results" | "standaloneTransformations">} AdaptedSpinResponse without results and standalone results, these should be created in each game
      */
     generateMetadata(spinLogicResponse) {
         const blindsConfiguredByResponse = this.mapSymbolIdsToSymbolNames(spinLogicResponse.symbols_on_reels);
@@ -58,21 +54,19 @@ export class ApiConfig {
     }
     /**
      * Getter for win line number
-     *
      * @public
-     * @param winLineAnimationName
-     * @param defaultNumber
-     * @returns {string | number}
+     * @param {string} winLineAnimationName - name of win line
+     * @param {string} defaultNumber - default number if not found
+     * @returns {string | number} - number of win line
      */
     getWinLineNumber(winLineAnimationName, defaultNumber = "") {
         return this.streakMap.get(winLineAnimationName) ?? defaultNumber;
     }
     /**
      * Function for getting next bet from config
-     *
      * @public
      * @param {number} currentBet current bet
-     * @returns {number}
+     * @returns {number} - next bet
      */
     getNextBet(currentBet) {
         const currentBetPosition = this.bets.indexOf(currentBet);
@@ -80,10 +74,9 @@ export class ApiConfig {
     }
     /**
      * Function for getting previous bet from config
-     *
      * @public
      * @param {number} currentBet current bet
-     * @returns {number}
+     * @returns {number} - previous bet
      */
     getPreviousBet(currentBet) {
         const currentBetPosition = this.bets.indexOf(currentBet);
@@ -92,19 +85,17 @@ export class ApiConfig {
     /**
      * Getting first bet from config
      * This functions is use for mechanic that getting the first available bet
-     *
      * @public
-     * @returns {number}
+     * @returns {number} - first bet
      */
     getFirstBet() {
         return this.getBetAtPosition(0, 0);
     }
     /**
      * Getting highest bet in config
-     *
      * @public
-     * @param {number} [limit=Number.POSITIVE_INFINITY] limit for the biggest available bet
-     * @returns {number}
+     * @param {number} [limit] limit for the biggest available bet
+     * @returns {number} - highest bet
      */
     getHighestBet(limit = Number.POSITIVE_INFINITY) {
         const bet = [...this.bets].reverse().find((bet) => bet <= limit);
@@ -114,10 +105,9 @@ export class ApiConfig {
     }
     /**
      * Mapper for symbolIds present in the game
-     *
      * @public
      * @param {number} backendSymbolId id from backend to map
-     * @returns {SymbolId}
+     * @returns {SymbolId} - symbol name
      */
     getSymbolId(backendSymbolId) {
         if (!this.symbolMap.has(backendSymbolId)) {
@@ -127,10 +117,9 @@ export class ApiConfig {
     }
     /**
      * Function that maps backend win id into more readable one
-     *
      * @public
-     * @param {number} backendWinId
-     * @returns {WinTypeId}
+     * @param {number} backendWinId - win id from backend
+     * @returns {WinTypeId} - win type name
      */
     getWinId(backendWinId) {
         if (!this.winMap.has(backendWinId)) {
@@ -140,10 +129,9 @@ export class ApiConfig {
     }
     /**
      * Function that maps backend win id into more readable one
-     *
      * @public
-     * @param {number} transformationBackendId
-     * @returns {TransformationTypeId}
+     * @param {number} transformationBackendId - transformation id from backend
+     * @returns {TransformationTypeId} - transformation type name
      */
     getTransformationById(transformationBackendId) {
         if (!this.transformationMap.has(transformationBackendId)) {
@@ -153,10 +141,9 @@ export class ApiConfig {
     }
     /**
      * Mapper for symbol ids into symbol names
-     *
      * @public
-     * @param {number[][]} symbols_on_reels
-     * @returns {SymbolId[][]}
+     * @param {number[][]} symbols_on_reels - symbols on reels
+     * @returns {SymbolId[][]} - symbols on reels
      */
     mapSymbolIdsToSymbolNames(symbols_on_reels) {
         return symbols_on_reels.map((reel) => {
@@ -165,11 +152,10 @@ export class ApiConfig {
     }
     /**
      * Getter for bet that placed in current position
-     *
      * @private
-     * @param {number} primaryPosition
-     * @param {number} fallbackPosition
-     * @returns {number}
+     * @param {number} primaryPosition - primary position
+     * @param {number} fallbackPosition - fallback position
+     * @returns {number} - bet
      */
     getBetAtPosition(primaryPosition, fallbackPosition) {
         if (typeof this.bets[primaryPosition] == "undefined") {
@@ -179,9 +165,8 @@ export class ApiConfig {
     }
     /**
      * Method for initializing symbol map in game
-     *
      * @private
-     * @param {InitDataInterface} data
+     * @param {InitDataInterface} data - initial data from backend
      */
     initSymbolMap(data) {
         if (Object.keys(RainMan.symbolIds).length !== data.symbols.length) {
@@ -200,9 +185,8 @@ export class ApiConfig {
     }
     /**
      * Method for initializing streak map in game
-     *
      * @private
-     * @param {InitDataInterface} data
+     * @param {InitDataInterface} data - initial data from backend
      */
     initStreakMap(data) {
         for (const [lineNumber, positions] of data.streaks.entries()) {
@@ -212,9 +196,8 @@ export class ApiConfig {
     }
     /**
      * Method for initializing win map in game
-     *
      * @private
-     * @param {InitDataInterface} data
+     * @param {InitDataInterface} data - initial data from backend
      */
     initWinMap(data) {
         for (const [key, name] of data.wins_names.entries()) {
@@ -227,9 +210,8 @@ export class ApiConfig {
     }
     /**
      * Method for initializing transformation map in game
-     *
      * @private
-     * @param {InitDataInterface} data
+     * @param {InitDataInterface} data - initial data from backend
      */
     initTransformationMap(data) {
         for (const [key, name] of data.transformations_names.entries()) {

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

@@ -1,7 +1,6 @@
 /**
  * Interface for specifying symbols in game
  * This type can be modified for each game in engine.d.ts file
- *
  * @example
  * ```
  * interface SymbolIds {
@@ -9,8 +8,6 @@
  *  lemon: "lemon",
  *   }
  * ```
- *
- * @export
  * @interface SymbolIds
  * @typedef {SymbolIds}
  */
@@ -18,8 +15,6 @@ export interface SymbolIds {
 }
 /**
  * Type for accessing symbols in game
- *
- * @export
  * @typedef {SymbolId}
  */
 export type SymbolId = SymbolIds[keyof SymbolIds];