Data

UI

/** Indicates whether the game can display a button that redirects to the casino's lobby. */
ETHEREAL.data.canShowHomeButton(device?: string);

/** Indicates whether the game can display a button that redirects to the casino's deposit page. */
ETHEREAL.data.canShowDepositButton(device?: string);

/** Indicates whether the game can display a button that go to fullscreen mode. */
ETHEREAL.data.canShowFullscreenButton(device?: string);

/** Indicates whether the game can display a button to show the player’s history. */
ETHEREAL.data.canShowHistoryButton(device?: string);

/** Indicates whether the game should display a button to mute or unmute the audio. */
ETHEREAL.data.canShowAudioButton();

/** Indicates whether the game should display the menu button. */
ETHEREAL.data.canShowMenuButton();

/** Indicates whether the game can display currency symbols or codes (e.g., 10 USD or 10$). */
ETHEREAL.data.canShowCurrency();

Regulation

/** Indicates whether the game should display the net position (the amount the player has won or lost since the start of the session, including the total bet and win of the session). */
ETHEREAL.data.canShowNetPosition();

/** Indicates whether the game should display the amount of time since the session started. */
ETHEREAL.data.canShowElapsedTime();

/** Indicates whether the game should display the current time. */
ETHEREAL.data.canShowCurrentTime();

/** Indicates whether the game supports using the space key to spin or turbo. */
ETHEREAL.data.canSpaceToSpin();

/** Indicates whether the game supports autoplay. */
ETHEREAL.data.allowAutoplay();

/** Indicates whether the game supports turbo mode to speed up the spins. */
ETHEREAL.data.allowTurbo();

/** Indicates whether the game allows gambling with the winnings of a spin or round. */
ETHEREAL.data.allowGamble();

/** Indicates whether the game allows paying extra to access a specific feature or bonus. */
ETHEREAL.data.allowBuyFeature();

/** Indicates whether the game can show win animations for winnings that are lower than the bet. */
ETHEREAL.data.allowSmallWinCelebration();

/** Specifies the maximum number of autoplay rounds the game can have (no limit by default). */
ETHEREAL.data.maxAutoplaySpin();

/** Specifies the minimum time the game should take to show a result since the start of the play (no limit by default). */
ETHEREAL.data.minSpinSeconds();

RGS Data

Bet and balance

/**
 * Return the latest balance notified by the server.
 * This balance represent always the server value and will only be updated by the server.
 * ❗ **IMPORTANT**: By default, it return the amount as base amount, NOT in currency.
 * @param inCurrency Set to true to return the value in the current currency (false by default)
 */
ETHEREAL.rgs.data.getBalance(inCurrency?: boolean): number;
/** Get the latest bet specified
 * ❗**IMPORTANT**: This value is for informational purposes only and does not necessarily reflect the RGS data, as it can be altered any time by the game client. If you need the bet to restore your game in a multi-step round, the engine should be responsible for providing that data on the init response.
 * @param inCurrency Set to true to return the value in the current currency (false by default)
 */
ETHEREAL.rgs.data.getBet(inCurrency?: boolean): number;

Max win cap

:::doc More information Check the connector functionality regarding the max win cap to know more about this. :::

/** Return the if the current round win has been capped because it reached the max win limit specified by the casino. */
ETHEREAL.rgs.data.isWinCapped(): boolean;

Round bet and win

/**
 * Accumulated win of the whole round. (It will reset on the first play of a new round)
 * ❗ **IMPORTANT**: By default, it return the amount as base amount, NOT in currency.
 * @param inCurrency Set to true to return the value in the current currency (false by default)
 */
ETHEREAL.rgs.data.getRoundWin(inCurrency?: boolean): number;
/**
 * Accumulated bet of the whole round. (It will reset on the first play of a new round)
 * ❗ **IMPORTANT**: By default, it return the amount as base amount, NOT in currency.
 * @param inCurrency Set to true to return the value in the current currency (false by default)
 */
ETHEREAL.rgs.data.getRoundBet(inCurrency?: boolean): number;
/** Return if the current round is finished. If true, next play will start a new round. */
ETHEREAL.rgs.data.isRoundEnd(): boolean;

Net values

/**
 * Return the total amount the player has earn since the start of the session (win - bet)
 * ❗ **IMPORTANT**: By default, it return the amount as base amount, NOT in currency.
 * @param inCurrency Set to true to return the value in the current currency (false by default)
 */
ETHEREAL.rgs.data.getNet(inCurrency?: boolean): number;
/**
 * Return the total amount the player has win since the start of the session
 * ❗ **IMPORTANT**: By default, it return the amount as base amount, NOT in currency.
 * @param inCurrency Set to true to return the value in the current currency (false by default)
 */
ETHEREAL.rgs.data.getNetWin(inCurrency?: boolean): number;
/**
 * Return the total amount the player has bet since the start of the session
 * ❗ **IMPORTANT**: By default, it return the amount as base amount, NOT in currency.
 * @param inCurrency Set to true to return the value in the current currency (false by default)
 */
ETHEREAL.rgs.data.getNetBet(inCurrency?: boolean): number;

Currency

:::doc Extra Functionality You can use the functionality given by the connector to convert amounts to their currency value here and the functionality to format numbers or currencies explained here, so you don't need to use any of this. :::

/** Get the number that any monetary amount must be multiplied with to obtain the value on the current currency */
ETHEREAL.rgs.data.getCurrencyMultiplier(): number;
/** Get the maximum number of decimals any monetary value must show */
ETHEREAL.rgs.data.getCurrencyDecimalPlaces(): number;
/** Get the symbol of the currency */
ETHEREAL.rgs.data.getCurrencySymbol(): string;
/** Get the code of the currency */
ETHEREAL.rgs.data.getCurrencyCode(): string;

Game, engine and casino data

/** Id of the game */
ETHEREAL.rgs.data.getGameId(): number;
/** Name of the game */
ETHEREAL.rgs.data.getGameName(): string;
/** Rtp of the game */
ETHEREAL.rgs.data.getRtp(): number;

/** Specifies the type of casino (if any) (e.g., 'sweep' or 'social') that may have certain restrictions */
ETHEREAL.data.casinoType();

Player

/** Get the username of the player (if any) */
ETHEREAL.rgs.data.getPlayerUsername(): string;

/** Get how the game is being played currently (if it's real (0) or demo (2)) */
ETHEREAL.rgs.data.getPlayMode(): PlayMode | number;