BgaCards - Revision history

Nalka: Adapt paragraph to removal of outdated incompatibility with deck

2026-08-25T15:26:27Z

Adapt paragraph to removal of outdated incompatibility with deck

← Older revision		Revision as of 17:26, 25 August 2026
Line 111:		Line 111:
	You would think you can just use the database method to get cards from Deck and send this to the UI and use it in bga-cards? No, it's not that easy.		You would think you can just use the database method to get cards from Deck and send this to the UI and use it in bga-cards? No, it's not that easy.

	~~Two problems:~~		Some of the bga-cards methods, most notably BgaCards.sort, assume fields (such as 'type') are integers, but if sent by PHP, they are strings (even worse, sometimes strings and sometimes integers).

	1) Some of the bga-cards methods, most notably BgaCards.sort, assume fields (such as 'type') are integers, but if sent by PHP~~, like in the example above~~, they are strings (even worse, sometimes strings and sometimes integers).
	If this is the ONLY problem (i.e. sort) you can get away by making your own sort function, otherwise you would have to make an object converter and apply it to all objects sent from notifications and getAllDatas.		If this is the ONLY problem (i.e. sort) you can get away by making your own sort function, otherwise you would have to make an object converter and apply it to all objects sent from notifications and getAllDatas.
	See the hearts tutorial for helper method examples (i.e. find the method remapToBgaCard).		See the hearts tutorial for helper method examples (i.e. find the method remapToBgaCard).

Nalka: bga-cards supports non-array input since 1.0.14

2026-08-25T15:24:17Z

bga-cards supports non-array input since 1.0.14

← Older revision		Revision as of 17:24, 25 August 2026
Line 113:		Line 113:
	Two problems:		Two problems:

	1~~) The default db accessor creates a map object rather than an array, which does not work with addCards.~~		1) Some of the bga-cards methods, most notably BgaCards.sort, assume fields (such as 'type') are integers, but if sent by PHP, like in the example above, they are strings (even worse, sometimes strings and sometimes integers).
	~~Let's say you do this in getAllDatas in PHP:~~
	~~// Cards in player hand~~
	~~$result['hand'] = $this->cards->getCardsInLocation('hand', $current_player_id);~~
	~~In .js you have to convert this to an array, i.e.:~~
	~~this.handStock.addCards(Object.values(this.gamedatas.hand));~~
	~~OR you can do thi in PHP instead (don't need both):~~
	~~$result['hand'] = array_values($this->cards->getCardsInLocation('hand', $current_player_id));~~

	2) Some of the bga-cards methods, most notably BgaCards.sort, assume fields (such as 'type') are integers, but if sent by PHP, like in the example above, they are strings (even worse, sometimes strings and sometimes integers).
	If this is the ONLY problem (i.e. sort) you can get away by making your own sort function, otherwise you would have to make an object converter and apply it to all objects sent from notifications and getAllDatas.		If this is the ONLY problem (i.e. sort) you can get away by making your own sort function, otherwise you would have to make an object converter and apply it to all objects sent from notifications and getAllDatas.
	See the hearts tutorial for helper method examples (i.e. find the method remapToBgaCard).		See the hearts tutorial for helper method examples (i.e. find the method remapToBgaCard).

	=== Asynchronicity ===		=== Asynchronicity ===
	It's not immediately obvious but many functions that add or remove cards are async (i.e. return Promise), that means not only do you have to wait (or chain) them if running one after another, you also have		It's not immediately obvious but many functions that add or remove cards are async (i.e. return Promise), that means not only do you have to wait (or chain) them if running one after another, you also have

Thoun at 09:00, 23 June 2026

2026-06-23T09:00:44Z

← Older revision		Revision as of 11:00, 23 June 2026
Line 24:		Line 24:
	const BgaCards = await importEsmLib('bga-cards', '1.x');		const BgaCards = await importEsmLib('bga-cards', '1.x');
	</pre>		</pre>
			This line should be placed on top of the JS file, before any class declaration.

	Legacy way;		Legacy way;

Thoun at 12:57, 16 June 2026

2026-06-16T12:57:51Z

← Older revision		Revision as of 14:57, 16 June 2026
Line 154:		Line 154:

	== Changelog ==		== Changelog ==
			'''1.0.14''': more logs for card element not matching a card / accept keyed objects in addition to arrays on inputs

	'''1.0.13''': fix all visible deck remove card		'''1.0.13''': fix all visible deck remove card

Thoun: /* Changelog */

2026-04-29T14:15:04Z

Changelog

← Older revision		Revision as of 16:15, 29 April 2026
Line 154:		Line 154:

	== Changelog ==		== Changelog ==
			'''1.0.13''': fix all visible deck remove card

	'''1.0.12''': fix duplication when adding a card to another slot of the same stock		'''1.0.12''': fix duplication when adding a card to another slot of the same stock

Thoun: /* Changelog */

2026-03-12T08:37:45Z

Changelog

← Older revision		Revision as of 10:37, 12 March 2026
Line 154:		Line 154:

	== Changelog ==		== Changelog ==
			'''1.0.12''': fix duplication when adding a card to another slot of the same stock

	'''1.0.11''': fix lastPlayedCardStyle that was not fully applied		'''1.0.11''': fix lastPlayedCardStyle that was not fully applied

