Deck - Historie editací

Sourisdudesert: /* Get cards informations */

2013-02-13T17:04:14Z

Get cards informations

← Starší verze		Verze z 13. 2. 2013, 19:04
Řádek 315:		Řádek 315:
	Get all cards in specific location, as an array. Return an empty array if the location is empty.		Get all cards in specific location, as an array. Return an empty array if the location is empty.

	_ 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".

	'''countCardInLocation( $location, $location_arg=null )'''		'''countCardInLocation( $location, $location_arg=null )'''
Řádek 323:		Řádek 323:
	Return the number of cards in specified location.		Return the number of cards in specified location.

	_ location (string): the location where to count the cards.		* location (string): the location where to count the cards.
	_ location_arg (optional): if specified, count only cards with the specified "location_arg".		* location_arg (optional): if specified, count only cards with the specified "location_arg".

	'''countCardsInLocations()'''		'''countCardsInLocations()'''
Řádek 399:		Řádek 399:
	Return an array of cards, or an empty array if there is no cards of the specified type.		Return an array of cards, or an empty array if there is no cards of the specified type.

	_ type: the type of cards		* type: the type of cards
	_ type_arg: if specified, return only cards with the specified "type_arg".		* type_arg: if specified, return only cards with the specified "type_arg".

	=== Shuffling ===		=== Shuffling ===

Sourisdudesert: /* Moving cards */

2013-02-13T17:03:50Z

Moving cards

Sourisdudesert: /* Picking cards */

2013-02-13T17:03:29Z

Picking cards

← Starší verze		Verze z 13. 2. 2013, 19:03
Řádek 226:		Řádek 226:
	This method is similar to 'pickCard', except that you can pick a card for any sort of location and not only the "hand" location.		This method is similar to 'pickCard', except that you can pick a card for any sort of location and not only the "hand" location.

	_ from_location is the "pile" style location from where you are picking a card.		* from_location is the "pile" style location from where you are picking a card.
	_ to_location is the location where you will place the card picked.		* to_location is the location where you will place the card picked.
	_ if "location_arg" is specified, the card picked will be set with this "location_arg".		* if "location_arg" is specified, the card picked will be set with this "location_arg".

	This method supports auto-reshuffle (see "auto-reshuffle" below).		This method supports auto-reshuffle (see "auto-reshuffle" below).
Řádek 236:		Řádek 236:
	This method is similar to 'pickCards', except that you can pick cards for any sort of location and not only the "hand" location.		This method is similar to 'pickCards', except that you can pick cards for any sort of location and not only the "hand" location.

	_ from_location is the "pile" style location from where you are picking some cards.		* from_location is the "pile" style location from where you are picking some cards.
	_ to_location is the location where you will place the cards picked.		* to_location is the location where you will place the cards picked.
	_ if "location_arg" is specified, the cards picked will be set with this "location_arg".		* if "location_arg" is specified, the cards picked will be set with this "location_arg".
	_ if "no_deck_reform" is set to "true", the auto-reshuffle feature is disabled during this method call.		* if "no_deck_reform" is set to "true", the auto-reshuffle feature is disabled during this method call.

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

Sourisdudesert: /* Card standard format */

2013-02-13T17:03:05Z

Card standard format

← Starší verze		Verze z 13. 2. 2013, 19:03
Řádek 200:		Řádek 200:
	'location_arg' => .. // the card location argument		'location_arg' => .. // the card location argument
	);		);
	<pre>		</pre>

	=== Picking cards ===		=== Picking cards ===

Sourisdudesert v 13. 2. 2013, 17:02

2013-02-13T17:02:33Z

Ukázat změny

Sourisdudesert: /* Create a new Deck component */

2013-02-11T17:46:47Z

Create a new Deck component

