pixi-rainman-game-engine 0.2.2 → 0.2.3

package/dist/components/frame/AbstractColumnsContainer.js

@@ -7,12 +7,10 @@ import { AbstractFrame } from "./AbstractFrame";
 import { WIN_MULTIPLIER_VALUES } from "./constants";
 /**
  * Class represents columns container in game
- *
- * @export
  * @abstract
  * @class AbstractColumnsContainer
  * @typedef {AbstractColumnsContainer}
- * @extends {Container}
+ * @augments {Container}
  * @implements {SpeedAdapterInterface<number>}
  */
 export class AbstractColumnsContainer extends Container {
@@ -69,9 +67,7 @@ export class AbstractColumnsContainer extends Container {
     }
     /**
      * This function is responsible for setting symbols in columns
-     *
      * @public
-     * @async
      * @param {SymbolReels} finalSymbolReels
      * @param {(value: void | PromiseLike<void>) => void} afterSpinResolver
      * @param {number[]} indexesOfReelsToExtendSpinningTime
@@ -171,13 +167,11 @@ export class AbstractColumnsContainer extends Container {
     }
     /**
      * Function for playing animation of streak
-     *
      * @public
-     * @async
      * @param {StreakReelsIndexes} streak
      * @param {number} reelsQuantity
-     * @param {number} [multiplier=1]
-     * @param {string} [suffix=""]
+     * @param {number} [multiplier]
+     * @param {string} [suffix]
      * @returns {Promise<void>}
      */
     async playStreak(streak, reelsQuantity, multiplier = 1, suffix = "") {

package/dist/components/frame/AbstractFrame.d.ts

@@ -8,13 +8,11 @@ import { MysteryFxCoordinates } from "./types";
 import { WinLineAnimation } from "./WinLineAnimation";
 /**
  * Class aggregating all reels and activities related to them. Each frame has its own proportions, which allow for proper positioning on the screen.
- * This represents all of elements in center frame like {@link ColumnsContainer}, frame animation (on {@link FrameLayer})
- *
- * @export
+ * This represents all of elements in center frame like {@link AbstractColumnsContainer}, frame animation (on {@link FrameLayer})
  * @abstract
  * @class AbstractFrame
  * @typedef {AbstractFrame}
- * @extends {ResumableContainer}
+ * @augments {ResumableContainer}
  * @implements {SpeedAdapterInterface<number>}
  */
 export declare abstract class AbstractFrame extends ResumableContainer implements SpeedAdapterInterface<number> {
@@ -38,9 +36,8 @@ export declare abstract class AbstractFrame extends ResumableContainer implement
     adaptToSpeed(speedLevel: SpeedLevel): void;
     /**
      * Invoke mystery fx on symbol position
-     *
-     * @param x {number}
-     * @param y {number}
+     * @param {number} x - x position of reel
+     * @param {number} y - y position of reel
      */
     invokeMysteryFx(x: number, y: number): void;
     protected repositionMysteryFx(_x: number, _y: number): void;
@@ -49,13 +46,12 @@ export declare abstract class AbstractFrame extends ResumableContainer implement
     destroyMysteryFx(): void;
     /**
      * Create win line animation, individual for each game, based on {@link WinLineAnimation}
-     * */
+     */
     protected createWinLineAnimation(_animationName: string): WinLineAnimation | null;
     playAllWinLineAnimations(animationNames: string[]): Promise<void>;
     /**
      * Creates and plays win line animation.
-     *
-     * @param animationName
+     * @param {string} animationName - name of the winning line to play
      */
     playWinLineAnimation(animationName: string): Promise<void>;
     stopPlayingWinLineAnimations(): void;
@@ -68,7 +64,6 @@ export declare abstract class AbstractFrame extends ResumableContainer implement
      * This method is use when bonus games are triggered
      * It is used to change the frame animation
      * Remember to change resize for this method
-     *
      * @protected
      */
     protected changeForBonusGame(): void;
@@ -76,7 +71,6 @@ export declare abstract class AbstractFrame extends ResumableContainer implement
      * This method is use when normal game is triggered
      * It is used to change the frame animation
      * Remember to change resize for this method
-     *
      * @abstract
      */
     protected changeForNormalGame(): void;

package/dist/components/frame/AbstractFrame.js

@@ -6,13 +6,11 @@ import { getDeviceOrientation, getSpineData, logError, scaleToParent } from "../
 import { ResumableContainer } from "../common";
 /**
  * Class aggregating all reels and activities related to them. Each frame has its own proportions, which allow for proper positioning on the screen.
- * This represents all of elements in center frame like {@link ColumnsContainer}, frame animation (on {@link FrameLayer})
- *
- * @export
+ * This represents all of elements in center frame like {@link AbstractColumnsContainer}, frame animation (on {@link FrameLayer})
  * @abstract
  * @class AbstractFrame
  * @typedef {AbstractFrame}
- * @extends {ResumableContainer}
+ * @augments {ResumableContainer}
  * @implements {SpeedAdapterInterface<number>}
  */
 export class AbstractFrame extends ResumableContainer {
@@ -38,9 +36,8 @@ export class AbstractFrame extends ResumableContainer {
     }
     /**
      * Invoke mystery fx on symbol position
-     *
-     * @param x {number}
-     * @param y {number}
+     * @param {number} x - x position of reel
+     * @param {number} y - y position of reel
      */
     invokeMysteryFx(x, y) {
         if (!this.mysteryFxConfig)
@@ -87,7 +84,7 @@ export class AbstractFrame extends ResumableContainer {
     }
     /**
      * Create win line animation, individual for each game, based on {@link WinLineAnimation}
-     * */
+     */
     createWinLineAnimation(_animationName) {
         return null;
     }
@@ -96,8 +93,7 @@ export class AbstractFrame extends ResumableContainer {
     }
     /**
      * Creates and plays win line animation.
-     *
-     * @param animationName
+     * @param {string} animationName - name of the winning line to play
      */
     async playWinLineAnimation(animationName) {
         const winLineAnimation = this.createWinLineAnimation(animationName);
@@ -151,7 +147,6 @@ export class AbstractFrame extends ResumableContainer {
      * This method is use when bonus games are triggered
      * It is used to change the frame animation
      * Remember to change resize for this method
-     *
      * @protected
      */
     changeForBonusGame() { }
@@ -159,7 +154,6 @@ export class AbstractFrame extends ResumableContainer {
      * This method is use when normal game is triggered
      * It is used to change the frame animation
      * Remember to change resize for this method
-     *
      * @abstract
      */
     changeForNormalGame() { }

package/dist/components/frame/AbstractInnerFrame.d.ts

@@ -2,12 +2,10 @@ import { Container } from "pixi.js";
 import { AbstractColumnsContainer } from "./AbstractColumnsContainer";
 /**
  * Wrapper class for Columns Container {@link ColumnsContainer}
- *
- * @export
  * @abstract
  * @class AbstractInnerFrame
  * @typedef {AbstractInnerFrame}
- * @extends {Container}
+ * @augments {Container}
  */
 export declare abstract class AbstractInnerFrame extends Container {
     static readonly registryName = "innerFrame";

package/dist/components/frame/AbstractInnerFrame.js

@@ -2,12 +2,10 @@ import { Container } from "pixi.js";
 import { FrameLayer } from "../../layers";
 /**
  * Wrapper class for Columns Container {@link ColumnsContainer}
- *
- * @export
  * @abstract
  * @class AbstractInnerFrame
  * @typedef {AbstractInnerFrame}
- * @extends {Container}
+ * @augments {Container}
  */
 export class AbstractInnerFrame extends Container {
     static registryName = "innerFrame";

package/dist/components/frame/WinLineAnimation.d.ts

@@ -2,11 +2,9 @@ import { Spine } from "pixi-spine";
 /**
  * Class representing win line
  * This class plays the animation and load it from assets
- *
- * @export
  * @class WinLineAnimation
  * @typedef {WinLineAnimation}
- * @extends {Spine}
+ * @augments {Spine}
  */
 export declare class WinLineAnimation extends Spine {
     private readonly animationName;

package/dist/components/frame/WinLineAnimation.js

@@ -5,11 +5,9 @@ import { getSpineData } from "../../utils";
 /**
  * Class representing win line
  * This class plays the animation and load it from assets
- *
- * @export
  * @class WinLineAnimation
  * @typedef {WinLineAnimation}
- * @extends {Spine}
+ * @augments {Spine}
  */
 export class WinLineAnimation extends Spine {
     animationName;

package/dist/components/frame/constants.d.ts

@@ -1,3 +1,6 @@
+/**
+ * Object containing the values for the win multipliers.
+ */
 export declare const WIN_MULTIPLIER_VALUES: {
     readonly LOW_WIN: 1;
     readonly MEDIUM_WIN_MIN: 1.1;
@@ -6,4 +9,8 @@ export declare const WIN_MULTIPLIER_VALUES: {
     readonly HIGH_WIN_MAX: 15;
     readonly VERY_HIGH_WIN: 15.1;
 };
+/**
+ * Type for the win multiplier values.
+ * @typedef {WinMultiplierValues}
+ */
 export type WinMultiplierValues = (typeof WIN_MULTIPLIER_VALUES)[keyof typeof WIN_MULTIPLIER_VALUES];

package/dist/components/frame/constants.js

@@ -1,3 +1,6 @@
+/**
+ * Object containing the values for the win multipliers.
+ */
 export const WIN_MULTIPLIER_VALUES = {
     LOW_WIN: 1,
     MEDIUM_WIN_MIN: 1.1,

package/dist/components/frame/types.d.ts

@@ -1,3 +1,7 @@
+/**
+ * Type for coordinates of mystery fx
+ * @typedef MysteryFxCoordinates
+ */
 export type MysteryFxCoordinates = {
     x: number;
     y: number;

package/dist/components/messageBox/MessageBox.d.ts

@@ -8,11 +8,9 @@ import { SymbolId } from "../../application";
  * - free spins left
  * - incentive message
  * - win line indicator
- *
- * @export
  * @class MessageBox
  * @typedef {MessageBox}
- * @extends {Container}
+ * @augments {Container}
  */
 export declare class MessageBox extends Container {
     static readonly registryName = "messageBox";

package/dist/components/messageBox/MessageBox.js

@@ -13,11 +13,9 @@ import { getDeviceOrientation, globalMinRatio } from "../../utils";
  * - free spins left
  * - incentive message
  * - win line indicator
- *
- * @export
  * @class MessageBox
  * @typedef {MessageBox}
- * @extends {Container}
+ * @augments {Container}
  */
 export class MessageBox extends Container {
     static registryName = "messageBox";

package/dist/components/symbols/AbstractSymbolBase.d.ts

@@ -4,11 +4,10 @@ import { SymbolId } from "../../application";
 import { LoadersSpineData, Nullable } from "../../utils";
 /**
  * Class represents symbol which is displayed in columns
- * @export
  * @abstract
  * @class AbstractSymbolBase
  * @typedef {AbstractSymbolBase}
- * @extends {Container}
+ * @augments {Container}
  */
 export declare abstract class AbstractSymbolBase extends Container {
     private multiplierSpineName;

package/dist/components/symbols/AbstractSymbolBase.js

@@ -6,11 +6,10 @@ import { RainMan } from "../../Rainman";
 import { getSpineData, getTexture, togglePaytable } from "../../utils";
 /**
  * Class represents symbol which is displayed in columns
- * @export
  * @abstract
  * @class AbstractSymbolBase
  * @typedef {AbstractSymbolBase}
- * @extends {Container}
+ * @augments {Container}
  */
 export class AbstractSymbolBase extends Container {
     multiplierSpineName;

package/dist/components/symbols/AbstractSymbolsColumn.d.ts

@@ -7,12 +7,10 @@ import { AbstractSymbolBase } from "./AbstractSymbolBase";
 import { AnimationTimeSettings } from "./types";
 /**
  * Class represent single column in {@link ColumnsContainer}. It contains array of {@link AbstractSymbolBase}
- *
- * @export
  * @abstract
  * @class AbstractSymbolsColumn
  * @typedef {AbstractSymbolsColumn}
- * @extends {Container}
+ * @augments {Container}
  * @implements {SpeedAdapterInterface<number>}
  */
 export declare abstract class AbstractSymbolsColumn extends Container implements SpeedAdapterInterface<number> {

package/dist/components/symbols/AbstractSymbolsColumn.js

@@ -9,12 +9,10 @@ import { droppableSymbolsFactory } from "./DroppableSymbolsColumn";
 import { Phase, Speed } from "./types";
 /**
  * Class represent single column in {@link ColumnsContainer}. It contains array of {@link AbstractSymbolBase}
- *
- * @export
  * @abstract
  * @class AbstractSymbolsColumn
  * @typedef {AbstractSymbolsColumn}
- * @extends {Container}
+ * @augments {Container}
  * @implements {SpeedAdapterInterface<number>}
  */
 export class AbstractSymbolsColumn extends Container {

package/dist/components/symbols/DroppableSymbol.d.ts

@@ -2,8 +2,6 @@ import { SymbolId } from "../../application";
 import { AbstractSymbolBase } from "./AbstractSymbolBase";
 /**
  * This class represents symbol that can be dropped from column. Based on transformation type `drop` from {@link transformationTypes}
- *
- * @export
  * @class DroppableSymbol
  * @typedef {DroppableSymbol}
  */

package/dist/components/symbols/DroppableSymbol.js

@@ -1,7 +1,5 @@
 /**
  * This class represents symbol that can be dropped from column. Based on transformation type `drop` from {@link transformationTypes}
- *
- * @export
  * @class DroppableSymbol
  * @typedef {DroppableSymbol}
  */

package/dist/components/symbols/DroppableSymbolsColumn.d.ts

@@ -4,8 +4,6 @@ import { DroppableSymbol } from "./DroppableSymbol";
 export declare const droppableSymbolsFactory: (sortedByYSymbolsInColumns: AbstractSymbolBase[], numberOfRows: number) => DroppableSymbolsColumn;
 /**
  * Class represents symbol column that can replace symbols
- *
- * @export
  * @class DroppableSymbolsColumn
  * @typedef {DroppableSymbolsColumn}
  */

package/dist/components/symbols/DroppableSymbolsColumn.js

@@ -8,8 +8,6 @@ export const droppableSymbolsFactory = (sortedByYSymbolsInColumns, numberOfRows)
 };
 /**
  * Class represents symbol column that can replace symbols
- *
- * @export
  * @class DroppableSymbolsColumn
  * @typedef {DroppableSymbolsColumn}
  */

package/dist/components/symbols/types.d.ts

@@ -12,7 +12,6 @@ export declare enum Speed {
 }
 /**
  * Enum that describes the phase of columns
- *
  * @param {Phase} SPINNING - spinning
  * @param {Phase} RESULT_SET - result was set, should stop when able
  * @param {Phase} BOUNCE - bouncing

package/dist/components/symbols/types.js

@@ -5,7 +5,6 @@ export var Speed;
 })(Speed || (Speed = {}));
 /**
  * Enum that describes the phase of columns
- *
  * @param {Phase} SPINNING - spinning
  * @param {Phase} RESULT_SET - result was set, should stop when able
  * @param {Phase} BOUNCE - bouncing

package/dist/components/updatable/UpdatableTextComponent.d.ts

@@ -3,10 +3,8 @@ import { UpdatableValueComponent } from "./UpdatableValueComponent";
 /**
  * Class for managing updatable text components
  * This component is used for updating text components i.e: balance, win amount, etc.
- *
- * @exports
  * @class UpdatableTextComponent
- * @extends {UpdatableValueComponent}
+ * @augments {UpdatableValueComponent}
  */
 export declare class UpdatableTextComponent extends UpdatableValueComponent {
     constructor(registryName: string, baseText: string, mode: UpdatableMode, fontSize?: number, fontColor?: string, updateCallback?: () => void);

package/dist/components/updatable/UpdatableTextComponent.js

@@ -4,10 +4,8 @@ import { UpdatableValueComponent } from "./UpdatableValueComponent";
 /**
  * Class for managing updatable text components
  * This component is used for updating text components i.e: balance, win amount, etc.
- *
- * @exports
  * @class UpdatableTextComponent
- * @extends {UpdatableValueComponent}
+ * @augments {UpdatableValueComponent}
  */
 export class UpdatableTextComponent extends UpdatableValueComponent {
     constructor(registryName, baseText, mode, fontSize = RainMan.config.fontSize, fontColor, updateCallback) {

package/dist/components/updatable/UpdatableValueComponent.d.ts

@@ -5,11 +5,9 @@ import { UpdatableMode } from "./types";
 /**
  * Abstract class for updatable text components
  * This component is used for updating text components i.e: balance, win amount, etc.
- *
- * @export
  * @abstract
  * @class UpdatableValueComponent
- * @extends {Container}
+ * @augments {Container}
  * @implements {SpeedAdapterInterface<number>}
  * @typedef {UpdatableValueComponent}
  */

package/dist/components/updatable/UpdatableValueComponent.js

@@ -8,11 +8,9 @@ import { UPDATABLE_MODES } from "./types";
 /**
  * Abstract class for updatable text components
  * This component is used for updating text components i.e: balance, win amount, etc.
- *
- * @export
  * @abstract
  * @class UpdatableValueComponent
- * @extends {Container}
+ * @augments {Container}
  * @implements {SpeedAdapterInterface<number>}
  * @typedef {UpdatableValueComponent}
  */

package/dist/components/winLineIndicator/WinLineIndicator.d.ts

@@ -5,10 +5,8 @@ import { SymbolId } from "../../application";
  * This class requires a message and symbol ids to display the winning line
  * Remember to specify function getImageForSymbolId to get the image for the symbol id
  * This default is looking for symbols with "-w" suffix
- *
- * @exports
  * @class WinLineIndicator
- * @extends {Container}
+ * @augments {Container}
  */
 export declare class WinLineIndicator extends Container {
     private symbolIds;

package/dist/components/winLineIndicator/WinLineIndicator.js

@@ -7,10 +7,8 @@ import { getTexture } from "../../utils";
  * This class requires a message and symbol ids to display the winning line
  * Remember to specify function getImageForSymbolId to get the image for the symbol id
  * This default is looking for symbols with "-w" suffix
- *
- * @exports
  * @class WinLineIndicator
- * @extends {Container}
+ * @augments {Container}
  */
 export class WinLineIndicator extends Container {
     symbolIds;

package/dist/connectivity/ConnectionWrapper.d.ts

@@ -2,7 +2,7 @@ import { ExtraDataRequest, GambleCardColor, GambleDataInterface, InitDataInterfa
 /**
  * Class for managing connection to the server via websockets
  *
- * @exports
+ *
  */
 export declare class ConnectionWrapper implements SubscribableConnectionWrapper {
     private webSocketConnection;
@@ -13,7 +13,6 @@ export declare class ConnectionWrapper implements SubscribableConnectionWrapper
     private subscribers;
     /**
      * Mapper function for data that comes from the server
-     *
      * @param {ServerMessage} messageData - data obtained from the server
      */
     private handleMessage;
@@ -32,7 +31,6 @@ export declare class ConnectionWrapper implements SubscribableConnectionWrapper
     private transformFreeSpinData;
     /**
      * Method for fetching spin data from the server
-     *
      * @param {number} roundNumber
      * @param {number} bet
      * @param {ExtraDataRequest} extra_data
@@ -43,7 +41,6 @@ export declare class ConnectionWrapper implements SubscribableConnectionWrapper
     private getFreshWsInstance;
     /**
      * Method for fetching data from the server
-     *
      * @param {ServerRequest} request
      * @returns {ServerMessage}
      */

package/dist/connectivity/ConnectionWrapper.js

@@ -8,7 +8,7 @@ const overrideMap = new Map();
 /**
  * Class for managing connection to the server via websockets
  *
- * @exports
+ *
  */
 export class ConnectionWrapper {
     webSocketConnection;
@@ -19,7 +19,6 @@ export class ConnectionWrapper {
     subscribers = [];
     /**
      * Mapper function for data that comes from the server
-     *
      * @param {ServerMessage} messageData - data obtained from the server
      */
     handleMessage = (messageData) => {
@@ -111,7 +110,6 @@ export class ConnectionWrapper {
     }
     /**
      * Method for fetching spin data from the server
-     *
      * @param {number} roundNumber
      * @param {number} bet
      * @param {ExtraDataRequest} extra_data
@@ -151,7 +149,6 @@ export class ConnectionWrapper {
     }
     /**
      * Method for fetching data from the server
-     *
      * @param {ServerRequest} request
      * @returns {ServerMessage}
      */

package/dist/connectivity/LocalConnectionWrapper.d.ts

@@ -4,7 +4,7 @@ import { SpinData } from "./spinData";
 /**
  * Class for mocking connection to the server
  *
- * @exports
+ *
  */
 export declare class LocalConnectionWrapper implements SubscribableConnectionWrapper {
     private initResponse;

package/dist/connectivity/LocalConnectionWrapper.js

@@ -6,7 +6,7 @@ import { SpinData } from "./spinData";
 /**
  * Class for mocking connection to the server
  *
- * @exports
+ *
  */
 export class LocalConnectionWrapper {
     initResponse;

package/dist/connectivity/apiQueue.d.ts

@@ -2,8 +2,7 @@ import { ServerMessage } from "./serverConnection";
 /**
  * Function to get the next response from the queue
  * This used responses that stores in api directory
- *
- * @param {ServerMessage | ServerMessage[]} localResponse
- * @returns {ServerMessage}
+ * @param {ServerMessage | ServerMessage[]} localResponse - response to return
+ * @returns {ServerMessage} - response from the queue
  */
 export declare const apiQueue: (localResponse: ServerMessage | ServerMessage[]) => any;

package/dist/connectivity/apiQueue.js

@@ -3,9 +3,8 @@ let apiIndex = 0;
 /**
  * Function to get the next response from the queue
  * This used responses that stores in api directory
- *
- * @param {ServerMessage | ServerMessage[]} localResponse
- * @returns {ServerMessage}
+ * @param {ServerMessage | ServerMessage[]} localResponse - response to return
+ * @returns {ServerMessage} - response from the queue
  */
 export const apiQueue = (localResponse) => {
     const response = window.testingData?.apiQueue || localResponse;

package/dist/connectivity/wins.d.ts

@@ -4,8 +4,6 @@ import { Nullable } from "../utils";
 import { TransformationDetails } from "./transformation";
 /**
  * This type contains basic information about win in game
- *
- * @export
  * @typedef {BaseWin}
  */
 export type BaseWin = {
@@ -65,8 +63,6 @@ export type CoinWin = BaseWin & {
 export type Win = StreakWin | FreeSpinWin | GambleWin | MysteryWin | EggWin | GoldWin | BigWin | BonusWin | SuperBonusWin | ScatterWin | RouletteWin | JackpotWin | CoinWin | MultiWin | JokerWin;
 /**
  * Type represents data that come from backend
- *
- * @export
  * @typedef {WinDetails}
  */
 export type WinDetails = {
@@ -87,16 +83,11 @@ export type WinWithTransformation = {
 };
 /**
  * This type represents all of the possible win types in all of Rainman games
- *
- *
- * @export
  * @typedef {WinTypes}
  */
 export type WinTypes = (typeof PossibleWins)[keyof typeof PossibleWins];
 /**
  * This type represents symbols in one row
- *
- * @export
  * @typedef {SymbolReel}
  */
 export type SymbolReel = SymbolId[];