Thoun: /* Changelog */

2026-03-04T16:08:41Z

Changelog

← Older revision		Revision as of 18:08, 4 March 2026
Line 154:		Line 154:

	== Changelog ==		== Changelog ==
			'''1.0.11''': fix lastPlayedCardStyle that was not fully applied

	'''1.0.10''': remove wrong required settings from GridStockSettings / demo of moving a card inside a slot stock with addCard / prevent selecting multiple times the same card programmatically / fix getLastPlayedCardStyle reading settings?.selectedCardStyle		'''1.0.10''': remove wrong required settings from GridStockSettings / demo of moving a card inside a slot stock with addCard / prevent selecting multiple times the same card programmatically / fix getLastPlayedCardStyle reading settings?.selectedCardStyle

Victoria La: /* Type casting from PHP Deck */

2026-01-05T23:07:45Z

Type casting from PHP Deck

← Older revision		Revision as of 01:07, 6 January 2026
Line 109:		Line 109:
	=== Type casting from PHP Deck ===		=== Type casting from PHP Deck ===
	You would think you can just use the database method to get cards from Deck and send this to the UI and use it in bga-cards? No, it's not that easy.		You would think you can just use the database method to get cards from Deck and send this to the UI and use it in bga-cards? No, it's not that easy.

	Two problems:		Two problems:
	1) The default db accessor creates a map rather than an array, ~~let~~'s say you do this in getAllDatas in PHP:
			1) The default db accessor creates a map object rather than an array, which does not work with addCards.
			Let's say you do this in getAllDatas in PHP:
	// Cards in player hand		// Cards in player hand
	$result['hand'] = $this->cards->getCardsInLocation('hand', $current_player_id);		$result['hand'] = $this->cards->getCardsInLocation('hand', $current_player_id);
	In .js you have to convert this to an array ~~(or in PHP)~~, i.e.:		In .js you have to convert this to an array, i.e.:
	this.handStock.addCards(Object.values(this.gamedatas.hand));		this.handStock.addCards(Object.values(this.gamedatas.hand));
	OR ~~the same~~ in PHP (don't need both):		OR you can do thi in PHP instead (don't need both):
	$result['hand'] = array_values($this->cards->getCardsInLocation('hand', $current_player_id));		$result['hand'] = array_values($this->cards->getCardsInLocation('hand', $current_player_id));

	2) Some of the bga-cards methods, most notably BgaCards.sort, assume fields (such as 'type') are integers, but if sent by PHP like in the example above they are strings (even worse, ~~some APIs return~~ strings and ~~some~~ integers).		2) Some of the bga-cards methods, most notably BgaCards.sort, assume fields (such as 'type') are integers, but if sent by PHP, like in the example above, they are strings (even worse, sometimes strings and sometimes integers).
	If this is the ONLY problem (i.e. sort) you can get away ~~with~~ making your own sort function, otherwise you would have to make an object converter and apply it to all objects sent from notifications and getAllDatas ~~that need to go in bga-cards APIs~~.		If this is the ONLY problem (i.e. sort) you can get away by making your own sort function, otherwise you would have to make an object converter and apply it to all objects sent from notifications and getAllDatas.
	See the hearts tutorial for helper method examples (i.e. find the method remapToBgaCard).		See the hearts tutorial for helper method examples (i.e. find the method remapToBgaCard).

Nalka: Fix typo (extra dot) in setup snippet

2026-01-05T18:46:43Z

Fix typo (extra dot) in setup snippet

← Older revision		Revision as of 20:46, 5 January 2026
Line 51:		Line 51:
	setupFrontDiv: (card, div) => {		setupFrontDiv: (card, div) => {
	div.style.background = 'blue';		div.style.background = 'blue';
	this.bga..gameui.addTooltipHtml(div.id, `tooltip of ${card.type}`);		this.bga.gameui.addTooltipHtml(div.id, `tooltip of ${card.type}`);
	},		},
	});		});

Victoria La at 15:35, 21 December 2025

2025-12-21T15:35:58Z

← Older revision		Revision as of 17:35, 21 December 2025
Line 1:		Line 1:
	{{Studio_Framework_Navigation}}		{{Studio_Framework_Navigation}}

	~~'''[https://x.boardgamearena.net/data/game-libs/bga-cards/1.x/demo/index.html <big>Demo</big>]'''~~

	~~'''<big>[https://x.boardgamearena.net/data/game-libs/bga-cards/1.x/docs/index.html Doc]</big>'''~~

	== Overview ==		== Overview ==
Line 13:		Line 11:

	Also https://en.doc.boardgamearena.com/Tutorial_hearts is now using bga-cards for tutorial game implementation.		Also https://en.doc.boardgamearena.com/Tutorial_hearts is now using bga-cards for tutorial game implementation.

			To see how its work and access examples of source code (via browser dev tools) see
			'''[https://x.boardgamearena.net/data/game-libs/bga-cards/1.x/demo/index.html Demo]'''

			For comprehensive API docs see
			'''[https://x.boardgamearena.net/data/game-libs/bga-cards/1.x/docs/index.html Doc]'''

	== Usage ==		== Usage ==