← Starší verze		Verze z 11. 2. 2013, 19:46
Řádek 86:		Řádek 86:

	As you can see, "createCards" takes a description of all cards of the game. For each type of card, you have to specify its "type", "type_arg" and the number of card to create. "createCards" create all cards and place them into the "deck" location (as specified in the second argument).		As you can see, "createCards" takes a description of all cards of the game. For each type of card, you have to specify its "type", "type_arg" and the number of card to create. "createCards" create all cards and place them into the "deck" location (as specified in the second argument).

			Now, you are ready to use "Deck"!

			=== Simple examples using Deck ===

			(Most examples are from "Hearts" game)

			<pre>
			// In "getAllDatas', we need to send to the current player all the cards he has in hand:
			$result['hand'] = $this->cards->getCardsInLocation( 'hand', $player_id );
			</pre>

			<pre>
			// At some time we want to check if all the cards (52) are in player's hands:
			if( $this->cards->countCardInLocation( 'hand' ) == 52 )
			// do something
			</pre>

			<pre>
			// When a player plays a card in front of him on the table:
			$this->cards->moveCard( $card_id, 'cardsontable', $player_id );

			// Note the use of the custom location 'cardsontable' here to keep track of cards on the table.
			</pre>


			<pre>
			// This is a new hand: let's gather all cards from everywhere in the deck:
			$this->cards->moveAllCardsInLocation( null, "deck" );

			// And then shuffle the deck
			$this->cards->shuffle( 'deck' );

			// And then deal 13 cards to each player
			// Deal 13 cards to each players
			// Create deck, shuffle it and give 13 initial cards
			$players = self::loadPlayersBasicInfos();
			foreach( $players as $player_id => $player )
			{
			$cards = $this->cards->pickCards( 13, 'deck', $player_id );

			// Notify player about his cards
			self::notifyPlayer( $player_id, 'newHand', '', array(
			'cards' => $cards
			) );
			}

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

Sourisdudesert: /* Create a new Deck component */

2013-02-11T17:39:39Z

Create a new Deck component

← Starší verze		Verze z 11. 2. 2013, 19:39
Řádek 68:		Řádek 68:
	Note that we specify "card" here, the name of our previously created table. It means you can create several "Deck" with several tables. Most of the time this is unuseful: a Deck component should manage all objects of the same kind (ex: all cards of the game).		Note that we specify "card" here, the name of our previously created table. It means you can create several "Deck" with several tables. Most of the time this is unuseful: a Deck component should manage all objects of the same kind (ex: all cards of the game).

	Afterwards, we can ~~start using our~~ "Deck" ~~object~~. ~~In general~~, the ~~first~~		Afterwards, we can initialize your "Deck" by creating all the cards of the game. Generally, this is done only once during the game, during the "setupNewGame" method.

			"Deck" component provides you a fast way to initialize all your cards at once: createCards. Here is how it is used for "Hearts":
			<pre>
			// Create cards
			$cards = array();
			foreach( $this->colors as $color_id => $color ) // spade, heart, diamond, club
			{
			for( $value=2; $value<=14; $value++ ) // 2, 3, 4, ... K, A
			{
			$cards[] = array( 'type' => $color_id, 'type_arg' => $value, 'nbr' => 1);
			}
			}

			$this->cards->createCards( $cards, 'deck' );
			</pre>

			As you can see, "createCards" takes a description of all cards of the game. For each type of card, you have to specify its "type", "type_arg" and the number of card to create. "createCards" create all cards and place them into the "deck" location (as specified in the second argument).

Sourisdudesert: /* Deck overview */

2013-02-11T17:35:46Z

Deck overview

@@ Řádek 14: / Řádek 14: @@
 With Deck component, you manage all cards of your game.
 Using Deck component, each card will have 5 properties:
-* '''id''': This is the unique ID of each card. Two cards can't get the same ID. IDs are generated automatically by the Deck component when you create cards during the Setup phase of your game.
+* '''id''': This is the unique ID of each card.
-* '''type''' and '''type_arg''': These two values defines the type of your card. '''type''' is a short string, and '''type_arg''' is an integer. You can use these two values as you want to make sure you will be able to identify the different cards of the game.
+* '''type''' and '''type_arg''': These two values defines the type of your card (=what sort of card this is?).
 Examples of usage of "type" and "type_arg":
@@ Řádek 23: / Řádek 32: @@
 * In "Seasons", "type" is the type of the card (ex: 1 is Amulet of Air, 2 is Amulet of Fire, etc...). type_arg is not used.
 * In "Takenoko", a Deck component is used for objective cards. "type" is the kind of objective (irrigation/panda/plot) and "type_arg" is the ID of the specific objective to realize (ex: "a green bamboo x4"). Note that a second Deck component is used in Takenoko to manage the "garden plot" pile.
 For each Deck component in your game, you need to create a dedicated table in database. This table has a standard format. In practical, if you want to have a Deck component named "card", you just have to copy/paste the following in your "dbmodel.sql":

Sourisdudesert: /* Deck general principles */

