Appendix C - game settings parameters
Definitions
This appendix lists all game settings which can be used when launching a game and therefore influencing features of that game. Game Settings are either passed using a predefined set (called a profile) by using the profile parameter of getGameURL call or by passing a valid JSON structure using the options parameter of this call.
List of available game settings
| Setting | Type | Default value | Notes |
| autoplayEnabled | boolean | true | |
| autoplayLossLimitRequired | boolean | false | |
| displayCoins | boolean | true | |
| displayJackpotOdds | boolean | false | |
| displayRTP | boolean | false | |
| displayXRTP | boolean | false | |
| displayClock | boolean | true | If false no clock is shown in games |
| forceOrientation | none landscape portrait | none | Use one of the allowed values |
| gambleEnabled | boolean | true | |
| historyURL | string | not set | |
| homeURL | string | not set | |
| loadMsg | string | not set | |
| maxExposure | number | not set | in 1/100 of base currency without fractions, multiplier for other currency will be applied Note this value is always in 1/100 of the base currency, so it will be multiplied by the currency multiplier before applied to standard or custom stakes |
| maxStake | number | not set | in 1/100 of base currency without fractions, a multiplier for other currency will be applied. Note this value is always in 1/100 of the base currency, so it will be multiplied by the currency multiplier before applied to standard or custom stakes |
| minStake | number | not set | in 1/100 of base currency without fractions, multiplier for other currency will be applied Note this value is always in 1/100 of the base currency, so it will be multiplied by the currency multiplier before applied to standard or custom stakes |
| minLoadTime | number | not set | in milliseconds |
| minSpinTime | number | not set | in milliseconds |
| multipleInstancesAllowed | boolean | false | |
| rcDisplayWinLoss | boolean | false | |
| rcEnabled | boolean | false | |
| rcInterval | number | not set | in milliseconds |
| stopEnabled | boolean | true | |
| topupURL | string | not set | |
| turboEnabled | boolean | true | |
| homeEnabled | boolean | true | If set to false no homebutton is displayed |
| redirectTarget | 'self' | 'parent' | 'top' | top | Redirect target for “Home” and “History” buttons |
| dynamicMinSpinTime | boolean | false | For german jurisdiction make spin time dynamic to activate average spin time |
| defaultStakeIndex | number | Not set | Index for default stake (starts with 0) |
| operatorHandlesErrors | boolean | false | If set no popups are generated by game in case of errors, all errors will be sent to frame with postMessage |
| customStakes | Array of numbers | Not set | An array of custom stakes available in the games in 1/100 units of the game currency, so no further multiplier will be applied. This option has to be activated for you operator account, pls contact hizi.io support if you want to use that feature Sample: [ 10000, 20000, 100000, 200000 ] |
| abbreviateAmounts | boolean | true | Used for social casinos, abbreviate large amounts in balance / stake display to like 1M instead of 1,000,000m should only be used for social casinos |
| showExactRTP | boolean | false | If true show the exact (not rounded RTP) in frontend rules |
| packageBuyEnabled | boolean | true | If true feature package buy is enabled in games (if supported by the game), if false it won’t be available for the game session |
| displaySessionTimer | boolean | false | Tells the game to display a session timer (e.g. for UKGC) |
| skipWinsEqualToOrLessThanStake | boolean | false | Do not celebrate small wins (e.g. for UKGC) |
| reportAnimationEnd | boolean | false | Enable sendout of reportAnimationEnd call |
| launcherType | boolean | Not set | Used for special integrations, use only after contacting hizi support |
| autoplayShowTotalStake | boolean | false | Show total stake in auto play popup, used for brazilian legislation |
| translateErrors | boolean | false | Use a standard translation for unexpected errors, used for brazilian legislation |
| currencyToDisplay | string | Not set | Use this string to display the currency, mostly used for custom currencies / sweep stakes |
Jurisdiction profiles
Settings that are needed for jurisdictions are available as default profiles. To comply with regulatory requirements the use of these profiles is recommended.
| Profile name | Contained settings | value |
| jurisdiction-mga | settings to comply with MGA (Malta) | |
| autoplayLossLimitRequired | true | |
| rcEnabled | true | |
| rcDisplayWinLoss | true | |
| jurisdiction-ukgc | Settings to comply with UKGC (2020) - market UK | |
| autoplayLossLimitRequired | true | |
| rcEnabled | true | |
| minSpinTime | 2500 | |
| turboEnabled | false | |
| autoplayEnabled | false | |
| stopEnabled | false | |
| maxStake | 5000 | |
| multipleInstancesAllowed | false | |
| packageBuyEnabled | false | |
| displayNetPosition | true | |
| jurisdiction-agcc | settings to comply with AGCC (Alderney) | |
| autoplayLossLimitRequired | true | |
| rcEnabled | true | |
| minSpinTime | 3000 | |
| turboEnabled | false | |
| autoplayEnabled | false | |
| stopEnabled | false | |
| maxStake | 5000 | |
| multipleInstancesAllowed | false | |
| jurisdiction-de | Settings for German market | |
| minSpinTime | 5000 | |
| turboEnabled | false | |
| autoplayEnabled | false | |
| stopEnabled | false | |
| maxStake | 100 | |
| multipleInstancesAllowed | false | |
| displayCoins | false | |
| displayJackpotOdds | true | |
| displayRTP | true | |
| displayXRTP | true | |
| dynamicMinSpinTime | true | |
| packageBuyEnabled | false | |
| jurisdiction-gr | settings for Greek market | |
| minSpinTime | 3000 | |
| maxStake | 2000 | |
| maxPackageStake | 2000 | |
| maxExposure | 14000000 | |
| stopEnabled | false | |
| jurisdiction-bg | Settings for Bulgarian market | |
| minSpinTime | 3000 | |
| stopEnabled | false | |
| jurisdiction-nl | Settings for Dutch market | |
| autoplayEnabled | false | |
| turboEnabled | false | |
| packageBuyEnabled | false | |
| forceDefaultStake | true | |
| defaultStakeIndex | 0 | |
| jurisdiction-se | Settings for Swedish market | |
| autoplayEnabled | false | |
| turboEnabled | false | |
| stopEnabled | false | |
| minSpinTime | 3000 | |
| jurisdiction-lt | Settings for Lithuanian market | |
| stopEnabled | false | |
| gambleEnabled | false | |
| minSpinTime | 1000 | |
| jurisdiction-br | Settings for Brazilian market | |
| displayPaytableOnEnterGame | true | |
| gambleEnabled | false | |
| doNotStoreSettings | ['autoplay'] | |
| sessionTimeoutInSeconds | 1800 | |
| hideDemoBalance | true | |
| jurisdiction-caon | Settings for Canadian / Ontario market | |
| autoplayEnabled | false | |
| turboEnabled | false | |
| stopEnabled | false | |
| minSpinTime | 2500 | |
| sessionTimeoutInSeconds | 1200 | |
| displayNetPosition | true |
List of available game variables
Game variables are settings which will be forwarded to the game client. Only known variables will be passed, if other variables are passed in the variables parameter of getGameURL an error invalid parameter will be thrown.
| Setting | Type | Notes |
| rcElapsed | number | time elapsed for reality check enabled games |