pixi-rainman-game-engine 0.3.0 → 0.3.2

package/dist/ComponentRegistry/ComponentRegistry.d.ts

@@ -3,6 +3,9 @@ import { SpeedLevel } from "../application";
 import { RegistryMap } from "./types";
 /**
  * Class for managing components in game
+ * Especially for managing components that are speed adaptable and updating the text.
+ * This is important for the game logic, as it allows to change the speed of the game
+ * and update the components that are speed adaptable.
  * @class ComponentRegistry
  */
 export declare class ComponentRegistry {
@@ -15,22 +18,26 @@ export declare class ComponentRegistry {
      * Method for changing temporarily speed for turbo spin
      * @public
      * @param {SpeedLevel} newSpeedLevel - new speed level
+     * @returns {void}
      */
     setTemporarySpeedLevel(newSpeedLevel: SpeedLevel): void;
     /**
      * Method for reverting speed level for turbo spin
      * @public
+     * @returns {void}
      */
     revertTemporarySpeedLevel(): void;
     /**
      * Setter fo speed level
      * @public
      * @param {SpeedLevel} newSpeedLevel - new speed level
+     * @returns {void}
      */
     setSpeedLevel(newSpeedLevel: SpeedLevel): void;
     /**
      * Setting the next available speed level
      * @public
+     * @returns {void}
      */
     nextSpeedLevel(): void;
     /**
@@ -42,12 +49,14 @@ export declare class ComponentRegistry {
     /**
      * Setter for user activity time
      * @public
+     * @returns {void}
      */
     setUserActivityTime(): void;
     /**
      * Function for adding components into ComponentRegistry
      * @public
      * @param {Container} component component to be added
+     * @returns {void}
      */
     add(component: Container): void;
     /**
@@ -55,18 +64,21 @@ export declare class ComponentRegistry {
      * @public
      * @param {Container} oldComponent - old component
      * @param {Container} newComponent - new component
+     * @returns {void}
      */
     update(oldComponent: Container, newComponent: Container): void;
     /**
      * Function for removing components from Component Registry
      * @public
      * @param {Container} component - component to be removed
+     * @returns {void}
      */
     remove(component: Container): void;
     /**
      * Function that adapt speed of all components
      * @public
-     * @param {SpeedLevel} speedLevel - speed lever for updating
+     * @param {SpeedLevel} speedLevel new speed level to adapt
+     * @returns {void}
      */
     updateAllSpeedAdaptable(speedLevel: SpeedLevel): void;
     /**
@@ -74,36 +86,38 @@ export declare class ComponentRegistry {
      * Throws error if component is not present
      * @public
      * @template {keyof RegistryMap} T
-     * @param {T} componentName - name of the component
-     * @returns {RegistryMap[T]} - component from registry
+     * @param {T} componentName name of the component
+     * @returns {RegistryMap[T]} component from registry
      */
     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 - component name
-     * @returns {RegistryMap[T]} - component from registry
+     * @param {T} componentName component name
+     * @returns {RegistryMap[T]} component from registry
      */
     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 - component name
-     * @returns {boolean} - true if component is present
+     * @param {T} componentName component name
+     * @returns {boolean} true if component is present otherwise false
      */
     has<T extends keyof RegistryMap>(componentName: T): boolean;
     /**
      * Function for adding components
      * @public
-     * @param {Container[]} components - components to be added
+     * @param {Container[]} components components to be added
+     * @returns {void}
      */
     addMany(components: Container[]): void;
     /**
      * Function for removing components
      * @public
-     * @param {Container[]} components - components to be removed
+     * @param {Container[]} components components to be removed
+     * @returns {void}
      */
     removeMany(components: Container[]): void;
 }

package/dist/ComponentRegistry/ComponentRegistry.js

@@ -4,6 +4,9 @@ import { RainMan } from "../Rainman";
 import { openFullscreen } from "../utils";
 /**
  * Class for managing components in game
+ * Especially for managing components that are speed adaptable and updating the text.
+ * This is important for the game logic, as it allows to change the speed of the game
+ * and update the components that are speed adaptable.
  * @class ComponentRegistry
  */
 export class ComponentRegistry {
@@ -21,6 +24,7 @@ export class ComponentRegistry {
      * Method for changing temporarily speed for turbo spin
      * @public
      * @param {SpeedLevel} newSpeedLevel - new speed level
+     * @returns {void}
      */
     setTemporarySpeedLevel(newSpeedLevel) {
         this.speedLevelHandler.setSpeed(newSpeedLevel);
@@ -29,6 +33,7 @@ export class ComponentRegistry {
     /**
      * Method for reverting speed level for turbo spin
      * @public
+     * @returns {void}
      */
     revertTemporarySpeedLevel() {
         this.speedLevelHandler.setSpeed(RainMan.settingsStore.currentSpeed);
@@ -38,6 +43,7 @@ export class ComponentRegistry {
      * Setter fo speed level
      * @public
      * @param {SpeedLevel} newSpeedLevel - new speed level
+     * @returns {void}
      */
     setSpeedLevel(newSpeedLevel) {
         this.speedLevelHandler.setSpeed(newSpeedLevel);
@@ -48,6 +54,7 @@ export class ComponentRegistry {
     /**
      * Setting the next available speed level
      * @public
+     * @returns {void}
      */
     nextSpeedLevel() {
         this.speedLevelHandler.nextSpeed();
@@ -66,6 +73,7 @@ export class ComponentRegistry {
     /**
      * Setter for user activity time
      * @public
+     * @returns {void}
      */
     setUserActivityTime() {
         this.incentiveJobsManager.updateLastTimeClicked();
@@ -74,6 +82,7 @@ export class ComponentRegistry {
      * Function for adding components into ComponentRegistry
      * @public
      * @param {Container} component component to be added
+     * @returns {void}
      */
     add(component) {
         if (isSpeedAdapterInterface(component)) {
@@ -96,6 +105,7 @@ export class ComponentRegistry {
      * @public
      * @param {Container} oldComponent - old component
      * @param {Container} newComponent - new component
+     * @returns {void}
      */
     update(oldComponent, newComponent) {
         if (oldComponent.name !== newComponent.name) {
@@ -107,13 +117,15 @@ export class ComponentRegistry {
                 this.speedAdaptableComponents.add(newComponent);
             }
         }
-        if (oldComponent.name)
+        if (oldComponent.name) {
             this.registry.set(oldComponent.name, newComponent);
+        }
     }
     /**
      * Function for removing components from Component Registry
      * @public
      * @param {Container} component - component to be removed
+     * @returns {void}
      */
     remove(component) {
         if (component.name)
@@ -122,7 +134,8 @@ export class ComponentRegistry {
     /**
      * Function that adapt speed of all components
      * @public
-     * @param {SpeedLevel} speedLevel - speed lever for updating
+     * @param {SpeedLevel} speedLevel new speed level to adapt
+     * @returns {void}
      */
     updateAllSpeedAdaptable(speedLevel) {
         this.speedAdaptableComponents.forEach((speedAdaptableComponent) => {
@@ -134,8 +147,8 @@ export class ComponentRegistry {
      * Throws error if component is not present
      * @public
      * @template {keyof RegistryMap} T
-     * @param {T} componentName - name of the component
-     * @returns {RegistryMap[T]} - component from registry
+     * @param {T} componentName name of the component
+     * @returns {RegistryMap[T]} component from registry
      */
     get(componentName) {
         const componentToReturn = this.registry.get(componentName);
@@ -148,8 +161,8 @@ export class ComponentRegistry {
      * Getter for existing components that are in ComponentRegistry
      * @public
      * @template {keyof RegistryMap} T
-     * @param {T} componentName - component name
-     * @returns {RegistryMap[T]} - component from registry
+     * @param {T} componentName component name
+     * @returns {RegistryMap[T]} component from registry
      */
     getIfExists(componentName) {
         const componentToReturn = this.registry.get(componentName);
@@ -159,8 +172,8 @@ export class ComponentRegistry {
      * Helper function to check if the component is present in ComponentRegistry
      * @public
      * @template {keyof RegistryMap} T
-     * @param {T} componentName - component name
-     * @returns {boolean} - true if component is present
+     * @param {T} componentName component name
+     * @returns {boolean} true if component is present otherwise false
      */
     has(componentName) {
         return this.registry.has(componentName);
@@ -168,7 +181,8 @@ export class ComponentRegistry {
     /**
      * Function for adding components
      * @public
-     * @param {Container[]} components - components to be added
+     * @param {Container[]} components components to be added
+     * @returns {void}
      */
     addMany(components) {
         for (const component of components) {
@@ -178,7 +192,8 @@ export class ComponentRegistry {
     /**
      * Function for removing components
      * @public
-     * @param {Container[]} components - components to be removed
+     * @param {Container[]} components components to be removed
+     * @returns {void}
      */
     removeMany(components) {
         for (const component of components) {

package/dist/ComponentRegistry/types.d.ts

@@ -1,9 +1,7 @@
-import { AbstractColumnsContainer, AbstractFrame, AbstractInnerFrame, AutoplayButton, Background, BaseButton, BUTTONS, COMPONENTS, FreeSpinButton, InfoButton, MessageBox, MoreButton, NegButton, PlusButton, RefreshButton, SpeedControlButton, StylefulUpdatableText, UpdatableTextComponent, UpdatableValueComponent, VolumeButton } from "../components";
+import { AbstractColumnsContainer, AbstractFrame, AbstractInnerFrame, AutoplayButton, Background, BUTTONS, COMPONENTS, FreeSpinButton, GambleButton, InfoButton, MessageBox, MoreButton, NegButton, PlusButton, RefreshButton, SpeedControlButton, StylefulUpdatableText, TakeButton, UpdatableTextComponent, UpdatableValueComponent, VolumeButton } from "../components";
 /**
  * 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.
- *
- *
  */
 export interface RegistryMap {
     [MessageBox.autoSpinTextRegistryName]: UpdatableValueComponent;
@@ -24,7 +22,8 @@ export interface RegistryMap {
     [NegButton.registryName]: NegButton;
     [InfoButton.registryName]: InfoButton;
     [MoreButton.registryName]: MoreButton;
-    [BUTTONS.gamble]: BaseButton;
+    [BUTTONS.gamble]: GambleButton;
+    [BUTTONS.take]: TakeButton;
     [COMPONENTS.betText]: UpdatableTextComponent;
     [COMPONENTS.creditText]: UpdatableTextComponent;
     [COMPONENTS.bigWin]: StylefulUpdatableText;

package/dist/DescribedPlayableAction/DescribedPlayableAction.d.ts

@@ -1,6 +1,8 @@
 import { Nullable, PlayableAction } from "../utils";
 /**
  * Class representing a described playable action in action queue.
+ * @template T - Type of the action
+ * @class DescribedPlayableAction
  */
 export declare class DescribedPlayableAction<T> {
     readonly type: T;

package/dist/DescribedPlayableAction/DescribedPlayableAction.js

@@ -1,5 +1,7 @@
 /**
  * Class representing a described playable action in action queue.
+ * @template T - Type of the action
+ * @class DescribedPlayableAction
  */
 export class DescribedPlayableAction {
     type;

package/dist/Money/MoneyText.d.ts

@@ -6,5 +6,10 @@
 export declare class MoneyText {
     private readonly money;
     constructor(amount: number);
+    /**
+     * Function for converting money to string with currency symbol included
+     * @public
+     * @returns {string} money as string
+     */
     toString(): string;
 }

package/dist/Money/MoneyText.js

@@ -10,6 +10,11 @@ export class MoneyText {
     constructor(amount) {
         this.money = Money.fromDecimal(amount, RainMan.globals.currency, Math.round);
     }
+    /**
+     * Function for converting money to string with currency symbol included
+     * @public
+     * @returns {string} money as string
+     */
     toString() {
         return `${this.money} ${RainMan.globals.currency.symbol_native}`;
     }

package/dist/Rainman/appConfig.js

@@ -18,6 +18,7 @@ export const defaultAppConfig = {
     disableFreeSpinText: false,
     winLineIndicatorSymbolScale: 0.75,
     disableBigWinOnBonus: false,
+    gambleGameEnabled: false,
     durationOfActions: {
         eachColumnsSpinDelay: [0, 200, 700, 1200, 1800],
         spinBaseTime: 800,

package/dist/Rainman/types.d.ts

@@ -25,6 +25,7 @@ export type OptionalAppConfig = {
     winLineIndicatorSymbolScale: number;
     disableFreeSpinText: boolean;
     disableBigWinOnBonus?: boolean;
+    gambleGameEnabled?: boolean;
     durationOfActions: {
         eachColumnsSpinDelay: number[];
         spinBaseTime: number;

package/dist/SettingsUI/hooks/useBuyFreeSpins/useBuyFreeSpins.d.ts

@@ -1,2 +1,6 @@
 import { BuyFreeSpinOption } from "./types";
+/**
+ * Get the available options for buying free spins
+ * @returns {BuyFreeSpinOption[]} the available options for buying free spins
+ */
 export declare const useBuyFreeSpinOptions: () => BuyFreeSpinOption[];

package/dist/SettingsUI/hooks/useBuyFreeSpins/useBuyFreeSpins.js

@@ -1,6 +1,10 @@
 import { autorun } from "mobx";
 import { useEffect, useState } from "react";
 import { RainMan } from "../../../Rainman";
+/**
+ * Get the available options for buying free spins
+ * @returns {BuyFreeSpinOption[]} the available options for buying free spins
+ */
 export const useBuyFreeSpinOptions = () => {
     const [options, setOptions] = useState([]);
     useEffect(() => {

package/dist/SettingsUI/hooks/useDeviceOrientations.d.ts

@@ -1,2 +1,6 @@
 import { DeviceOrientation } from "../../utils";
+/**
+ * Get the current device orientation
+ * @returns {DeviceOrientation} the current device orientation
+ */
 export declare const useDeviceOrientations: () => DeviceOrientation;

package/dist/SettingsUI/hooks/useDeviceOrientations.js

@@ -1,5 +1,9 @@
 import { useEffect, useState } from "react";
 import { getDeviceOrientation } from "../../utils";
+/**
+ * Get the current device orientation
+ * @returns {DeviceOrientation} the current device orientation
+ */
 export const useDeviceOrientations = () => {
     const [deviceOrientation, setDeviceOrientation] = useState("pc");
     useEffect(() => {

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

@@ -10,14 +10,15 @@ import { WinTypeId } from "./WinTypeId";
  */
 export declare class ApiConfig {
     readonly token: string;
+    extraData: InitExtraData;
     symbolMap: Map<number, never>;
     streakMap: Map<string, number>;
     private readonly bets;
     private winMap;
     private transformationMap;
-    extraData: InitExtraData;
     /**
      * Create instance of ApiConfig, requires InitDataInterface
+     * @public
      * @param {InitDataInterface} data - initail data from backend
      */
     constructor(data: InitDataInterface);

package/dist/application/ApiConfig/ApiConfig.js

@@ -8,14 +8,15 @@ import { isBlindsConfiguredByTransformations } from "../SpinLogic";
  */
 export class ApiConfig {
     token;
+    extraData;
     symbolMap = new Map();
     streakMap = new Map();
     bets;
     winMap = new Map();
     transformationMap = new Map();
-    extraData;
     /**
      * Create instance of ApiConfig, requires InitDataInterface
+     * @public
      * @param {InitDataInterface} data - initail data from backend
      */
     constructor(data) {
@@ -170,7 +171,7 @@ export class ApiConfig {
      */
     initSymbolMap(data) {
         if (Object.keys(RainMan.symbolIds).length !== data.symbols.length) {
-            logError(`🛑 SYMBOL_IDS does not match symbols_names!`);
+            logError("🛑 SYMBOL_IDS does not match symbols_names!");
             logError(RainMan.symbolIds, data.symbols_names);
             throw new Error("Check and fix SYMBOL_IDS");
         }

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

@@ -6,7 +6,7 @@
  * interface SymbolIds {
  *  cherries: "cherries",
  *  lemon: "lemon",
- *   }
+ * }
  * ```
  * @interface SymbolIds
  * @typedef {SymbolIds}

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

@@ -1,9 +1,9 @@
+import { BetStrategy } from "controllers";
 import { Nullable } from "../../utils";
 /** @ignore */
 export declare const SPEED_PREFIX = "speed-";
 /**
  * Class for managing buttons in games
- *
  * This class includes methods for enabling/disabling buttons in game.
  *
  * The buttons that include each game:
@@ -14,6 +14,7 @@ export declare const SPEED_PREFIX = "speed-";
  * - More Button
  * - Autoplay Button
  * - Volume Button
+ * @class ButtonsEventManager
  */
 export declare class ButtonsEventManager {
     private settingsPlusButton;
@@ -24,50 +25,71 @@ export declare class ButtonsEventManager {
     private settingsSpeedCheetah;
     /**
      * Last layer invoked
+     * @private
      * @memberof ButtonsEventManager
      */
     private lastLayerInvoked;
     /**
      * Speed popup shown at for measuring time of showing speed popup
+     * @public
      * @memberof ButtonsEventManager
      */
     speedPopupShownAt: number;
     /**
      * Function for enabling/disabling buttons in game
+     * @private
      * @param {boolean} makeDisabled - flag for enabling/disabling buttons
      * @returns {() => void} function for enabling/disabling buttons
      */
     private setButtonAvailability;
+    /**
+     * Function for enabling buttons in the game
+     * In some game phases, games need to have buttons enabled.
+     * @public
+     * @returns {void}
+     */
     enableButtons: () => void;
+    /**
+     * Function for disabling buttons in the game
+     * In some game phases, games need to have buttons disabled.
+     * @public
+     * @returns {void}
+     */
     disableButtons: () => void;
     constructor();
     /**
      * Method for initializing events in Settings UI
+     * This method also change the incentive text based on the selected speed level
      * @public
+     * @returns {void}
      */
     initSettingsEvents(): void;
     /**
      * Method for setting up animated background
      * @public
+     * @returns {void}
      */
     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 - callback for setting bet
+     * @param {(strategy: BetStrategy) => void} setBetCallback - callback for setting bet
+     * @returns {void}
      */
-    initBetPlusButtonEvent(setBetCallback: (strategy: "first" | "increase" | "decrease") => void): void;
+    initBetPlusButtonEvent(setBetCallback: (strategy: BetStrategy) => 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 - callback for setting bet
+     * @param {(strategy: BetStrategy) => void} setBetCallback - callback for setting bet
+     * @returns {void}
      */
-    initBetMinusButtonEvent(setBetCallback: (strategy: "first" | "increase" | "decrease") => void): void;
+    initBetMinusButtonEvent(setBetCallback: (strategy: BetStrategy) => void): void;
     /**
      * Method for enabling ability to buy free spins in game
      * @public
+     * @returns {void}
      */
     initFreeSpinModal(): void;
     /**
@@ -75,21 +97,25 @@ export declare class ButtonsEventManager {
      * This method changes texture of Volume button based on volume level
      * If music was muted, it will be resumed
      * @public
+     * @returns {void}
      */
     initVolumeButtonEvent(): void;
     /**
      * Method for initializing button with information about mechanics in game
      * @public
+     * @returns {void} - void
      */
     initInfoButtonEvent(): void;
     /**
      * Method for initializing more button
      * @public
+     * @returns {void} - void
      */
     initMoreButtonEvent(): void;
     /**
      * Method for initializing Autoplay button
      * @public
+     * @returns {void} - void
      */
     initAutoplayButtonEvent(): void;
     /**
@@ -97,19 +123,29 @@ export declare class ButtonsEventManager {
      * @public
      * @param {() => void} onClick - callback for gamble game
      * @param {boolean} disabled - flag for enabling/disabling button
+     * @returns {void}
      */
     initGambleButton(onClick: () => void, disabled: boolean): void;
+    /**
+     * Initializing take button
+     * @public
+     * @param {() => void} onClick - callback for take action
+     * @param {boolean} disabled - flag for enabling/disabling button
+     */
+    initTakeButton(onClick: () => void, disabled: boolean): void;
     /**
      * Function for displaying speed modal
      * This modal is used while doing turbo spin
      * @public
      * @param {("flex" | "none")} displayValue - flag for displaying modal
+     * @returns {void}
      */
     setSpeedPopupVisibility(displayValue: "flex" | "none"): void;
     /**
      * Function for handling autostart conformation
      * @public
      * @param {() => void} confirmAutoplayButtonCallback - callback for confirming autoplay
+     * @returns {void}
      */
     setConfirmAutoplayButton(confirmAutoplayButtonCallback: () => void): void;
     /**
@@ -129,6 +165,7 @@ export declare class ButtonsEventManager {
      * Function for displaying modal layer with given name
      * @private
      * @param {string} layerName - name of layer
+     * @returns {void}
      */
     private handleModalInvocation;
     /**