BGA Studio Migration Guide - Revision history

BoontjieBoon: dojo.position

2026-07-30T13:44:17Z

dojo.position

← Older revision		Revision as of 15:44, 30 July 2026
Line 564:		Line 564:

	For translations use `this.bga.gameui.format_string` or `this.bga.gameui.format_string_recursive`		For translations use `this.bga.gameui.format_string` or `this.bga.gameui.format_string_recursive`
			\|-
			\|dojo.position(node)
			\|DOM
			\|Returns the DOM node's position and size
			\|node.getBoundingClientRect()
			Bounding rect's left, top, width, height correspond to dojo.pos' x, y, w, h respectively
	\|}		\|}

BoontjieBoon: dojo.style getter replacement

2026-07-30T12:00:02Z

dojo.style getter replacement

← Older revision		Revision as of 14:00, 30 July 2026
Line 507:		Line 507:
	\| Sets an inline CSS property on a DOM node. <b>CAUTION:</b> <code>dojo.style(node, "left")</code> (and "right", "width", etc) return lengths in pixels as numbers, not the set CSS style.		\| Sets an inline CSS property on a DOM node. <b>CAUTION:</b> <code>dojo.style(node, "left")</code> (and "right", "width", etc) return lengths in pixels as numbers, not the set CSS style.
	\| <code>node.style.color = "red"</code>		\| <code>node.style.color = "red"</code>
			\|-
			\|dojo.style(node, "color")
			\|Styling
			\|Gets the computed CSS value on a DOM node.
			\|getComputedStyle(node).color
	\|-		\|-
	\| <code>dojo.hasClass(node, "className")</code>		\| <code>dojo.hasClass(node, "className")</code>

Victoria La: /* Dojo usage */

2026-07-22T12:58:57Z

Dojo usage

← Older revision		Revision as of 14:58, 22 July 2026
Line 459:		Line 459:

	===Dojo usage===		===Dojo usage===
	Dojo usage has been ~~reduced to minimum~~ in the new project template and the doc~~, as native JS~~ is ~~now able to do almost the same things, with better performance and more knowledge for newcomers of the native (vanilla) JS~~.		Dojo usage has been removed in the new project template and the doc. Old game can still use it but its best to migrate. This is migration table.

	📌 Replace dojo by vanilla JS where possible		📌 Replace dojo by vanilla JS where possible

BoontjieBoon: Mentioned using this.bga.gameui.format_string instead of dojo.string.substitute

2026-07-22T11:08:09Z

Mentioned using this.bga.gameui.format_string instead of dojo.string.substitute

← Older revision		Revision as of 13:08, 22 July 2026
Line 558:		Line 558:
	\|<code>Use JS template strings, i.e. `<div id=${id}></div>`. Note: not suitable for translations if variables are used inside</code>		\|<code>Use JS template strings, i.e. `<div id=${id}></div>`. Note: not suitable for translations if variables are used inside</code>

			For translations use `this.bga.gameui.format_string` or `this.bga.gameui.format_string_recursive`
	\|}		\|}

Thoun: /* Structural changes */

2026-03-02T09:34:17Z

Structural changes

← Older revision		Revision as of 11:34, 2 March 2026
Line 33:		Line 33:

	File still there. Deprecated keys '''designer''', '''artist''', '''year''', '''presentation''', '''tags''', '''complexity''', '''strategy''', '''luck''', '''diplomacy''', '''is_beta''' are no longer in use. Please remove these keys and use the Game Metadata Manager instead.		File still there. Deprecated keys '''designer''', '''artist''', '''year''', '''presentation''', '''tags''', '''complexity''', '''strategy''', '''luck''', '''diplomacy''', '''is_beta''' are no longer in use. Please remove these keys and use the Game Metadata Manager instead.

			The file has a new optional flag <code>'exception_on_warning' => true</code> that should be added to better detect warnings, that are usually source of undetected bugs.

	'''''material.inc.php''''' => optional		'''''material.inc.php''''' => optional

