Deck - Revision history

Thoun at 09:01, 2 September 2026

2026-09-02T09:01:56Z

← Older revision		Revision as of 11:01, 2 September 2026
Line 1:		Line 1:
	{{Studio_Framework_Navigation}}		{{Studio_Framework_Navigation}}

			<big>A new lib for game items has been added to the framework: '''[[ItemManager]]'''. ''We recommend to use it instead of Deck.''</big>

	"Deck" is one of the most useful component on the PHP side. With "Deck", you can manage the cards in your game on the server side.		"Deck" is one of the most useful component on the PHP side. With "Deck", you can manage the cards in your game on the server side.

Thoun at 10:26, 13 February 2026

2026-02-13T10:26:04Z

← Older revision		Revision as of 12:26, 13 February 2026
Line 146:		Line 146:

	// Notify player about his cards		// Notify player about his cards
	$this->notify->player( $player_id, 'newHand', '', array(		$this->bga->notify->player( $player_id, 'newHand', '', array(
	'cards' => $cards		'cards' => $cards
	) );		) );

Thoun at 10:05, 1 October 2025

2025-10-01T10:05:35Z

← Older revision		Revision as of 12:05, 1 October 2025
Line 74:		Line 74:

	<pre>		<pre>
	$this->cards = $this->~~getNew( "module.common.deck" );~~		$this->cards = $this->deckFactory->createDeck('card');
	~~$this->cards~~->~~init~~( "card" );
	</pre>		</pre>

Line 81:		Line 80:

	<pre>		<pre>
	$this->firstKindCards = $this->~~getNew( "module.common.deck" );~~		$this->firstKindCards = $this->deckFactory->createDeck( "first_kind_card" );
	~~$this->firstKindCards~~ ->~~init~~( "first_kind_card" );		$this->secondKindCards = $this->deckFactory->createDeck( "second_kind_card" );
	$this->secondKindCards = $this->~~getNew( "module.common.deck" );~~
	~~$this->secondKindCards~~ ->~~init~~( "second_kind_card" );
	</pre>		</pre>

Line 172:		Line 169:
	Usually, init is called in your game constructor.		Usually, init is called in your game constructor.

	HINT: Create the deck object $this->~~getNew and do the init call~~ in the constructor or you will get "$this->cards" as an invalid reference later.		HINT: Create the deck object with $this->deckFactory->createDeck in the constructor or you will get "$this->cards" as an invalid reference later.

	Example with Hearts:		Example with Hearts:
Line 181:		Line 178:
	(...)		(...)

	$this->cards = $this->~~getNew( "module.common.deck" );~~		$this->cards = $this->deckFactory->createDeck('card');
	~~$this->cards~~->~~init~~( "card" );
	}		}
	</pre>		</pre>

Thoun at 16:35, 13 January 2025

2025-01-13T16:35:45Z

← Older revision		Revision as of 18:35, 13 January 2025
Line 149:		Line 149:

	// Notify player about his cards		// Notify player about his cards
	$this->~~notifyPlayer~~( $player_id, 'newHand', '', array(		$this->notify->player( $player_id, 'newHand', '', array(
	'cards' => $cards		'cards' => $cards
	) );		) );
	}		}

	// Note the use of "~~notifyPlayer~~" instead of "~~notifyAllPlayers~~": new cards is a private information ;)		// Note the use of "notify->player" instead of "notify->all": new cards is a private information ;)
	</pre>		</pre>

Sguzzer Gunayer: /* Auto-reshuffle */

2024-09-17T13:19:11Z

Auto-reshuffle