2013-02-11T17:23:59Z

Deck general principles

@@ Řádek 11: / Řádek 11: @@
 Deck component is massively used in "Hearts" example game - a card game. You can find in "hearts.game.php" that the object "$this->cards" is used many times.
-== Deck general principles ==
+== Deck overview ==
 For each Deck component in your game, you need to create a dedicated table in database. This table has a standard format. In practical, if you want to have a Deck component named "card", you just have to copy/paste the following in your "dbmodel.sql":
@@ Řádek 34: / Řádek 45: @@
 Note that we specify "card" here, the name of our previously created table. It means you can create several "Deck" with several tables. Most of the time this is unuseful: a Deck component should manage all objects of the same kind (ex: all cards of the game).

Sourisdudesert v 11. 2. 2013, 17:05

2013-02-11T17:05:25Z

← Starší verze		Verze z 11. 2. 2013, 19:05
Řádek 5:		Řádek 5:
	* "Auto-reshuffle" discard pile into deck when deck is empty.		* "Auto-reshuffle" discard pile into deck when deck is empty.
	* Move cards between different locations: hands of players, the table, ...		* Move cards between different locations: hands of players, the table, ...


			== Using Deck: Hearts example ==

			Deck component is massively used in "Hearts" example game - a card game. You can find in "hearts.game.php" that the object "$this->cards" is used many times.

			== Deck general principles ==

			For each Deck component in your game, you need to create a dedicated table in database. This table has a standard format. In practical, if you want to have a Deck component named "card", you just have to copy/paste the following in your "dbmodel.sql":

			<pre>
			CREATE TABLE IF NOT EXISTS `card` (
			`card_id` int(10) unsigned NOT NULL AUTO_INCREMENT,
			`card_type` varchar(16) NOT NULL,
			`card_type_arg` int(11) NOT NULL,
			`card_location` varchar(16) NOT NULL,
			`card_location_arg` int(11) NOT NULL,
			PRIMARY KEY (`card_id`)
			) ENGINE=InnoDB DEFAULT CHARSET=utf8 AUTO_INCREMENT=1 ;
			</pre>

			Once you did this (and restart your game), you can declare your Deck component in your PHP code in your class constructor. For Hearts for example, I added to "Hearts()" method:

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

			Note that we specify "card" here, the name of our previously created table. It means you can create several "Deck" with several tables. Most of the time this is unuseful: a Deck component should manage all objects of the same kind (ex: all cards of the game).

← Starší verze		Verze z 13. 2. 2013, 19:03
Řádek 249:		Řádek 249:
	Move the specific card to given location.		Move the specific card to given location.

	_ card_id: ID of the card to move.		* card_id: ID of the card to move.
	_ location: location where to move the card.		* location: location where to move the card.
	_ location_arg: if specified, location_arg where to move the card. If not specified "location_arg" will be set to 0.		* location_arg: if specified, location_arg where to move the card. If not specified "location_arg" will be set to 0.


Řádek 258:		Řádek 258:
	Move the specific cards to given location.		Move the specific cards to given location.

	_ cards: an array of IDs of cards to move.		* cards: an array of IDs of cards to move.
	_ location: location where to move the cards.		* location: location where to move the cards.
	_ location_arg: if specified, location_arg where to move the cards. If not specified "location_arg" will be set to 0.		* location_arg: if specified, location_arg where to move the cards. If not specified "location_arg" will be set to 0.

	'''insertCard( $card_id, $location, $location_arg )'''		'''insertCard( $card_id, $location, $location_arg )'''
Řádek 278:		Řádek 278:
	Move all cards in specified "from" location to given location.		Move all cards in specified "from" location to given location.

	_ from_location: where to take the cards		* from_location: where to take the cards
	_ to_location: where to put the cards		* to_location: where to put the cards
	_ from_location (optional): if specified, only cards with given "location_arg" are moved.		* from_location (optional): if specified, only cards with given "location_arg" are moved.
	_ to_location (optional): if specified, cards moved "location_arg" is set to given value. Otherwise location_arg is set to zero.		* to_location (optional): if specified, cards moved "location_arg" is set to given value. Otherwise location_arg is set to zero.

	Note: if you want to keep "location_arg" untouched, you should use "moveAllCardsInLocationKeepOrder" below.		Note: if you want to keep "location_arg" untouched, you should use "moveAllCardsInLocationKeepOrder" below.