pixi-rainman-game-engine 0.2.2 → 0.2.4

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>;

package/dist/utils/assets/assetGetter.js

@@ -3,10 +3,9 @@ import { SpineDataNotFound, TextureNotFoundError } from "../../errors";
 import { logWarn } from "../common";
 /**
  * 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 const getSpineData = (resourceName) => {
     const spine = Assets.get(resourceName);
@@ -17,10 +16,9 @@ export const getSpineData = (resourceName) => {
 /**
  * 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 const getTexture = (name) => {
     if (!Assets.cache.has(name))
@@ -30,9 +28,8 @@ export const getTexture = (name) => {
 /**
  * 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 const getTextureSafely = (name) => {
     if (!Assets.cache.has(name)) {
@@ -44,10 +41,8 @@ export const getTextureSafely = (name) => {
 /**
  * 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 const loadAssets = async (assets, updateProgress) => {
@@ -56,9 +51,8 @@ export const loadAssets = async (assets, updateProgress) => {
 };
 /**
  * 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 const checkIfAssetsLoaded = (assets) => {
     for (const key of Object.keys(assets)) {
@@ -69,9 +63,7 @@ export const checkIfAssetsLoaded = (assets) => {
 };
 /**
  * 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 const waitForAssetsToLoad = async (assets) => {

package/dist/utils/common/deviceOrientation.d.ts

@@ -1,7 +1,6 @@
 import { DeviceOrientation } from "./types";
 /**
  * Function for getting device orientation
- *
- * @returns {DeviceOrientation}
+ * @returns {DeviceOrientation} - device orientation
  */
 export declare const getDeviceOrientation: () => DeviceOrientation;

package/dist/utils/common/deviceOrientation.js