← Older revision		Revision as of 15:19, 17 September 2024
Line 457:		Line 457:
	=== Auto-reshuffle ===		=== Auto-reshuffle ===

	To enable auto-reshuffle you must do "$this->cards->autoreshuffle = true" during the setup of the component (often in the ''_construct'' function when you ''init()'' the Deck object).		To enable auto-reshuffle you must do "<code>$this->cards->autoreshuffle = true</code>" during the setup of the component (often in the ''_construct'' function when you ''init()'' the Deck object).

	Every time a card must be retrieved from the "deck" location, if it is empty the "discard" location will be automatically reshuffled into the "deck" location.		Every time a card must be retrieved from the "deck" location, if it is empty the "discard" location will be automatically reshuffled into the "deck" location.

	If you need to notify players when the deck is shuffled, you can setup a callback method using this feature: $this->cards->autoreshuffle_trigger = array('obj' => $this, 'method' => 'deckAutoReshuffle');		If you need to notify players when the deck is shuffled, you can setup a callback method using this feature: <pre>$this->cards->autoreshuffle_trigger = array('obj' => $this, 'method' => 'deckAutoReshuffle');</pre>

	If you need to use other locations than "deck" and "discard" for auto-reshuffle feature, you can configure it this way: $this->cards->autoreshuffle_custom = array('deck' => 'discard'); (replace 'deck' and 'discard' with your custom locations).		If you need to use other locations than "deck" and "discard" for auto-reshuffle feature, you can configure it this way: <pre>$this->cards->autoreshuffle_custom = array('deck' => 'discard');</pre> (replace 'deck' and 'discard' with your custom locations).

	[[Category:Studio]]		[[Category:Studio]]

Thoun: replace usage of self:: by $this->

2024-04-11T07:10:49Z

replace usage of self:: by $this->

← Older revision		Revision as of 09:10, 11 April 2024
Line 74:		Line 74:

	<pre>		<pre>
	$this->cards = ~~self::~~getNew( "module.common.deck" );		$this->cards = $this->getNew( "module.common.deck" );
	$this->cards->init( "card" );		$this->cards->init( "card" );
	</pre>		</pre>
Line 81:		Line 81:

	<pre>		<pre>
	$this->firstKindCards = ~~self::~~getNew( "module.common.deck" );		$this->firstKindCards = $this->getNew( "module.common.deck" );
	$this->firstKindCards ->init( "first_kind_card" );		$this->firstKindCards ->init( "first_kind_card" );
	$this->secondKindCards = ~~self::~~getNew( "module.common.deck" );		$this->secondKindCards = $this->getNew( "module.common.deck" );
	$this->secondKindCards ->init( "second_kind_card" );		$this->secondKindCards ->init( "second_kind_card" );
	</pre>		</pre>
Line 143:		Line 143:
	// Deal 13 cards to each players		// Deal 13 cards to each players
	// Create deck, shuffle it and give 13 initial cards		// Create deck, shuffle it and give 13 initial cards
	$players = ~~self::~~loadPlayersBasicInfos();		$players = $this->loadPlayersBasicInfos();
	foreach( $players as $player_id => $player )		foreach( $players as $player_id => $player )
	{		{
Line 149:		Line 149:

	// Notify player about his cards		// Notify player about his cards
	~~self::~~notifyPlayer( $player_id, 'newHand', '', array(		$this->notifyPlayer( $player_id, 'newHand', '', array(
	'cards' => $cards		'cards' => $cards
	) );		) );
Line 172:		Line 172:
	Usually, init is called in your game constructor.		Usually, init is called in your game constructor.

	HINT: Create the deck object ~~self::~~getNew and do the init call in the constructor or you will get "$this->cards" as an invalid reference later.		HINT: Create the deck object $this->getNew and do the init call in the constructor or you will get "$this->cards" as an invalid reference later.

	Example with Hearts:		Example with Hearts:
Line 181:		Line 181:
	(...)		(...)

	$this->cards = ~~self::~~getNew( "module.common.deck" );		$this->cards = $this->getNew( "module.common.deck" );
	$this->cards->init( "card" );		$this->cards->init( "card" );
	}		}

Vurtan: Document different result in getCardsInLocation

2024-02-26T17:48:21Z

Document different result in getCardsInLocation

← Older revision		Revision as of 19:48, 26 February 2024
Line 348:		Line 348:
	* location (string): the location where to get the cards.		* location (string): the location where to get the cards.
	* location_arg (optional): if specified, return only cards with the specified "location_arg".		* location_arg (optional): if specified, return only cards with the specified "location_arg".
	* order_by (optional): if specified, returned cards are ordered by the given database field. Example: "card_id" or "card_type".		* order_by (optional): if specified, returned cards are ordered by the given database field. Example: "card_id" or "card_type".
			Using the "order_by" parameter changes the resulting array. Without parameter you get an associative array with the "card_id", with the paramter you get a simple indexed array.

	'''countCardInLocation( $location, $location_arg=null )'''		'''countCardInLocation( $location, $location_arg=null )'''

