Skip to content

Appendix C - game settings parameters ​

Definitions ​

This appendix describes launch settings. See the frontend reference for the complete current field inventory. You use these settings when you launch a game. The settings control the features of that game. You can pass game settings in two ways. Use a predefined set of settings, called a profile, with the profile parameter of the getGameURL call. Or pass a valid JSON structure with the options parameter of this call.

List of available game settings ​

SettingTypeDefault valueNotes
autoplayEnabledbooleantrue
autoplayLossLimitRequiredbooleanfalse
displayCoinsbooleantrue
displayJackpotOddsbooleanfalse
displayRTPbooleanfalse
displayXRTPbooleanfalse
displayClockbooleantrueIf false, the game does not show a clock
forceOrientationnone landscape portraitnoneUse one of the allowed values
gambleEnabledbooleantrue
historyURLstringnot set
homeURLstringnot set
loadMsgstringnot set
maxExposurenumbernot setMaximum exposure, in 1/100 of base currency (see note below)
maxStakenumbernot setMaximum stake, in 1/100 of base currency (see note below)
minStakenumbernot setMinimum stake, in 1/100 of base currency (see note below)
minLoadTimenumbernot setin milliseconds
minSpinTimenumbernot setin milliseconds
multipleInstancesAllowedbooleanfalse
rcDisplayWinLossbooleanfalse
rcEnabledbooleanfalse
rcIntervalnumbernot setin milliseconds
stopEnabledbooleantrue
topupURLstringnot set
turboEnabledbooleantrue
homeEnabledbooleantrueIf false, the game does not display a home button
redirectTarget'self' | 'parent' | 'top'topRedirect target for the “Home” and “History” buttons
dynamicMinSpinTimebooleanfalseSelect an approved dynamic timing policy. The boolean does not define an averaging algorithm. See the frontend timing guide.
defaultStakeIndexnumberNot setIndex for default stake (starts with 0)
operatorHandlesErrorsbooleanfalseIf true, the game does not generate popups for errors. The game sends all errors to the frame with postMessage.
customStakesArray of numbersNot setAn array of custom stakes available in the game, in 1/100 units of the game currency. The system does not apply a further multiplier to these values. Contact hizi.io support to activate this option for your operator account. Sample: [10000, 20000, 100000, 200000]
abbreviateAmountsbooleantrueUsed for social casinos. It abbreviates large amounts in the balance or stake display, for example 1M instead of 1,000,000. Use this setting only for social casinos.
showExactRTPbooleanfalseIf true, the game shows the exact RTP (not rounded) in the frontend rules
packageBuyEnabledbooleantrueIf true, the game allows feature package buy (if the game supports it). If false, the game session does not offer feature package buy.
displaySessionTimerbooleanfalseThis setting tells the game to display a session timer (for example, for UKGC)
skipWinsEqualToOrLessThanStakebooleanfalseIf true, the game does not celebrate small wins (for example, for UKGC)
reportAnimationEndbooleanfalseIf true, the game sends the reportAnimationEnd call
launcherType'reelLink' | 'online'Not setUsed for special integrations. Contact hizi.io support before you use this setting.
autoplayShowTotalStakebooleanfalseShows the total stake in the autoplay popup. Used for Brazilian legislation.
translateErrorsbooleanfalseUses a standard translation for unexpected errors. Used for Brazilian legislation.
currencyToDisplaystringNot setUse this string to display the currency. Mostly used for custom currencies or sweep stakes.

maxExposure, maxStake, minStake and the currency multiplier

You always specify these three values as integers in 1/100 of the base currency (no fractions). When a game launches in another currency, the system multiplies the value by that currency's multiplier. These values define the intended bounds. The current engine custom-stake path skips its separate min/max checks. Frontends must apply the effective bounds themselves. (By contrast, you give customStakes in 1/100 of the game currency. The system does not apply a multiplier to customStakes.)


Jurisdiction profiles ​

Use the current jurisdiction inventory for all 13 named Hizi presets. That reference records source revisions and frontend behavior.

A preset contains platform defaults. It does not establish game certification or complete legal compliance. Apply the player's limits and the requirements for the product. For example, the UKGC preset needs player-specific stake caps and different timing for non-slot casino games.

The settings reference lists every SDK field and additional Hizi settings. It defines the units and required controls.


List of available game variables ​

Game variables are settings that the system forwards to the game client. The system passes only known variables. If you pass another variable in the variables parameter of getGameURL, the API throws an invalid parameter error.

SettingTypeNotes
rcElapsednumberTime elapsed for games with reality check enabled