Options and preferences: gameoptions.json, gamepreferences.json - Revision history

Thoun: /* Game Options */

2026-10-15T10:06:37Z

Game Options

← Older revision		Revision as of 10:06, 15 October 2026
Line 34:		Line 34:


	''~~'$this->bga->tableOptions->get(int $optionId)~~: ~~?int'''~~		''To access table options from the front side, see https://en.doc.boardgamearena.com/Main_game_logic:_Game.php#Table_options

	To ~~get the value of a~~ table ~~option~~ from the ~~Game class~~, ~~using the JSON key.~~		''To access table options from the front side, see https://en.doc.boardgamearena.com/Game_interface_logic:_Game.js#Table_options
	~~<pre>~~
	~~public function isExpansionActive()~~: ~~bool {~~
	~~$this->bga->tableOptions->get(100) === 1;~~
	}
	</~~pre>~~

	~~Note that if the table was created before the option, it will return null, so you can handle that case with <code>$this->bga->tableOptions->get(104) ?? 1<~~/~~code>~~. ~~The example above would also work if disabled is 0 and enabled is 1 for the option, because only 1 would return true, and both 0 and null would return false~~.

	~~'''$this->bga->tableOptions->getGameLanguage()~~: ~~?int'''~~

	~~Get the selected language index as defined in the gameinfos file~~.

	'''$this->getGameOptions(): array'''		'''$this->getGameOptions(): array'''

	To access json data (the metadata only).		To access json data (the metadata only). You should not need this.

	The options will be displayed in order they appear in JSON, not sorted by id or name!		The options will be displayed in order they appear in JSON, not sorted by id or name!

	~~''To access table options from the front side, see https://en.doc.boardgamearena.com/Game_interface_logic:_Game.js#Table_options~~

	=== Details of game options format ===		=== Details of game options format ===

Thoun at 09:41, 15 October 2026

2026-10-15T09:41:25Z

← Older revision		Revision as of 09:41, 15 October 2026
Line 55:		Line 55:
	The options will be displayed in order they appear in JSON, not sorted by id or name!		The options will be displayed in order they appear in JSON, not sorted by id or name!

	''To access ~~gameOptions~~ from ~~javascript, use~~ the ~~analog~~ front ~~method''~~ : ~~'''this~~.~~bga~~.~~tableOptions~~.~~get(int optionId)~~ : ~~int'''~~		''To access table options from the front side, see https://en.doc.boardgamearena.com/Game_interface_logic:_Game.js#Table_options

	=== Details of game options format ===		=== Details of game options format ===

Thoun: /* Game Options */

2026-10-07T09:14:51Z

Game Options

← Older revision		Revision as of 09:14, 7 October 2026
Line 45:		Line 45:
	Note that if the table was created before the option, it will return null, so you can handle that case with <code>$this->bga->tableOptions->get(104) ?? 1</code>. The example above would also work if disabled is 0 and enabled is 1 for the option, because only 1 would return true, and both 0 and null would return false.		Note that if the table was created before the option, it will return null, so you can handle that case with <code>$this->bga->tableOptions->get(104) ?? 1</code>. The example above would also work if disabled is 0 and enabled is 1 for the option, because only 1 would return true, and both 0 and null would return false.

			'''$this->bga->tableOptions->getGameLanguage(): ?int'''

	To access json data (the metadata only) ~~can use~~		Get the selected language index as defined in the gameinfos file.
	~~$game_options = $this->getGameOptions();~~
			'''$this->getGameOptions(): array'''

			To access json data (the metadata only).

	The options will be displayed in order they appear in JSON, not sorted by id or name!		The options will be displayed in order they appear in JSON, not sorted by id or name!

Thoun at 07:35, 17 September 2026

2026-09-17T07:35:28Z

← Older revision		Revision as of 07:35, 17 September 2026
Line 94:		Line 94:
	**values >=10 - turn based (currently 10..21)		**values >=10 - turn based (currently 10..21)
	**Note there are two similar values, 9 = realtime "no time limit with friends only" vs. 20 = turn-based "no time limit with friends only"		**Note there are two similar values, 9 = realtime "no time limit with friends only" vs. 20 = turn-based "no time limit with friends only"
	~~GAMESTATE_RATING_MODE and GAMESTATE_CLOCK_MODE are PHP global constants usable in your PHP game code (ex: <code>$this->tableOptions->get(GAMESTATE_CLOCK_MODE)</code>) but~~ not ~~in json~~.		Do not read or override those BGA internal variables.

	'''Example:'''		'''Example:'''

Thoun at 11:59, 16 September 2026

2026-09-16T11:59:48Z