Victoria La: createCards

2024-02-08T00:08:32Z

createCards

← Older revision		Revision as of 02:08, 8 February 2024
Line 209:		Line 209:
	Note: createCards is optimized to create a lot of cards at once. Do not use it to create cards one by one.		Note: createCards is optimized to create a lot of cards at once. Do not use it to create cards one by one.

	If "location" and "location_arg" arguments are not set, newly created cards are placed in the "deck" location. If "location" (and optionally location_arg) is specified, cards are created for this specific location.		If "$location" and "$location_arg" arguments are not set, newly created cards are placed in the "deck" location. If "location" (and optionally location_arg) is specified, cards are created for this specific location.

			Note: 'location' and 'location_arg' can not be set individually, it does not read these values from the passed array of cards.

	HINT: Be sure to do the createCards in setupNewGame. Doing createCards in the constructor will throw database errors.		HINT: Be sure to do the createCards in setupNewGame. Doing createCards in the constructor will throw database errors.

BrianLovesMarvel: /* Create a new Deck component */ Added hints about where to create the deck object, where to initialize it, where to createCards, and the return value of the pickCard being an array.

2022-12-20T17:32:39Z

Create a new Deck component: Added hints about where to create the deck object, where to initialize it, where to createCards, and the return value of the pickCard being an array.

← Older revision		Revision as of 19:32, 20 December 2022
Line 90:		Line 90:
	Note that you need to create a table for each "Deck", table name should be "first_kind_card" but the fields must remain "card_id", "card_type" and so on.		Note that you need to create a table for each "Deck", table name should be "first_kind_card" but the fields must remain "card_id", "card_type" and so on.

	Afterwards, we can initialize your "Deck" by creating all the cards of the game. Generally, this is done only once during the game, in the "setupNewGame" method.		Afterwards, we can initialize your "Deck" by creating all the cards of the game. Generally, this is done only once during the game, in the "setupNewGame" method.

	The "Deck" component provides a fast way to initialize all your cards at once: createCards. Here is how it is used for "Hearts":		The "Deck" component provides a fast way to initialize all your cards at once: createCards. Here is how it is used for "Hearts":<pre>
	<pre>
	// Create cards		// Create cards
	$cards = array();		$cards = array();
Line 172:		Line 171:

	Usually, init is called in your game constructor.		Usually, init is called in your game constructor.

			HINT: Create the deck object self::getNew and do the init call in the constructor or you will get "$this->cards" as an invalid reference later.

	Example with Hearts:		Example with Hearts:
Line 209:		Line 210:

	If "location" and "location_arg" arguments are not set, newly created cards are placed in the "deck" location. If "location" (and optionally location_arg) is specified, cards are created for this specific location.		If "location" and "location_arg" arguments are not set, newly created cards are placed in the "deck" location. If "location" (and optionally location_arg) is specified, cards are created for this specific location.

			HINT: Be sure to do the createCards in setupNewGame. Doing createCards in the constructor will throw database errors.

	=== Card standard format ===		=== Card standard format ===
Line 231:		Line 234:

	Return the card picked or "null" if there are no more card in given location.		Return the card picked or "null" if there are no more card in given location.

			The return value is an array of the card data elements (id, type, type_arg...) for that card.

	This method supports auto-reshuffle (see "auto-reshuffle" below).		This method supports auto-reshuffle (see "auto-reshuffle" below).

Victoria La at 23:15, 16 May 2022

2022-05-16T23:15:51Z

← Older revision		Revision as of 01:15, 17 May 2022
Line 456:		Line 456:

	If you need to use other locations than "deck" and "discard" for auto-reshuffle feature, you can configure it this way: $this->cards->autoreshuffle_custom = array('deck' => 'discard'); (replace 'deck' and 'discard' with your custom locations).		If you need to use other locations than "deck" and "discard" for auto-reshuffle feature, you can configure it this way: $this->cards->autoreshuffle_custom = array('deck' => 'discard'); (replace 'deck' and 'discard' with your custom locations).

			[[Category:Studio]]