pixi-rainman-game-engine 0.1.6 → 0.1.8

package/dist/ComponentRegistry/ComponentRegistry.d.ts

@@ -7,19 +7,114 @@ export declare class ComponentRegistry {
     private incentiveJobsManager;
     private speedLevelHandler;
     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
+     */
     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
+     */
     updateAllSpeedAdaptable(speedLevel: SpeedLevel): void;
+    /**
+     * Getter for components that are in ComponentRegistry
+     * Throws error if component is not present
+     *
+     * @public
+     * @template {keyof RegistryMap} T
+     * @param {T} componentName
+     * @returns {RegistryMap[T]}
+     */
     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
+     * @returns {RegistryMap[T]}
+     */
     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
+     * @returns {boolean}
+     */
     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
+     */
     removeMany(components: Container[]): void;
 }

package/dist/ComponentRegistry/ComponentRegistry.js

@@ -14,32 +14,71 @@ export class ComponentRegistry {
             openFullscreen();
         });
     }
+    /**
+     * Method for changing temporarily speed for turbo spin
+     *
+     * @public
+     * @param {SpeedLevel} newSpeedLevel
+     */
     setTemporarySpeedLevel(newSpeedLevel) {
         this.speedLevelHandler.setSpeed(newSpeedLevel);
         this.updateAllSpeedAdaptable(this.speedLevelHandler.currentSpeed);
     }
+    /**
+     * Method for reverting speed level for turbo spin
+     *
+     * @public
+     */
     revertTemporarySpeedLevel() {
         this.speedLevelHandler.setSpeed(RainMan.settingsStore.currentSpeed);
         this.updateAllSpeedAdaptable(this.speedLevelHandler.currentSpeed);
     }
+    /**
+     * Setter fo speed level
+     *
+     * @public
+     * @param {SpeedLevel} newSpeedLevel
+     */
     setSpeedLevel(newSpeedLevel) {
         this.speedLevelHandler.setSpeed(newSpeedLevel);
         RainMan.settingsStore.setSpeedLevel(this.speedLevelHandler.currentSpeed);
         this.updateAllSpeedAdaptable(RainMan.settingsStore.currentSpeed);
         this.get(SpeedControlButton.registryName).forceTextureUpdate();
     }
+    /**
+     * Setting the next available speed level
+     *
+     * @public
+     */
     nextSpeedLevel() {
         this.speedLevelHandler.nextSpeed();
         RainMan.settingsStore.setSpeedLevel(this.speedLevelHandler.currentSpeed);
         this.updateAllSpeedAdaptable(RainMan.settingsStore.currentSpeed);
         this.get(SpeedControlButton.registryName).forceTextureUpdate();
     }
+    /**
+     * Getter for current speed level
+     *
+     * @public
+     * @returns {SpeedLevel}
+     */
     getSpeedLevel() {
         return this.speedLevelHandler.currentSpeed;
     }
+    /**
+     * Setter for user activity time
+     *
+     * @public
+     */
     setUserActivityTime() {
         this.incentiveJobsManager.updateLastTimeClicked();
     }