← Older revision		Revision as of 11:59, 16 September 2026
Line 47:		Line 47:

	To access json data (the metadata only) can use		To access json data (the metadata only) can use
	$game_options = $this->~~getTableOptions~~();		$game_options = $this->getGameOptions();

	The options will be displayed in order they appear in JSON, not sorted by id or name!		The options will be displayed in order they appear in JSON, not sorted by id or name!
Line 507:		Line 507:
	* You can populate <code>gameoptions.json</code> with the result of <code>json_encode($game_options, JSON_PRETTY_PRINT)</code>		* You can populate <code>gameoptions.json</code> with the result of <code>json_encode($game_options, JSON_PRETTY_PRINT)</code>
	* You can populate <code>gamepreferences.json</code> with the result of <code>json_encode($game_preferences, JSON_PRETTY_PRINT)</code>		* You can populate <code>gamepreferences.json</code> with the result of <code>json_encode($game_preferences, JSON_PRETTY_PRINT)</code>
	* If you include gameoptions.inc.php directly, to read the values, then replace those calls with <code>$this->~~getTableOptions~~()</code> or <code>$this->getTablePreferences()</code> as appropriate which return arrays parsed from the JSON files		* If you include gameoptions.inc.php directly, to read the values, then replace those calls with <code>$this->getGameOptions()</code> or <code>$this->getTablePreferences()</code> as appropriate which return arrays parsed from the JSON files
	This message was posted to the developer Discord channel:<blockquote>'''Game options change (Optional!)'''		This message was posted to the developer Discord channel:<blockquote>'''Game options change (Optional!)'''

Thoun: /* Game Options */

2026-09-11T08:08:32Z

Game Options

← Older revision		Revision as of 08:08, 11 September 2026
Line 43:		Line 43:
	</pre>		</pre>

	Note that if the table was created before the option, it will return null, so you can handle that case with <code>$this->bga->tableOptions->get(104) ?? 1</code>. The example above would also work if disabled is 0 and ~~enable~~ is 1, because only 1 would ~~match~~, and both 0 and null would return false.		Note that if the table was created before the option, it will return null, so you can handle that case with <code>$this->bga->tableOptions->get(104) ?? 1</code>. The example above would also work if disabled is 0 and enabled is 1 for the option, because only 1 would return true, and both 0 and null would return false.

Thoun: /* Game Options */

2026-09-11T08:05:50Z

Game Options

← Older revision		Revision as of 08:05, 11 September 2026
Line 37:		Line 37:

	To get the value of a table option from the Game class, using the JSON key.		To get the value of a table option from the Game class, using the JSON key.
			<pre>
			public function isExpansionActive(): bool {
			$this->bga->tableOptions->get(100) === 1;
			}
			</pre>

	Note that if the table was created before the option, it will return null, so you can handle that case with <code>$this->bga->tableOptions->get(104) ?? 1</code>.		Note that if the table was created before the option, it will return null, so you can handle that case with <code>$this->bga->tableOptions->get(104) ?? 1</code>. The example above would also work if disabled is 0 and enable is 1, because only 1 would match, and both 0 and null would return false.

Thoun: /* Game Options */

2026-06-23T09:37:44Z

Game Options

← Older revision		Revision as of 09:37, 23 June 2026
Line 34:		Line 34:


	'''$this->bga->tableOptions->get(int $optionId): int'''		'''$this->bga->tableOptions->get(int $optionId): ?int'''

	To get the value of a table option from the Game class, using the JSON key.		To get the value of a table option from the Game class, using the JSON key.

			Note that if the table was created before the option, it will return null, so you can handle that case with <code>$this->bga->tableOptions->get(104) ?? 1</code>.

Evilpotatoe: /* Game Options */ Added tip to access from JS

2026-05-30T10:06:50Z

Game Options: Added tip to access from JS

← Older revision		Revision as of 10:06, 30 May 2026
Line 43:		Line 43:

	The options will be displayed in order they appear in JSON, not sorted by id or name!		The options will be displayed in order they appear in JSON, not sorted by id or name!

			''To access gameOptions from javascript, use the analog front method'' : '''this.bga.tableOptions.get(int optionId) : int'''

	=== Details of game options format ===		=== Details of game options format ===

Evilpotatoe: this.userPreferences.get(int) doesn't seem to exist in js. Replaced with this.bga.userPreferences

2026-05-25T17:18:25Z

this.userPreferences.get(int) doesn't seem to exist in js. Replaced with this.bga.userPreferences

← Older revision		Revision as of 17:18, 25 May 2026
Line 445:		Line 445:
	There is two ways to check/apply this. In javascript		There is two ways to check/apply this. In javascript

	if (this.userPreferences.get(100) == 2) ...		if (this.bga.userPreferences.get(100) == 2) ...

	This checks if preferences 100 has selected value 2.		This checks if preferences 100 has selected value 2.