pixi-rainman-game-engine 0.3.0 → 0.3.1

package/dist/application/ButtonsEventManager/ButtonsEventManager.js

@@ -9,7 +9,6 @@ import { SPEED_LEVELS } from "../SpeedState";
 export 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:
@@ -20,6 +19,7 @@ export const SPEED_PREFIX = "speed-";
  * - More Button
  * - Autoplay Button
  * - Volume Button
+ * @class ButtonsEventManager
  */
 export class ButtonsEventManager {
     settingsPlusButton = null;
@@ -30,16 +30,19 @@ export class ButtonsEventManager {
     settingsSpeedCheetah = null;
     /**
      * Last layer invoked
+     * @private
      * @memberof ButtonsEventManager
      */
     lastLayerInvoked = "";
     /**
      * Speed popup shown at for measuring time of showing speed popup
+     * @public
      * @memberof ButtonsEventManager
      */
     speedPopupShownAt = 0;
     /**
      * Function for enabling/disabling buttons in game
+     * @private
      * @param {boolean} makeDisabled - flag for enabling/disabling buttons
      * @returns {() => void} function for enabling/disabling buttons
      */
@@ -53,7 +56,19 @@ export class ButtonsEventManager {
         buttonsToDisable.forEach((buttonRegistryName) => RainMan.componentRegistry.get(buttonRegistryName).flipDisabledFlag(makeDisabled));
         RainMan.componentRegistry.get(VolumeButton.registryName).changeTextureDependOnVolume();
     };
+    /**
+     * Function for enabling buttons in the game
+     * In some game phases, games need to have buttons enabled.
+     * @public
+     * @returns {void}
+     */
     enableButtons = this.setButtonAvailability(false);
+    /**
+     * Function for disabling buttons in the game
+     * In some game phases, games need to have buttons disabled.
+     * @public
+     * @returns {void}
+     */
     disableButtons = this.setButtonAvailability(true);
     constructor() {
         RainMan.settingsStore.handleModalInvocation = this.handleModalInvocation.bind(this);
@@ -62,7 +77,9 @@ export class ButtonsEventManager {
     }
     /**
      * Method for initializing events in Settings UI
+     * This method also change the incentive text based on the selected speed level
      * @public
+     * @returns {void}
      */
     initSettingsEvents() {
         const messageBox = RainMan.componentRegistry.get(MessageBox.registryName);
@@ -131,6 +148,7 @@ export class ButtonsEventManager {
     /**
      * Method for setting up animated background
      * @public
+     * @returns {void}
      */
     setUpUIElementsInteractivity() {
         const animatedBackground = RainMan.componentRegistry.get(Background.registryName);
@@ -147,7 +165,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 - callback for setting bet
+     * @param {(strategy: BetStrategy) => void} setBetCallback - callback for setting bet
+     * @returns {void}
      */
     initBetPlusButtonEvent(setBetCallback) {
         const { isFreeSpinsBought, isFreeSpinsPlayEnabled, betChangeDisabled } = RainMan.settingsStore;
@@ -164,15 +183,17 @@ 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 - callback for setting bet
+     * @param {(strategy: BetStrategy) => void} setBetCallback - callback for setting bet
+     * @returns {void}
      */
     initBetMinusButtonEvent(setBetCallback) {
         if (this.settingsMinusButton === null) {
             const { isFreeSpinsBought, isFreeSpinsPlayEnabled, betChangeDisabled } = RainMan.settingsStore;
             this.settingsMinusButton = window.document.getElementsByName("bet-minus")[0];
             this.settingsMinusButton.addEventListener("click", () => {
-                if (isFreeSpinsBought || isFreeSpinsPlayEnabled || betChangeDisabled)
+                if (isFreeSpinsBought || isFreeSpinsPlayEnabled || betChangeDisabled) {
                     return;
+                }
                 setBetCallback("decrease");
             });
         }
@@ -180,6 +201,7 @@ export class ButtonsEventManager {
     /**
      * Method for enabling ability to buy free spins in game
      * @public
+     * @returns {void}
      */
     initFreeSpinModal() {
         RainMan.componentRegistry
@@ -191,6 +213,7 @@ export 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() {
         RainMan.settingsStore.setUpdateVolumeButtonTexture(() => RainMan.componentRegistry.get(VolumeButton.registryName).changeTextureDependOnVolume());
@@ -209,6 +232,7 @@ export class ButtonsEventManager {
     /**
      * Method for initializing button with information about mechanics in game
      * @public
+     * @returns {void} - void
      */
     initInfoButtonEvent() {
         RainMan.componentRegistry.get(BUTTONS.info).setOnClick(() => {
@@ -221,6 +245,7 @@ export class ButtonsEventManager {
     /**
      * Method for initializing more button
      * @public
+     * @returns {void} - void
      */
     initMoreButtonEvent() {
         RainMan.componentRegistry.get(BUTTONS.more).setOnClick(() => {
@@ -233,6 +258,7 @@ export class ButtonsEventManager {
     /**
      * Method for initializing Autoplay button
      * @public
+     * @returns {void} - void
      */
     initAutoplayButtonEvent() {
         RainMan.componentRegistry.get(AutoplayButton.registryName).setOnClick(() => {
@@ -255,11 +281,12 @@ export class ButtonsEventManager {
      * @public
      * @param {() => void} onClick - callback for gamble game
      * @param {boolean} disabled - flag for enabling/disabling button
+     * @returns {void}
      */
     initGambleButton(onClick, disabled) {
-        if (!RainMan.componentRegistry.has(BUTTONS.gamble) && RainMan.settingsStore.gambleGameUsed)
+        if (!RainMan.componentRegistry.has(BUTTONS.gamble) && RainMan.settingsStore.gambleGameUsed) {
             return;
-        RainMan.componentRegistry.get(BUTTONS.gamble).setOnClick(onClick);
+        }
         RainMan.componentRegistry.get(BUTTONS.gamble).flipDisabledFlag(disabled);
     }
     /**
@@ -267,6 +294,7 @@ export class ButtonsEventManager {
      * This modal is used while doing turbo spin
      * @public
      * @param {("flex" | "none")} displayValue - flag for displaying modal
+     * @returns {void}
      */
     setSpeedPopupVisibility(displayValue) {
         if (displayValue === "flex")
@@ -281,6 +309,7 @@ export class ButtonsEventManager {
      * Function for handling autostart conformation
      * @public
      * @param {() => void} confirmAutoplayButtonCallback - callback for confirming autoplay
+     * @returns {void}
      */
     setConfirmAutoplayButton(confirmAutoplayButtonCallback) {
         const confirmAutoplayButton = window.document.getElementById(COMPONENTS.autoSpinConfirm);
@@ -323,10 +352,12 @@ export class ButtonsEventManager {
      * Function for displaying modal layer with given name
      * @private
      * @param {string} layerName - name of layer
+     * @returns {void}
      */
     handleModalInvocation(layerName) {
-        if (this.checkAnyLayerIsPresent(layerName) && RainMan.globals.shouldShowModals)
+        if (this.checkAnyLayerIsPresent(layerName) && RainMan.globals.shouldShowModals) {
             return;
+        }
         if (this.checkAnyLayerIsPresent(layerName)) {
             this.closeOtherModals(layerName);
         }

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

@@ -5,8 +5,9 @@ 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
+ * This class is a singleton class
+ * @class SoundManagerInstance
  * @implements {SpeedAdapterInterface<SoundOverrides>}
- * @class
  */
 export declare class SoundManagerInstance implements SpeedAdapterInterface<SoundOverrides> {
     private static instance;
@@ -17,62 +18,86 @@ export declare class SoundManagerInstance implements SpeedAdapterInterface<Sound
     constructor();
     /**
      * Function for loading sounds into pixi
+     * @public
      * @param {Record<string, string>} assets - sound assets
+     * @returns {Promise<void>} - promise that resolves when all sounds are loaded
      */
     loadSounds(assets: Record<string, string>): Promise<void>;
     /**
      * Function for setting volume level for each sound in game
+     * @public
      * @param {number} volumeLevel - volume level from 0-1
+     * @returns {void}
      */
     setVolume(volumeLevel: number): void;
     /**
      * Function for stopping sound effect in game
+     * @public
+     * @returns {void}
      */
     stopPlayingFxSounds(): void;
     /**
      * Function for resuming and pausing sound in game
+     * @public
      * @param {SoundTrack} soundName - sound name
      * @param {boolean} flag - flag for playing or pausing sound
+     * @returns {void}
      */
     setPlayStatus(soundName: SoundTrack, flag: boolean): void;
     /**
      * Function for playing sound with given name
+     * @public
      * @param {SoundTrack} soundName - name of the sound
+     * @returns {void}
      */
     play(soundName: SoundTrack): void;
     /**
      * Function for resuming all sounds in game
      * If sound is not playing, it will be skipped
+     * @public
+     * @returns {void}
      */
     resumeAll(): void;
     /**
      * Function for pausing all sounds in game
      * If sound is not playing, it will be skipped
+     * @public
+     * @returns {void}
      */
     pauseAll(): void;
     /**
      * Function for stopping all sounds in game
      * If sound is not playing, it will be skipped
+     * @public
+     * @returns {void}
      */
     stopAll(): void;
     /**
      * Function for pausing sound with given name
+     * @public
      * @param {SoundTrack} soundName - name of the sound
+     * @returns {void}
      */
     pause(soundName: SoundTrack): void;
     /**
      * Function for resuming sound with given name
+     * @public
      * @param {SoundTrack} soundName - name of the sound
+     * @returns {void}
      */
     resume(soundName: SoundTrack): void;
     /**
      * Function for adapting sound into the speed of animations
+     * @public
      * @param {SpeedLevel} speedLevel - speed level
+     * @returns {void}
      */
     adaptToSpeed(speedLevel: SpeedLevel): void;
     /**
      * Function for stopping sound with given name
+     * @public
      * @param {SoundTrack} soundName - name of the sound
+     * @returns {void}
      */
     stop(soundName: SoundTrack): void;
 }

package/dist/application/SoundManager/SoundManager.js

@@ -6,8 +6,9 @@ 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
+ * This class is a singleton class
+ * @class SoundManagerInstance
  * @implements {SpeedAdapterInterface<SoundOverrides>}
- * @class
  */
 export class SoundManagerInstance {
     static instance;
@@ -29,7 +30,9 @@ export class SoundManagerInstance {
     }
     /**
      * Function for loading sounds into pixi
+     * @public
      * @param {Record<string, string>} assets - sound assets
+     * @returns {Promise<void>} - promise that resolves when all sounds are loaded
      */
     async loadSounds(assets) {
         const loadingSoundsPromises = [];
@@ -51,7 +54,9 @@ export class SoundManagerInstance {
     }
     /**
      * Function for setting volume level for each sound in game
+     * @public
      * @param {number} volumeLevel - volume level from 0-1
+     * @returns {void}
      */
     setVolume(volumeLevel) {
         this.musicCatalogue.forEach((sound) => {
@@ -65,6 +70,8 @@ export class SoundManagerInstance {
     }
     /**
      * Function for stopping sound effect in game
+     * @public
+     * @returns {void}
      */
     stopPlayingFxSounds() {
         for (const [soundName, sound] of this.musicCatalogue.entries()) {
@@ -75,15 +82,19 @@ export class SoundManagerInstance {
     }
     /**
      * Function for resuming and pausing sound in game
+     * @public
      * @param {SoundTrack} soundName - sound name
      * @param {boolean} flag - flag for playing or pausing sound
+     * @returns {void}
      */
     setPlayStatus(soundName, flag) {
         flag ? this.play(soundName) : this.pause(soundName);
     }
     /**
      * Function for playing sound with given name
+     * @public
      * @param {SoundTrack} soundName - name of the sound
+     * @returns {void}
      */
     play(soundName) {
         if (!RainMan.settingsStore.shouldPlayFxSounds) {
@@ -102,15 +113,20 @@ export class SoundManagerInstance {
             !RainMan.settingsStore.shouldPlayAmbientMusic) {
             return;
         }
+        const soundLevel = RainMan.settingsStore.volumeLevel / 100;
         sound.play({
             loop: soundsToLoop.includes(soundName),
             singleInstance: true,
-            volume: soundName === SoundTracks.music || soundName === SoundTracks.freeSpinsMusic ? 0.5 : 1
+            volume: soundName === SoundTracks.music || soundName === SoundTracks.freeSpinsMusic
+                ? soundLevel * 0.5
+                : soundLevel
         });
     }
     /**
      * Function for resuming all sounds in game
      * If sound is not playing, it will be skipped
+     * @public
+     * @returns {void}
      */
     resumeAll() {
         this.musicCatalogue.forEach((sound, soundName) => {
@@ -134,6 +150,8 @@ export class SoundManagerInstance {
     /**
      * Function for pausing all sounds in game
      * If sound is not playing, it will be skipped
+     * @public
+     * @returns {void}
      */
     pauseAll() {
         this.musicCatalogue.forEach((sound) => sound.pause());
@@ -141,34 +159,44 @@ export class SoundManagerInstance {
     /**
      * Function for stopping all sounds in game
      * If sound is not playing, it will be skipped
+     * @public
+     * @returns {void}
      */
     stopAll() {
         this.musicCatalogue.forEach((sound) => sound.stop());
     }
     /**
      * Function for pausing sound with given name
+     * @public
      * @param {SoundTrack} soundName - name of the sound
+     * @returns {void}
      */
     pause(soundName) {
         this.musicCatalogue.get(soundName)?.pause();
     }
     /**
      * Function for resuming sound with given name
+     * @public
      * @param {SoundTrack} soundName - name of the sound
+     * @returns {void}
      */
     resume(soundName) {
         this.musicCatalogue.get(soundName)?.resume();
     }
     /**
      * Function for adapting sound into the speed of animations
+     * @public
      * @param {SpeedLevel} speedLevel - speed level
+     * @returns {void}
      */
     adaptToSpeed(speedLevel) {
         this.overrides = this.speedLevelMapper[speedLevel];
     }
     /**
      * Function for stopping sound with given name
+     * @public
      * @param {SoundTrack} soundName - name of the sound
+     * @returns {void}
      */
     stop(soundName) {
         this.musicCatalogue.get(soundName)?.stop();

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

@@ -1,6 +1,15 @@
 import { SpeedLevel, SpeedLevelDirectory } from "./SpeedLevel";
+/**
+ * Interface for SpeedAdapter, which is used to adapt the speed level to the specific implementation.
+ * @template T - Type of overrides that the adapter will use.
+ */
 export interface SpeedAdapterInterface<T> {
     readonly speedLevelMapper: SpeedLevelDirectory<T>;
     adaptToSpeed(speedLevel: SpeedLevel): void;
 }
+/**
+ * Type guard for SpeedAdapterInterface.
+ * @param {unknown} obj object to verify if it's an instance of SpeedAdapterInterface
+ * @returns {obj is SpeedAdapterInterface<unknown>} true if obj is SpeedAdapterInterface, false otherwise
+ */
 export declare const isSpeedAdapterInterface: (obj: unknown) => obj is SpeedAdapterInterface<unknown>;

package/dist/application/SpeedState/SpeedAdapter.js

@@ -1,8 +1,17 @@
 import { z } from "zod";
+/**
+ * Zod schema for validating SpeedAdapterInterface.
+ * This schema checks if the object has a speedLevelMapper of type object and an adaptToSpeed function.
+ */
 const speedAdapterInterfaceSchema = z.object({
     speedLevelMapper: z.object({}),
     adaptToSpeed: z.function()
 });
+/**
+ * Type guard for SpeedAdapterInterface.
+ * @param {unknown} obj object to verify if it's an instance of SpeedAdapterInterface
+ * @returns {obj is SpeedAdapterInterface<unknown>} true if obj is SpeedAdapterInterface, false otherwise
+ */
 export const isSpeedAdapterInterface = (obj) => {
     return speedAdapterInterfaceSchema.safeParse(obj).success;
 };

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

@@ -1,15 +1,57 @@
+/**
+ * Speed levels for the game.
+ * - slow: slow speed level
+ * - normal: normal speed level
+ * - fast: fast speed level
+ */
 export declare const SPEED_LEVELS: {
     readonly slow: "slow";
     readonly normal: "normal";
     readonly fast: "fast";
 };
+/**
+ * All speed levels available in the game.
+ * - slow: slow speed level
+ * - normal: normal speed level
+ * - fast: fast speed level
+ * @typedef {typeof SPEED_LEVELS} SpeedLevels
+ */
 export type SpeedLevel = (typeof SPEED_LEVELS)[keyof typeof SPEED_LEVELS];
+/**
+ * Directory for mapping speed levels to specific overrides.
+ * @template T - Type of overrides that the directory will use.
+ * @typedef {Record<SpeedLevel, T>} SpeedLevelDirectory
+ */
 export type SpeedLevelDirectory<T> = Record<SpeedLevel, T>;
+/**
+ * Default speed level for the game.
+ * This is used when no specific speed level is set.
+ * @constant {SpeedLevel} DEFAULT_SPEED
+ */
 export declare const DEFAULT_SPEED: "slow";
+/**
+ * Default speed configuration for the game.
+ * This is used when no specific speed configuration is set.
+ * @constant {object} defaultSpeedConfig
+ */
 export declare const defaultSpeedConfig: {
     turtleButton: string;
     symbolsColumnsSpeed: number;
     animationDefaultSpeedScale: number;
 };
+/**
+ * Speed levels for spin speed in the game.
+ * - slow: 1
+ * - normal: 0.5
+ * - fast: 0
+ * @constant {SpeedLevelDirectory<number>} spinSpeedLevels
+ */
 export declare const spinSpeedLevels: SpeedLevelDirectory<number>;
+/**
+ * Speed levels for animations in the game.
+ * - slow: 1
+ * - normal: 1.5
+ * - fast: 1.8
+ * @constant {SpeedLevelDirectory<number>} animationsSpeedLevels
+ */
 export declare const animationsSpeedLevels: SpeedLevelDirectory<number>;

package/dist/application/SpeedState/SpeedLevel.js

@@ -1,19 +1,49 @@
+/**
+ * Speed levels for the game.
+ * - slow: slow speed level
+ * - normal: normal speed level
+ * - fast: fast speed level
+ */
 export const SPEED_LEVELS = {
     slow: "slow",
     normal: "normal",
     fast: "fast"
 };
+/**
+ * Default speed level for the game.
+ * This is used when no specific speed level is set.
+ * @constant {SpeedLevel} DEFAULT_SPEED
+ */
 export const DEFAULT_SPEED = SPEED_LEVELS.slow;
+/**
+ * Default speed configuration for the game.
+ * This is used when no specific speed configuration is set.
+ * @constant {object} defaultSpeedConfig
+ */
 export const defaultSpeedConfig = {
     turtleButton: "clicked/speed-turtle.png",
     symbolsColumnsSpeed: 1,
     animationDefaultSpeedScale: 1
 };
+/**
+ * Speed levels for spin speed in the game.
+ * - slow: 1
+ * - normal: 0.5
+ * - fast: 0
+ * @constant {SpeedLevelDirectory<number>} spinSpeedLevels
+ */
 export const spinSpeedLevels = {
     slow: 1,
     normal: 0.5,
     fast: 0
 };
+/**
+ * Speed levels for animations in the game.
+ * - slow: 1
+ * - normal: 1.5
+ * - fast: 1.8
+ * @constant {SpeedLevelDirectory<number>} animationsSpeedLevels
+ */
 export const animationsSpeedLevels = {
     slow: 1,
     normal: 1.5,

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

@@ -1,6 +1,8 @@
 import { SpeedLevel } from "./SpeedLevel";
 /**
  * Class for handling speed levels
+ * This class provides methods for getting and setting the current speed level,
+ * as well as for cycling through the available speed levels.
  */
 export declare class SpeedLevelHandler {
     private chosenSpeedLevel;
@@ -14,11 +16,13 @@ export declare class SpeedLevelHandler {
     constructor(chosenSpeedLevel: number, speedLevels: SpeedLevel[]);
     /**
      * Getter for current speed level
+     * @public
      * @returns {SpeedLevel} current speed level
      */
     get currentSpeed(): SpeedLevel;
     /**
      * Setter for speed level
+     * @public
      * @param {SpeedLevel} newSpeedLevel - new speed level
      * @throws {Error} - if no matched speed level
      */
@@ -27,10 +31,13 @@ export declare class SpeedLevelHandler {
      * Function for setting next speed level
      * This will after switching speed level check if the speed level is normal or fast
      * and if so, it will disable the speed popup
+     * @public
+     * @returns {void}
      */
     nextSpeed(): void;
     /**
      * Helper function for checking if speed options loop should be reset
+     * @private
      * @returns {boolean} - true if speed options loop should be reset
      */
     private shouldResetSpeedOptionsLoop;

package/dist/application/SpeedState/SpeedLevelHandler.js

@@ -2,6 +2,8 @@ import { RainMan } from "../../Rainman";
 import { DEFAULT_SPEED, SPEED_LEVELS } from "./SpeedLevel";
 /**
  * Class for handling speed levels
+ * This class provides methods for getting and setting the current speed level,
+ * as well as for cycling through the available speed levels.
  */
 export class SpeedLevelHandler {
     chosenSpeedLevel;
@@ -22,6 +24,7 @@ export class SpeedLevelHandler {
     }
     /**
      * Getter for current speed level
+     * @public
      * @returns {SpeedLevel} current speed level
      */
     get currentSpeed() {
@@ -29,6 +32,7 @@ export class SpeedLevelHandler {
     }
     /**
      * Setter for speed level
+     * @public
      * @param {SpeedLevel} newSpeedLevel - new speed level
      * @throws {Error} - if no matched speed level
      */
@@ -51,6 +55,8 @@ export class SpeedLevelHandler {
      * Function for setting next speed level
      * This will after switching speed level check if the speed level is normal or fast
      * and if so, it will disable the speed popup
+     * @public
+     * @returns {void}
      */
     nextSpeed() {
         RainMan.globals.disableSpeedPopup?.(true);
@@ -62,6 +68,7 @@ export class SpeedLevelHandler {
     }
     /**
      * Helper function for checking if speed options loop should be reset
+     * @private
      * @returns {boolean} - true if speed options loop should be reset
      */
     shouldResetSpeedOptionsLoop() {