Jonathan2004: add category

2026-02-27T07:51:39Z

add category

← Older revision		Revision as of 09:51, 27 February 2026
Line 591:		Line 591:

	https://en.doc.boardgamearena.com/Game_interface_stylesheet:_yourgamename.css#Support_of_the_Dark_mode		https://en.doc.boardgamearena.com/Game_interface_stylesheet:_yourgamename.css#Support_of_the_Dark_mode
			[[Category:Studio]]

Inaofr: /* Deprecated translation functions */ clienttranslate is not working in view.php file, all formatting have to be done through notify or UserException formatting or be removed from PHP and rewrote in JavaScript.

2026-02-24T22:30:25Z

Deprecated translation functions: clienttranslate is not working in view.php file, all formatting have to be done through notify or UserException formatting or be removed from PHP and rewrote in JavaScript.

← Older revision		Revision as of 00:30, 25 February 2026
Line 254:		Line 254:

	* totranslate function is not longer needed and can be replaced with clienttranslate		* totranslate function is not longer needed and can be replaced with clienttranslate
	* $this->_() - can also be replaced with clienttranslate when use for non parameterized ~~exceptions~~ strings ~~like~~		* $this->_() (or self::_()) can also be replaced with clienttranslate when use for non parameterized strings (but not in deprecated <game>.view.php file):

	throw new ~~\BgaUserException~~(clienttranslate('You must choose 3 cards'));		throw new UserException(clienttranslate('You must choose 3 cards'));

			UserException is also handling parameterized strings like the notify functions.

			All parameterized strings on PHP side have to use either the notify or the UserException formatting. If some parameterized strings are none of these, you have to remove them from PHP and rewrote them in JavaScript using dojo.string.substitute.

	See [[Translations]]		See [[Translations]]

Victoria La: Updates to APIs

2026-02-16T06:01:02Z

Updates to APIs

Show changes

Thoun at 10:27, 13 February 2026

2026-02-13T10:27:26Z

← Older revision		Revision as of 12:27, 13 February 2026
Line 161:		Line 161:
	Functions notifyAllPlayers and notifyPlayer from main game.php are deprecated		Functions notifyAllPlayers and notifyPlayer from main game.php are deprecated

	📌 Replace <code>$this->notifyAllPlayers</code> with <code>$this->notify->all</code>		📌 Replace <code>$this->notifyAllPlayers</code> with <code>$this->bga->notify->all</code>
	and Replace <code>$this->notifyPlayer</code> with <code>$this->notify->player</code>		and Replace <code>$this->notifyPlayer</code> with <code>$this->bga->notify->player</code>

	====Notification Decorators====		====Notification Decorators====

Thoun at 09:33, 14 January 2026

2026-01-14T09:33:40Z

← Older revision		Revision as of 11:33, 14 January 2026
Line 241:		Line 241:
	https://en.doc.boardgamearena.com/PlayerCounter_and_TableCounter		https://en.doc.boardgamearena.com/PlayerCounter_and_TableCounter

	📌 Replace setting player_score/player_score_aux using db queries with use of $this->playerScore and $this->playerScoreAux. Remove the notifications, or part of notifications, updating the ~~scoreCtrl~~ counter (if you had some custom notification you may still need them).		📌 Replace setting player_score/player_score_aux using db queries with use of $this->playerScore and $this->playerScoreAux. Remove the notifications, or part of notifications, updating the player panel score counter (if you had some custom notification you may still need them).
	===Updated Zombie Mode documentation and recommendations===		===Updated Zombie Mode documentation and recommendations===
	We now recommend making the zombie player playing randomly, instead of passing as a default. A new "Zombie Mode level" field has been added to the Game Metadata Manager, to indicated the Zombie Mode you implemented in your game.		We now recommend making the zombie player playing randomly, instead of passing as a default. A new "Zombie Mode level" field has been added to the Game Metadata Manager, to indicated the Zombie Mode you implemented in your game.