@@ -1,8 +1,7 @@
 import { getScreenRatio, isMobile } from "./screenHelpers";
 /**
  * Function for getting device orientation
- *
- * @returns {DeviceOrientation}
+ * @returns {DeviceOrientation} - device orientation
  */
 export const getDeviceOrientation = () => {
     if (isMobile()) {

package/dist/utils/common/functions.d.ts

@@ -3,8 +3,8 @@ import { Point } from "../../connectivity";
 export declare const ceilToDecimal: (value: number, decimalPlaces?: number) => number;
 /**
  * Wait for a specified amount of time
- *
- * @param ms - time in milliseconds
+ * @param {number} ms - time in milliseconds
+ * @returns {Promise<void>}
  */
 export declare const wait: (ms: number) => Promise<void>;
 export declare const range: (start: number, stop: number, step: number) => number[];
@@ -12,7 +12,7 @@ export declare const getRandomInt: (min: number, max: number) => number;
 export declare const removeMatchingElements: <T>(array: T[], elementsToRemove: T[]) => T[];
 export declare const hideLayerIfPresent: (elementsToSkip?: string[]) => boolean;
 /**
- *  Hides paytable
+ * Hides paytable
  */
 export declare const hidePaytable: () => void;
 /**
@@ -21,10 +21,10 @@ export declare const hidePaytable: () => void;
 export declare const togglePaytable: () => void;
 /**
  * Waits for spine animation to end
- *
- * @param spine
- * @param animationName
- * @param loopAnimationName
+ * @param {Spine} spine - spine object
+ * @param {string} animationName - main animation that need to be played
+ * @param {string | undefined} loopAnimationName - loop animation that will be played after main animation
+ * @returns {Promise<void>}
  */
 export declare const waitForAnimationToEnd: (spine: Spine, animationName: string, loopAnimationName?: string) => Promise<void>;
 export declare const setTimeScale: (spine: Spine, flag: boolean) => void;

package/dist/utils/common/functions.js

@@ -5,8 +5,8 @@ export const ceilToDecimal = (value, decimalPlaces = 2) => {
 };
 /**
  * Wait for a specified amount of time
- *
- * @param ms - time in milliseconds
+ * @param {number} ms - time in milliseconds
+ * @returns {Promise<void>}
  */
 export const wait = (ms) => {
     return new Promise((resolve) => setTimeout(resolve, ms));
@@ -39,7 +39,7 @@ export const hideLayerIfPresent = (elementsToSkip = []) => {
     return anyHidden;
 };
 /**
- *  Hides paytable
+ * Hides paytable
  */
 export const hidePaytable = () => {
     const paytableLayer = window.document.getElementById(UI_ITEMS.symbolPayTable);
@@ -58,10 +58,10 @@ export const togglePaytable = () => {
 };
 /**
  * Waits for spine animation to end
- *
- * @param spine
- * @param animationName
- * @param loopAnimationName
+ * @param {Spine} spine - spine object
+ * @param {string} animationName - main animation that need to be played
+ * @param {string | undefined} loopAnimationName - loop animation that will be played after main animation
+ * @returns {Promise<void>}
  */
 export const waitForAnimationToEnd = async (spine, animationName, loopAnimationName) => {
     spine.state.clearListeners();

package/dist/utils/common/placementHelpers.d.ts

@@ -3,9 +3,8 @@ import { Container, DisplayObject } from "pixi.js";
 import { Nullable } from "./types";
 export declare const scaleToParent: (width: number, height: number, parentWidth: number, parentHeight: number) => Rect;
 /**
- *  Get global min ratio of current device, used for scaling elements.
- *
- * @exports
+ * Get global min ratio of current device, used for scaling elements.
+ * @returns {number} - screen ration for current device
  */
 export declare const globalMinRatio: () => number;
 export declare const setChildIndexWithAscendingOrder: (parentContainer: Container, childrenComponents: Nullable<DisplayObject>[]) => void;

package/dist/utils/common/placementHelpers.js

@@ -11,7 +11,7 @@ export const scaleToParent = (width, height, parentWidth, parentHeight) => {
         policy: POLICY.ShowAll, // null | ExactFit | NoBorder | FullHeight | FullWidth | ShowAll
     });
 };
-const valueForMobile = () => {
+const getMobileScreenRatio = () => {
     const globalXRatio = RainMan.app.screen.width / RainMan.config.gameWidth;
     const globalYRatio = RainMan.app.screen.height / RainMan.config.gameHeight;
     if (globalXRatio < globalYRatio) {
@@ -20,13 +20,12 @@ const valueForMobile = () => {
     return globalYRatio * 2;
 };
 /**
- *  Get global min ratio of current device, used for scaling elements.
- *
- * @exports
+ * Get global min ratio of current device, used for scaling elements.
+ * @returns {number} - screen ration for current device
  */
 export const globalMinRatio = () => {
     if (getScreenRatio() < 1) {
-        return valueForMobile();
+        return getMobileScreenRatio();
     }
     const globalXRatio = RainMan.app.screen.width / RainMan.config.gameWidth;
     const globalYRatio = RainMan.app.screen.height / RainMan.config.gameHeight;

package/dist/winComponents/AnimableParticlesEmitter.d.ts

@@ -2,11 +2,9 @@ import { EmitterConfigV3 } from "@pixi/particle-emitter";
 import { Container } from "pixi.js";
 /**
  * Class for creating Emitter and plays particle animation background while Big, mystery wins
- *
- * @export
  * @class AnimableParticlesEmitter
  * @typedef {AnimableParticlesEmitter}
- * @extends {Container}
+ * @augments {Container}
  */
 export declare class AnimableParticlesEmitter extends Container {
     private emitter;
@@ -14,7 +12,6 @@ export declare class AnimableParticlesEmitter extends Container {
     constructor(particlesConfiguration: EmitterConfigV3);
     /**
      * Function for animating Emitter
-     *
      * @public
      */
     animate(): void;

package/dist/winComponents/AnimableParticlesEmitter.js

@@ -2,11 +2,9 @@ import { Emitter } from "@pixi/particle-emitter";
 import { Container } from "pixi.js";
 /**
  * Class for creating Emitter and plays particle animation background while Big, mystery wins
- *
- * @export
  * @class AnimableParticlesEmitter
  * @typedef {AnimableParticlesEmitter}
- * @extends {Container}
+ * @augments {Container}
  */
 export class AnimableParticlesEmitter extends Container {
     emitter;
@@ -18,7 +16,6 @@ export class AnimableParticlesEmitter extends Container {
     }
     /**
      * Function for animating Emitter
-     *
      * @public
      */
     animate() {

package/dist/winComponents/PositioningFrame.d.ts

@@ -1,11 +1,9 @@
 import { ColorSource, Graphics } from "pixi.js";
 /**
  * Class for creating frame that can adjust position of elements
- *
- * @export
  * @class PositioningFrame
  * @typedef {PositioningFrame}
- * @extends {Graphics}
+ * @augments {Graphics}
  */
 export declare class PositioningFrame extends Graphics {
     private backgroundColor;

package/dist/winComponents/PositioningFrame.js

@@ -1,11 +1,9 @@
 import { Graphics } from "pixi.js";
 /**
  * Class for creating frame that can adjust position of elements
- *
- * @export
  * @class PositioningFrame
  * @typedef {PositioningFrame}
- * @extends {Graphics}
+ * @augments {Graphics}
  */
 export class PositioningFrame extends Graphics {
     backgroundColor;

package/dist/winComponents/UpdatableSpineContainer.d.ts

@@ -5,11 +5,9 @@ import { PositioningFrame } from "./PositioningFrame";
 /**
  * Class for BigWin and Mystery win
  * This class creates all of the texts and positions them
- *
- * @export
  * @class UpdatableSpineContainer
  * @typedef {UpdatableSpineContainer}
- * @extends {Container}
+ * @augments {Container}
  */
 export declare class UpdatableSpineContainer extends Container {
     text: StylefulUpdatableText;

package/dist/winComponents/UpdatableSpineContainer.js

@@ -4,11 +4,9 @@ import { globalMinRatio } from "../utils";
 /**
  * Class for BigWin and Mystery win
  * This class creates all of the texts and positions them
- *
- * @export
  * @class UpdatableSpineContainer
  * @typedef {UpdatableSpineContainer}
- * @extends {Container}
+ * @augments {Container}
  */
 export class UpdatableSpineContainer extends Container {
     text;

package/dist/winComponents/winFactory.d.ts

@@ -3,14 +3,13 @@ import { AnimableParticlesEmitter } from "./AnimableParticlesEmitter";
 import { UpdatableSpineContainer } from "./UpdatableSpineContainer";
 /**
  * Factory function for creating BigWin and Mystery win containers
- *
- * @param {string} textRegistryName
- * @param {string} defaultText
- * @param {string} spineName
- * @param {string} animationName
- * @param {AnimableParticlesEmitter[]} emitters
- * @param {Partial<ITextStyle>} textStyleOverrides
- * @param {number | undefined} spineScale
- * @returns
+ * @param {string} textRegistryName - name of text in game registry
+ * @param {string} defaultText - default text
+ * @param {string} spineName - name of spine animation
+ * @param {string} animationName - name of animation
+ * @param {AnimableParticlesEmitter[]} emitters - array of emitters
+ * @param {Partial<ITextStyle>} textStyleOverrides - overrides for text style
+ * @param {number | undefined} spineScale - scale of spine animation
+ * @returns {UpdatableSpineContainer} - container with scalable spine, text and emitters
  */
 export declare const winFactory: (textRegistryName: string, defaultText: string, spineName: string, animationName: string, emitters?: AnimableParticlesEmitter[], textStyleOverrides?: Partial<ITextStyle>, spineScale?: number) => UpdatableSpineContainer;

package/dist/winComponents/winFactory.js

@@ -4,15 +4,14 @@ import { PositioningFrame } from "./PositioningFrame";
 import { UpdatableSpineContainer } from "./UpdatableSpineContainer";
 /**
  * Factory function for creating BigWin and Mystery win containers
- *
- * @param {string} textRegistryName
- * @param {string} defaultText
- * @param {string} spineName
- * @param {string} animationName
- * @param {AnimableParticlesEmitter[]} emitters
- * @param {Partial<ITextStyle>} textStyleOverrides
- * @param {number | undefined} spineScale
- * @returns
+ * @param {string} textRegistryName - name of text in game registry
+ * @param {string} defaultText - default text
+ * @param {string} spineName - name of spine animation
+ * @param {string} animationName - name of animation
+ * @param {AnimableParticlesEmitter[]} emitters - array of emitters
+ * @param {Partial<ITextStyle>} textStyleOverrides - overrides for text style
+ * @param {number | undefined} spineScale - scale of spine animation
+ * @returns {UpdatableSpineContainer} - container with scalable spine, text and emitters
  */
 export const winFactory = (textRegistryName, defaultText, spineName, animationName, emitters = [], textStyleOverrides = {}, spineScale) => {
     const textStyle = {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "pixi-rainman-game-engine",
-    "version": "0.2.2",
+    "version": "0.2.4",
     "description": "This repository contains all of the mechanics that used in rainman games.",
     "main": "./dist/index.js",
     "module": "./dist/index.js",
@@ -46,11 +46,13 @@
         "@types/react-custom-scroll": "^5.0.3",
         "@types/react-dom": "^18.2.22",
         "@types/stats.js": "^0.17.3",
+        "@types/web": "^0.0.199",
         "@typescript-eslint/eslint-plugin": "^7.0.2",
         "@typescript-eslint/parser": "^7.0.2",
         "copyfiles": "^2.4.1",
         "eslint": "^8.57.0",
         "eslint-config-prettier": "^9.1.0",
+        "eslint-plugin-jsdoc": "^50.6.3",
         "eslint-plugin-simple-import-sort": "^12.0.0",
         "eslint-plugin-sort-class-members": "^1.20.0",
         "eslint-prettier-config": "^1.0.1",