+    /**
+     * Function for adding components into ComponentRegistry
+     *
+     * @public
+     * @param {Container} component
+     */
     add(component) {
         if (isSpeedAdapterInterface(component)) {
             this.speedAdaptableComponents.add(component);
@@ -56,6 +95,13 @@ export class ComponentRegistry {
         }
         throw Error(`Cannot re-add component with the same name: ${component.name}`);
     }
+    /**
+     * Function for updating component that are in ComponentRegistry
+     *
+     * @public
+     * @param {Container} oldComponent
+     * @param {Container} newComponent
+     */
     update(oldComponent, newComponent) {
         if (oldComponent.name !== newComponent.name) {
             throw new Error(`Cannot update component ${oldComponent.name} to ${newComponent.name}`);
@@ -69,15 +115,36 @@ export class ComponentRegistry {
         if (oldComponent.name)
             this.registry.set(oldComponent.name, newComponent);
     }
+    /**
+     * Function for removing components from Component Registry
+     *
+     * @public
+     * @param {Container} component
+     */
     remove(component) {
         if (component.name)
             this.registry.delete(component.name);
     }
+    /**
+     * Function that adapt speed of all components
+     *
+     * @public
+     * @param {SpeedLevel} speedLevel
+     */
     updateAllSpeedAdaptable(speedLevel) {
         this.speedAdaptableComponents.forEach((speedAdaptableComponent) => {
             speedAdaptableComponent.adaptToSpeed(speedLevel);
         });
     }
+    /**
+     * Getter for components that are in ComponentRegistry
+     * Throws error if component is not present
+     *
+     * @public
+     * @template {keyof RegistryMap} T
+     * @param {T} componentName
+     * @returns {RegistryMap[T]}
+     */
     get(componentName) {
         const componentToReturn = this.registry.get(componentName);
         if (componentToReturn == undefined) {
@@ -85,18 +152,46 @@ export class ComponentRegistry {
         }
         return componentToReturn;
     }
+    /**
+     * Getter for existing components that are in ComponentRegistry
+     *
+     * @public
+     * @template {keyof RegistryMap} T
+     * @param {T} componentName
+     * @returns {RegistryMap[T]}
+     */
     getIfExists(componentName) {
         const componentToReturn = this.registry.get(componentName);
         return componentToReturn;
     }
+    /**
+     * Helper function to check if the component is present in ComponentRegistry
+     *
+     * @public
+     * @template {keyof RegistryMap} T
+     * @param {T} componentName
+     * @returns {boolean}
+     */
     has(componentName) {
         return this.registry.has(componentName);
     }
+    /**
+     * Function for adding components
+     *
+     * @public
+     * @param {Container[]} components
+     */
     addMany(components) {
         for (const component of components) {
             this.add(component);
         }
     }
+    /**
+     * Function for removing components
+     *
+     * @public
+     * @param {Container[]} components
+     */
     removeMany(components) {
         for (const component of components) {
             this.remove(component);

package/dist/Money/MoneyText.d.ts

@@ -1,3 +1,10 @@
+/**
+ * This class represents money in pixi application
+ *
+ * @export
+ * @class MoneyText
+ * @typedef {MoneyText}
+ */
 export declare class MoneyText {
     private readonly money;
     constructor(amount: number);

package/dist/Money/MoneyText.js

@@ -1,11 +1,18 @@
 import { Money } from "ts-money";
 import { RainMan } from "../Rainman";
+/**
+ * This class represents money in pixi application
+ *
+ * @export
+ * @class MoneyText
+ * @typedef {MoneyText}
+ */
 export class MoneyText {
     money;
     constructor(amount) {
-        this.money = Money.fromDecimal(amount, RainMan.config.currency, Math.round);
+        this.money = Money.fromDecimal(amount, RainMan.currency, Math.round);
     }
     toString() {
-        return `${this.money} ${RainMan.config.currency.symbol_native}`;
+        return `${this.money} ${RainMan.currency.symbol_native}`;
     }
 }

package/dist/Rainman/Rainman.d.ts

@@ -1,5 +1,6 @@
 import "../components/dictionary/i18n";
 import { Application } from "pixi.js";
+import { Currency } from "ts-money";
 import { SpinLogicFactory, SymbolIds, WinTypeIds } from "../application";
 import { ComponentRegistry } from "../ComponentRegistry";
 import { SettingsStore } from "../stores";
@@ -12,5 +13,6 @@ export declare class RainMan {
     static settingsStore: SettingsStore;
     static componentRegistry: ComponentRegistry;
     static spinLogicFactory: SpinLogicFactory;
+    static currency: Currency;
     constructor(app: Application, config: AppConfig, symbolIds: SymbolIds, winTypeIds: WinTypeIds, spinLogicFactory: SpinLogicFactory);
 }

package/dist/Rainman/Rainman.js

@@ -1,5 +1,6 @@
 import "../components/dictionary/i18n";
 import { merge } from "lodash";
+import { Currencies } from "ts-money";
 import { ComponentRegistry } from "../ComponentRegistry";
 import { settingStore } from "../SettingsUI/hooks";
 import { defaultAppConfig } from "./appConfig";
@@ -11,6 +12,7 @@ export class RainMan {
     static settingsStore;
     static componentRegistry;
     static spinLogicFactory;
+    static currency;
     constructor(app, config, symbolIds, winTypeIds, spinLogicFactory) {
         RainMan.app = app;
         RainMan.config = merge(defaultAppConfig, config);
@@ -19,5 +21,6 @@ export class RainMan {
         RainMan.settingsStore = settingStore;
         RainMan.componentRegistry = new ComponentRegistry(app);
         RainMan.spinLogicFactory = spinLogicFactory;
+        RainMan.currency = Currencies["USD"];
     }
 }

package/dist/Rainman/appConfig.d.ts

@@ -1,2 +1,8 @@
 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

@@ -1,5 +1,10 @@
 import { Color } from "pixi.js";
-import { Currencies } from "ts-money";
+/**
+ * This object represents default object for pixi application
+ * Here you can specify the default font, color of text etc.
+ *
+ * @type {OptionalAppConfig}
+ */
 export const defaultAppConfig = {
     gameWidth: 1920,
     gameHeight: 1080,
@@ -9,8 +14,7 @@ export const defaultAppConfig = {
     updatableSpineContainerFontSize: 50,
     fontColor: new Color(0xfbd400).toHex(),
     updatableTextValueColor: new Color(0xffffff).toHex(),
-    fontFace: "HelveticaNeueLTStd",
-    currency: Currencies["USD"],
+    fontFace: ["HelveticaNeueLTStd"],
     durationOfActions: {
         eachColumnsSpinDelay: [0, 200, 700, 1200, 1800],
         spinBaseTime: 800,

package/dist/Rainman/types.d.ts

@@ -1,4 +1,3 @@
-import { Currency } from "ts-money";
 import { DeepPartial } from "../utils";
 export type RequiredAppConfig = {
     websocketUrl: string;
@@ -12,13 +11,12 @@ export type OptionalAppConfig = {
     gameWidth: number;
     gameHeight: number;
     idleTimeout: number;
-    currency: Currency;
     fontSize: number;
     updatableSpineContainerFontSize: number;
     mobileFontSize: number;
     fontColor: string;
     updatableTextValueColor: string;
-    fontFace: string;
+    fontFace: string[];
     durationOfActions: {
         eachColumnsSpinDelay: number[];
         spinBaseTime: number;

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

@@ -1,25 +1,134 @@
 import { InitDataInterface } from "../../connectivity";
 import { SymbolId } from "./SymbolId";
+import { TransformationTypeId } from "./TransformationTypesId";
+import { WinTypeId } from "./WinTypeId";
+/**
+ * Class representing config for connection to API
+ *
+ * @export
+ * @class ApiConfig
+ * @typedef {ApiConfig}
+ */
 export declare class ApiConfig {
     readonly token: string;
     symbolMap: Map<number, never>;
     streakMap: Map<string, number>;
-    private bets;
+    private readonly bets;
     private winMap;
     private transformationMap;
+    /**
+     * Create instance of ApiConfig, requires InitDataInterfac
+     *
+     * @param {InitDataInterface} data
+     */
     constructor(data: InitDataInterface);
+    /**
+     * Getter for win line number
+     *
+     * @public
+     * @param winLineAnimationName
+     * @returns {string | number}
+     */
     getWinLineNumber(winLineAnimationName: string): number | string;
+    /**
+     * Function for getting next bet from config
+     *
+     * @public
+     * @param {number} currentBet current bet
+     * @returns {number}
+     */
     getNextBet(currentBet: number): number;
+    /**
+     * Function for getting previous bet from config
+     *
+     * @public
+     * @param {number} currentBet current bet
+     * @returns {number}
+     */
     getPreviousBet(currentBet: number): number;
+    /**
+     * Getting first bet from config
+     * This functions is use for mechanic that getting the first available bet
+     *
+     * @public
+     * @returns {number}
+     */
     getFirstBet(): number;
+    /**
+     * Getting highest bet in config
+     *
+     * @public
+     * @param {number} [limit=Number.POSITIVE_INFINITY] limit for the biggest available bet
+     * @returns {number}
+     */
     getHighestBet(limit?: number): number;
-    getSymbolId(number: number): SymbolId;
-    getWinId<T>(number: number): T;
-    getTransformationById<T>(transformationNumber: number): T;
+    /**
+     * Mapper for symbolIds present in the game
+     *
+     * @public
+     * @param {number} backendSymbolId id from backend to map
+     * @returns {SymbolId}
+     */
+    getSymbolId(backendSymbolId: number): SymbolId;
+    /**
+     * Function that maps backend win id into more readable one
+     *
+     * @public
+     * @param {number} backendWinId
+     * @returns {WinTypeId}
+     */
+    getWinId(backendWinId: number): WinTypeId;
+    /**
+     * Function that maps backend win id into more readable one
+     *
+     * @public
+     * @param {number} transformationBackendId
+     * @returns {TransformationTypeId}
+     */
+    getTransformationById(transformationBackendId: number): TransformationTypeId;
+    /**
+     * Mapper for symbol ids into symbol names
+     *
+     * @public
+     * @param {number[][]} symbols_on_reels
+     * @returns {SymbolId[]}
+     */
     mapSymbolIdsToSymbolNames(symbols_on_reels: number[][]): SymbolId[];
+    /**
+     * Getter for bet that placed in current position
+     *
+     * @private
+     * @param {number} primaryPosition
+     * @param {number} fallbackPosition
+     * @returns {number}
+     */
     private getBetAtPosition;
+    /**
+     * Method for initializing symbol map in game
+     *
+     * @private
+     * @param {InitDataInterface} data
+     */
     private initSymbolMap;
+    /**
+     * Method for initializing streak map in game
+     *
+     * @private
+     * @param {InitDataInterface} data
+     */
     private initStreakMap;
+    /**
+     * Method for initializing win map in game
+     *
+     * @private
+     * @param {InitDataInterface} data
+     */
     private initWinMap;
+    /**
+     * Method for initializing transformation map in game
+     *
+     * @private
+     * @param {InitDataInterface} data
+     */
     private initTransformationMap;
 }