Board Game Arena - Уклад удзельніка [be]

Gamehelpfleet

2020-10-26T02:40:15Z

Marcuda: /* Tuna License */

[https://boardgamegeek.com/boardgame/121297/fleet Fleet] is a card game where players seek the most victory points by purchasing fishing licenses, launching boats, and hiring captains to gather fish.

== Gameplay ==

The game is played in rounds of five phases each. Each phase is played in turn order. At the end of a round the starting player token is passed to the next player and a new round begins.

=== Phase One: License Auction ===

Players may purchase a fishing license from the license auction, using the boat
cards from their hand as cash. Other players may attempt to out bid each other. The license is then placed in front of the winner.

=== Phase Two: Launch Boats and Hire Captains ===

Players may launch a boat from their hand (matching a fishing license they own)
by selecting it and paying (discarding) the launch cost using other boat cards
from their hand as cash.

Players may then hire a captain by placing a boat card from their hand face down
on any of their available launched boats.

=== Phase Three: Fishing ===

Players gain a crate of fish from the supply on each of their captained boats
that is not already at capacity (4).

=== Phase Four: Processing and Trading ===

If able, a player may process one crate of fish per boat for later use. A player may then trade one crate of fish from their processed supply for a boat card.

=== Phase Five: Draw ===

Players draw two cards and discard one of the cards just drawn.

== Game End ==

=== Conditions ===

The game ends when either
* there are not enough license cards to completely refill the auction after Phase One, or
* the supply of fish crates runs out during Phase Three
In either case the game will end after Phase Three of that round. If the fish crates run our all players still receive credit for fish crates due to them.

=== Scoring ===

At the end of the game players score Victory Points (VP):
* +VP for all purchased license cards
* +VP for all launched boats
* +1VP for each fish crate on launched boats (''not'' processed)
* Bonus VP from King Crab licenses
* +2VP for each Gone Fishin' card in hand (if applicable)

The player with the most VP wins. If tied, the player with the most launched boats wins. If still tied, then the player with the most fish crates on boats wins.

== Boat Cards ==

Boat cards in a player's hand can be used in many ways. They can be discarded as money, launched as a boat, or played upside down as a captain. The money value is shown as a number of coins in the bottom left. The cost to launch and victory points earned are shown in the upper left and right, respectively. And any boat can be used to captain any other boat.

The deck includes 20 of each Shrimp, Lobster, and Processing Vessel and 12 of each Codd, Tuna, and King Crab.

== License Cards ==

Each fishing license not only allows a player to launch that type of boat, but it also provides a special bonus. These bonuses improve as players acquire additional copies of a license. There are four (4) of each license except the Pub and King Crab, for which there are three (3).

=== Shrimp License ===

Each Shrimp license grants the player a discount on all future purchases.
{| class="wikitable" style="white-space:nowrap;"
|-
! Owned !! Bonus
|-
| 1
| $1 off every purchase
|-
| 2
| $2 off every purchase
|-
| 3
| $3 off every purchase
|-
| 4
| $4 off every purchase
|}

=== Cod License ===

During the Launch Boats phase, the Cod licenses allows a player to launch one additional boat and gives a bonus draw. Cards are drawn after launching boats is complete (before hiring captains), and only if the player launched at least one boat.
{| class="wikitable" style="white-space:nowrap;"
|-
! Owned !! Bonus
|-
| Any
| May launch 2 boats
|-
| 1
| +1 card (if launched)
|-
| 2
| +2 cards (if launched)
|-
| 3
| +3 cards (if launched)
|-
| 4
| +4 cards (if launched)
|}

=== Lobster License ===

During the Hire Captains phase, the Lobster licenses allows a player to hire one additional captain and gives a bonus draw depending on the number of captains a player has. Cards are drawn after hiring captains is complete.
{| class="wikitable" style="white-space:nowrap;"
|-
! Owned !! Bonus
|-
| Any
| May hire 2 captains
|-
| 1
| +1 card for 1-3 captains
+2 cards for 4+ captains
|-
| 2+
| +1 card for 1-2 captains
+2 cards for 3-6 captains

+3 cards for 7+ captains
|}

=== Tuna License ===

During the Draw phase (V), the Tuna license allows the player to keep and/or draw additional cards. Additionally, if required to discard, the player may discard any card in hand instead of only those just drawn.
{| class="wikitable" style="white-space:nowrap;"
|-
! Owned !! Bonus
|-
| Any
| May discard from hand
|-
| 1
| Draw 2, keep 2
|-
| 2
| Draw 3, keep 2
|-
| 3
| Draw 3, keep 3
|-
| 4
| Draw 4, keep 3
|}

=== Processing Vessel License ===

The Processing Vessel license is required for a player to participate in the Processing and Trading phase. Each license gives an additional draw bonus during trading.
{| class="wikitable" style="white-space:nowrap;"
|-
! Owned !! Bonus
|-
| Any
| May process and trade fish
|-
| 1
| +1 card from trade
|-
| 2
| +2 cards from trade
|-
| 3
| +3 cards from trade
|-
| 4
| +4 cards from trade
|}

N.B. A launched Processing Vessel is not required to process fish, just the license. Once purchased any boat can process fish.

=== Fishermen's Pub ===

The Fishermen's Pub is worth 10VP. It has NO boats or other bonuses.

=== King Crab License ===

There are three different King Crab licenses. Each gives a different bonus at the end of game worth up to 10VP.

* +1VP for every 3 fish crates on boats
* +1VP for each captain
* +VP for different license types. There are seven (7) types; all King Crab licenses count as the same type. See table:
{| class="wikitable" style="white-space:nowrap;"
|-
! Different
Licenses
! Bonus
|-
| 2
| +2VP
|-
| 3
| +4VP
|-
| 4
| +5VP
|-
| 5
| +6VP
|-
| 6
| +8VP
|-
| 7
| +10VP
|}

== Gone Fishin' ==

Gone Fishin' is an optional feature taken from the Fleet: Arctic Bounty expansion. It allows players to Go Fishin' instead of buying a license at auction. If a player passes the auction phase without buying a license they receive a Gone Fishin' card. These cards have a value of $2 for future purchases, but they are not boats and cannot captain. At the end of the game any Gone Fishin' cards still in a player's hand are worth +2VP.

The game designer recommends playing with Gone Fishin' enabled. It generally smooths out the game, especially in early rounds where money can be tight.

Help

2020-09-12T21:34:12Z

Marcuda: /* Games */

Gamehelpfleet

2020-08-31T01:11:59Z

Marcuda: Clarify processing vessel

[https://boardgamegeek.com/boardgame/121297/fleet Fleet] is a card game where players seek the most victory points by purchasing fishing licenses, launching boats, and hiring captains to gather fish.

== Gameplay ==

The game is played in rounds of five phases each. Each phase is played in turn order. At the end of a round the starting player token is passed to the next player and a new round begins.

=== Phase One: License Auction ===

Players may purchase a fishing license from the license auction, using the boat
cards from their hand as cash. Other players may attempt to out bid each other. The license is then placed in front of the winner.

=== Phase Two: Launch Boats and Hire Captains ===

Players may launch a boat from their hand (matching a fishing license they own)
by selecting it and paying (discarding) the launch cost using other boat cards
from their hand as cash.

Players may then hire a captain by placing a boat card from their hand face down
on any of their available launched boats.

=== Phase Three: Fishing ===

Players gain a crate of fish from the supply on each of their captained boats
that is not already at capacity (4).

=== Phase Four: Processing and Trading ===

If able, a player may process one crate of fish per boat for later use. A player may then trade one crate of fish from their processed supply for a boat card.

=== Phase Five: Draw ===

Players draw two cards and discard one of the cards just drawn.

== Game End ==

=== Conditions ===

The game ends when either
* there are not enough license cards to completely refill the auction after Phase One, or
* the supply of fish crates runs out during Phase Three
In either case the game will end after Phase Three of that round. If the fish crates run our all players still receive credit for fish crates due to them.

=== Scoring ===

At the end of the game players score Victory Points (VP):
* +VP for all purchased license cards
* +VP for all launched boats
* +1VP for each fish crate on launched boats (''not'' processed)
* Bonus VP from King Crab licenses
* +2VP for each Gone Fishin' card in hand (if applicable)

The player with the most VP wins. If tied, the player with the most launched boats wins. If still tied, then the player with the most fish crates on boats wins.

== Boat Cards ==

Boat cards in a player's hand can be used in many ways. They can be discarded as money, launched as a boat, or played upside down as a captain. The money value is shown as a number of coins in the bottom left. The cost to launch and victory points earned are shown in the upper left and right, respectively. And any boat can be used to captain any other boat.

The deck includes 20 of each Shrimp, Lobster, and Processing Vessel and 12 of each Codd, Tuna, and King Crab.

== License Cards ==

Each fishing license not only allows a player to launch that type of boat, but it also provides a special bonus. These bonuses improve as players acquire additional copies of a license. There are four (4) of each license except the Pub and King Crab, for which there are three (3).

=== Shrimp License ===

Each Shrimp license grants the player a discount on all future purchases.
{| class="wikitable" style="white-space:nowrap;"
|-
! Owned !! Bonus
|-
| 1
| $1 off every purchase
|-
| 2
| $2 off every purchase
|-
| 3
| $3 off every purchase
|-
| 4
| $4 off every purchase
|}

=== Cod License ===

During the Launch Boats phase, the Cod licenses allows a player to launch one additional boat and gives a bonus draw. Cards are drawn after launching boats is complete (before hiring captains), and only if the player launched at least one boat.
{| class="wikitable" style="white-space:nowrap;"
|-
! Owned !! Bonus
|-
| Any
| May launch 2 boats
|-
| 1
| +1 card (if launched)
|-
| 2
| +2 cards (if launched)
|-
| 3
| +3 cards (if launched)
|-
| 4
| +4 cards (if launched)
|}

=== Lobster License ===

During the Hire Captains phase, the Lobster licenses allows a player to hire one additional captain and gives a bonus draw depending on the number of captains a player has. Cards are drawn after hiring captains is complete.
{| class="wikitable" style="white-space:nowrap;"
|-
! Owned !! Bonus
|-
| Any
| May hire 2 captains
|-
| 1
| +1 card for 1-3 captains
+2 cards for 4+ captains
|-
| 2+
| +1 card for 1-2 captains
+2 cards for 3-6 captains

+3 cards for 7+ captains
|}

=== Tuna License ===

During the Draw phase, the Tuna license allows the player to discard any card in their hand and gives a draw bonus.
{| class="wikitable" style="white-space:nowrap;"
|-
! Owned !! Bonus
|-
| Any
| May discard from hand
|-
| 1
| Draw 2, keep 2
|-
| 2
| Draw 3, keep 2
|-
| 3
| Draw 3, keep 3
|-
| 4
| Draw 4, keep 3
|}

=== Processing Vessel License ===

The Processing Vessel license is required for a player to participate in the Processing and Trading phase. Each license gives an additional draw bonus during trading.
{| class="wikitable" style="white-space:nowrap;"
|-
! Owned !! Bonus
|-
| Any
| May process and trade fish
|-
| 1
| +1 card from trade
|-
| 2
| +2 cards from trade
|-
| 3
| +3 cards from trade
|-
| 4
| +4 cards from trade
|}

N.B. A launched Processing Vessel is not required to process fish, just the license. Once purchased any boat can process fish.

=== Fishermen's Pub ===

The Fishermen's Pub is worth 10VP. It has NO boats or other bonuses.

=== King Crab License ===

There are three different King Crab licenses. Each gives a different bonus at the end of game worth up to 10VP.

* +1VP for every 3 fish crates on boats
* +1VP for each captain
* +VP for different license types. There are seven (7) types; all King Crab licenses count as the same type. See table:
{| class="wikitable" style="white-space:nowrap;"
|-
! Different
Licenses
! Bonus
|-
| 2
| +2VP
|-
| 3
| +4VP
|-
| 4
| +5VP
|-
| 5
| +6VP
|-
| 6
| +8VP
|-
| 7
| +10VP
|}

== Gone Fishin' ==

Gone Fishin' is an optional feature taken from the Fleet: Arctic Bounty expansion. It allows players to Go Fishin' instead of buying a license at auction. If a player passes the auction phase without buying a license they receive a Gone Fishin' card. These cards have a value of $2 for future purchases, but they are not boats and cannot captain. At the end of the game any Gone Fishin' cards still in a player's hand are worth +2VP.

The game designer recommends playing with Gone Fishin' enabled. It generally smooths out the game, especially in early rounds where money can be tight.

Gamehelpfleet

2020-08-08T17:35:17Z

Marcuda: /* Scoring */

[https://boardgamegeek.com/boardgame/121297/fleet Fleet] is a card game where players seek the most victory points by purchasing fishing licenses, launching boats, and hiring captains to gather fish.

== Gameplay ==

The game is played in rounds of five phases each. Each phase is played in turn order. At the end of a round the starting player token is passed to the next player and a new round begins.

=== Phase One: License Auction ===

Players may purchase a fishing license from the license auction, using the boat
cards from their hand as cash. Other players may attempt to out bid each other. The license is then placed in front of the winner.

=== Phase Two: Launch Boats and Hire Captains ===

Players may launch a boat from their hand (matching a fishing license they own)
by selecting it and paying (discarding) the launch cost using other boat cards
from their hand as cash.

Players may then hire a captain by placing a boat card from their hand face down
on any of their available launched boats.

=== Phase Three: Fishing ===

Players gain a crate of fish from the supply on each of their captained boats
that is not already at capacity (4).

=== Phase Four: Processing and Trading ===

If able, a player may process one crate of fish per boat for later use. A player may then trade one crate of fish from their processed supply for a boat card.

=== Phase Five: Draw ===

Players draw two cards and discard one of the cards just drawn.

== Game End ==

=== Conditions ===

The game ends when either
* there are not enough license cards to completely refill the auction after Phase One, or
* the supply of fish crates runs out during Phase Three
In either case the game will end after Phase Three of that round. If the fish crates run our all players still receive credit for fish crates due to them.

=== Scoring ===

At the end of the game players score Victory Points (VP):
* +VP for all purchased license cards
* +VP for all launched boats
* +1VP for each fish crate on launched boats (''not'' processed)
* Bonus VP from King Crab licenses
* +2VP for each Gone Fishin' card in hand (if applicable)

The player with the most VP wins. If tied, the player with the most launched boats wins. If still tied, then the player with the most fish crates on boats wins.

== Boat Cards ==

Boat cards in a player's hand can be used in many ways. They can be discarded as money, launched as a boat, or played upside down as a captain. The money value is shown as a number of coins in the bottom left. The cost to launch and victory points earned are shown in the upper left and right, respectively. And any boat can be used to captain any other boat.

The deck includes 20 of each Shrimp, Lobster, and Processing Vessel and 12 of each Codd, Tuna, and King Crab.

== License Cards ==

Each fishing license not only allows a player to launch that type of boat, but it also provides a special bonus. These bonuses improve as players acquire additional copies of a license. There are four (4) of each license except the Pub and King Crab, for which there are three (3).

=== Shrimp License ===

Each Shrimp license grants the player a discount on all future purchases.
{| class="wikitable" style="white-space:nowrap;"
|-
! Owned !! Bonus
|-
| 1
| $1 off every purchase
|-
| 2
| $2 off every purchase
|-
| 3
| $3 off every purchase
|-
| 4
| $4 off every purchase
|}

=== Cod License ===

During the Launch Boats phase, the Cod licenses allows a player to launch one additional boat and gives a bonus draw. Cards are drawn after launching boats is complete (before hiring captains), and only if the player launched at least one boat.
{| class="wikitable" style="white-space:nowrap;"
|-
! Owned !! Bonus
|-
| Any
| May launch 2 boats
|-
| 1
| +1 card (if launched)
|-
| 2
| +2 cards (if launched)
|-
| 3
| +3 cards (if launched)
|-
| 4
| +4 cards (if launched)
|}

=== Lobster License ===

During the Hire Captains phase, the Lobster licenses allows a player to hire one additional captain and gives a bonus draw depending on the number of captains a player has. Cards are drawn after hiring captains is complete.
{| class="wikitable" style="white-space:nowrap;"
|-
! Owned !! Bonus
|-
| Any
| May hire 2 captains
|-
| 1
| +1 card for 1-3 captains
+2 cards for 4+ captains
|-
| 2+
| +1 card for 1-2 captains
+2 cards for 3-6 captains

+3 cards for 7+ captains
|}

=== Tuna License ===

During the Draw phase, the Tuna license allows the player to discard any card in their hand and gives a draw bonus.
{| class="wikitable" style="white-space:nowrap;"
|-
! Owned !! Bonus
|-
| Any
| May discard from hand
|-
| 1
| Draw 2, keep 2
|-
| 2
| Draw 3, keep 2
|-
| 3
| Draw 3, keep 3
|-
| 4
| Draw 4, keep 3
|}

=== Processing Vessel License ===

The Processing Vessel license is required for a player to participate in the Processing and Trading phase. Each license gives an additional draw bonus during trading.
{| class="wikitable" style="white-space:nowrap;"
|-
! Owned !! Bonus
|-
| Any
| May process and trade fish
|-
| 1
| +1 card from trade
|-
| 2
| +2 cards from trade
|-
| 3
| +3 cards from trade
|-
| 4
| +4 cards from trade
|}

=== Fishermen's Pub ===

The Fishermen's Pub is worth 10VP. It has NO boats or other bonuses.

=== King Crab License ===

There are three different King Crab licenses. Each gives a different bonus at the end of game worth up to 10VP.

* +1VP for every 3 fish crates on boats
* +1VP for each captain
* +VP for different license types. There are seven (7) types; all King Crab licenses count as the same type. See table:
{| class="wikitable" style="white-space:nowrap;"
|-
! Different
Licenses
! Bonus
|-
| 2
| +2VP
|-
| 3
| +4VP
|-
| 4
| +5VP
|-
| 5
| +6VP
|-
| 6
| +8VP
|-
| 7
| +10VP
|}

== Gone Fishin' ==

Gone Fishin' is an optional feature taken from the Fleet: Arctic Bounty expansion. It allows players to Go Fishin' instead of buying a license at auction. If a player passes the auction phase without buying a license they receive a Gone Fishin' card. These cards have a value of $2 for future purchases, but they are not boats and cannot captain. At the end of the game any Gone Fishin' cards still in a player's hand are worth +2VP.

The game designer recommends playing with Gone Fishin' enabled. It generally smooths out the game, especially in early rounds where money can be tight.

Gamehelpfleet

2020-08-08T17:34:04Z

Marcuda: Created page with "[https://boardgamegeek.com/boardgame/121297/fleet Fleet] is a card game where players seek the most victory points by purchasing fishing licenses, launching boats, and hiring..."

[https://boardgamegeek.com/boardgame/121297/fleet Fleet] is a card game where players seek the most victory points by purchasing fishing licenses, launching boats, and hiring captains to gather fish.

== Gameplay ==

The game is played in rounds of five phases each. Each phase is played in turn order. At the end of a round the starting player token is passed to the next player and a new round begins.

=== Phase One: License Auction ===

Players may purchase a fishing license from the license auction, using the boat
cards from their hand as cash. Other players may attempt to out bid each other. The license is then placed in front of the winner.

=== Phase Two: Launch Boats and Hire Captains ===

Players may launch a boat from their hand (matching a fishing license they own)
by selecting it and paying (discarding) the launch cost using other boat cards
from their hand as cash.

Players may then hire a captain by placing a boat card from their hand face down
on any of their available launched boats.

=== Phase Three: Fishing ===

Players gain a crate of fish from the supply on each of their captained boats
that is not already at capacity (4).

=== Phase Four: Processing and Trading ===

If able, a player may process one crate of fish per boat for later use. A player may then trade one crate of fish from their processed supply for a boat card.

=== Phase Five: Draw ===

Players draw two cards and discard one of the cards just drawn.

== Game End ==

=== Conditions ===

The game ends when either
* there are not enough license cards to completely refill the auction after Phase One, or
* the supply of fish crates runs out during Phase Three
In either case the game will end after Phase Three of that round. If the fish crates run our all players still receive credit for fish crates due to them.

=== Scoring ===

At the end of the game players score Victory Points (VP):
* +VP for all purchased license cards
* +VP for all launched boats
* +1VP for each fish crate on launched boats (_not_ processed)
* Bonus VP from King Crab licenses
* +2VP for each Gone Fishin' card in hand (if applicable)

The player with the most VP wins. If tied, the player with the most launched boats wins. If still tied, then the player with the most fish crates on boats wins.

== Boat Cards ==

Boat cards in a player's hand can be used in many ways. They can be discarded as money, launched as a boat, or played upside down as a captain. The money value is shown as a number of coins in the bottom left. The cost to launch and victory points earned are shown in the upper left and right, respectively. And any boat can be used to captain any other boat.

The deck includes 20 of each Shrimp, Lobster, and Processing Vessel and 12 of each Codd, Tuna, and King Crab.

== License Cards ==

Each fishing license not only allows a player to launch that type of boat, but it also provides a special bonus. These bonuses improve as players acquire additional copies of a license. There are four (4) of each license except the Pub and King Crab, for which there are three (3).

=== Shrimp License ===

Each Shrimp license grants the player a discount on all future purchases.
{| class="wikitable" style="white-space:nowrap;"
|-
! Owned !! Bonus
|-
| 1
| $1 off every purchase
|-
| 2
| $2 off every purchase
|-
| 3
| $3 off every purchase
|-
| 4
| $4 off every purchase
|}

=== Cod License ===

During the Launch Boats phase, the Cod licenses allows a player to launch one additional boat and gives a bonus draw. Cards are drawn after launching boats is complete (before hiring captains), and only if the player launched at least one boat.
{| class="wikitable" style="white-space:nowrap;"
|-
! Owned !! Bonus
|-
| Any
| May launch 2 boats
|-
| 1
| +1 card (if launched)
|-
| 2
| +2 cards (if launched)
|-
| 3
| +3 cards (if launched)
|-
| 4
| +4 cards (if launched)
|}

=== Lobster License ===

During the Hire Captains phase, the Lobster licenses allows a player to hire one additional captain and gives a bonus draw depending on the number of captains a player has. Cards are drawn after hiring captains is complete.
{| class="wikitable" style="white-space:nowrap;"
|-
! Owned !! Bonus
|-
| Any
| May hire 2 captains
|-
| 1
| +1 card for 1-3 captains
+2 cards for 4+ captains
|-
| 2+
| +1 card for 1-2 captains
+2 cards for 3-6 captains

+3 cards for 7+ captains
|}

=== Tuna License ===

During the Draw phase, the Tuna license allows the player to discard any card in their hand and gives a draw bonus.
{| class="wikitable" style="white-space:nowrap;"
|-
! Owned !! Bonus
|-
| Any
| May discard from hand
|-
| 1
| Draw 2, keep 2
|-
| 2
| Draw 3, keep 2
|-
| 3
| Draw 3, keep 3
|-
| 4
| Draw 4, keep 3
|}

=== Processing Vessel License ===

The Processing Vessel license is required for a player to participate in the Processing and Trading phase. Each license gives an additional draw bonus during trading.
{| class="wikitable" style="white-space:nowrap;"
|-
! Owned !! Bonus
|-
| Any
| May process and trade fish
|-
| 1
| +1 card from trade
|-
| 2
| +2 cards from trade
|-
| 3
| +3 cards from trade
|-
| 4
| +4 cards from trade
|}

=== Fishermen's Pub ===

The Fishermen's Pub is worth 10VP. It has NO boats or other bonuses.

=== King Crab License ===

There are three different King Crab licenses. Each gives a different bonus at the end of game worth up to 10VP.

* +1VP for every 3 fish crates on boats
* +1VP for each captain
* +VP for different license types. There are seven (7) types; all King Crab licenses count as the same type. See table:
{| class="wikitable" style="white-space:nowrap;"
|-
! Different
Licenses
! Bonus
|-
| 2
| +2VP
|-
| 3
| +4VP
|-
| 4
| +5VP
|-
| 5
| +6VP
|-
| 6
| +8VP
|-
| 7
| +10VP
|}

== Gone Fishin' ==

Gone Fishin' is an optional feature taken from the Fleet: Arctic Bounty expansion. It allows players to Go Fishin' instead of buying a license at auction. If a player passes the auction phase without buying a license they receive a Gone Fishin' card. These cards have a value of $2 for future purchases, but they are not boats and cannot captain. At the end of the game any Gone Fishin' cards still in a player's hand are worth +2VP.

The game designer recommends playing with Gone Fishin' enabled. It generally smooths out the game, especially in early rounds where money can be tight.

Stock

2020-06-23T21:43:07Z

Marcuda: Add noupdate param

{{Studio_Framework_Navigation}}

'''Stock''' is a javascript component that you can use in your game interface to display a set of elements of the same size that need to be arranged in single or multiple lines.

Stock is very flexible and is the most used component in BGA games.

Examples of stock use cases:

* Display a set of cards, typically hands (examples: ''Hearts'', ''Seasons'', ''The Boss'', ''Race for the Galaxy'').
* Display items in player panels (examples: ''Takenoko'', ''Amyitis'', ...)
* ... Many other situations. For example, black dice and cubes on cards in ''Troyes'' are displayed with stock components.

Using stock:

* Your items are arranged nicely and sorted by type.
* When adding or removing items to a set, all items slide smoothly to their new position in the set.
* Selecting and unselecting items are built-in functions.
* You don't have to worry about inserting/removing HTML code; the entire life cycle of the stock is managed by the component.

== Using stock: a simple example ==

Let's have a look on how the stock is used in the game ''Hearts'' to display a hand of standard cards.

First, don't forget to add "ebg/stock" as a dependency in your js file:

<pre>
define([
"dojo","dojo/_base/declare",
"ebg/core/gamegui",
"ebg/counter",
"ebg/stock" /// <==== HERE
],
</pre>

The stock is initialized in the Javascript "setup" method like this:

<pre>
// Player hand
this.playerHand = new ebg.stock();
this.playerHand.create( this, $('myhand'), this.cardwidth, this.cardheight );
</pre>

Explanations:
* We create a new stock object for the player hand.
* As parameters of the "create" method, we provide the width/height of an item (a card), and the div container "myhand" - which is a simple empty "div" element defined in our HTML template (.tpl).

Then, we must tell the stock what items it is going to display during its life: the 52 cards of a standard card game. Of course, we did not create 52 different images, but a "CSS sprite" image named "cards.jpg" with the cards arranged in 4 rows and 13 columns.

Here's how we tell stock what items to display:

<pre>
// Specify that there are 13 images per row in the CSS sprite image
this.playerHand.image_items_per_row = 13;

// Create card types:
for( var color=1;color<=4;color++ )
{
for( var value=2;value<=14;value++ )
{
// Build card type id
var card_type_id = this.getCardUniqueId( color, value );
this.playerHand.addItemType( card_type_id, card_type_id, g_gamethemeurl+'img/cards.jpg', card_type_id );
}
}
</pre>

Explanation:

* First, we tell the stock component that our CSS sprite contains 13 items per row. This way, it can find the correct image for each card type id.
* Then for the 4x13 cards, we call the "addItemType" method that creates the type. The arguments are the type id, the weight of the card (for sorting purpose), the URL of our CSS sprite, and the position of our card image in the CSS sprite.

Note: In this specific example we need to generate a unique ID for each type of card based on its color and value. This is the only purpose of "getCardUniqueId".

From now on, if we need to add a card - for example, the 5 of Hearts - to a player's hand, we can do this:

<pre>
this.playerHand.addToStock( this.getCardUniqueId( 2 /* 2=hearts */, 5 ) );
</pre>

In reality, cards have some IDs, which are useful to manipulate them. This is the reason we are using "addToStockWithId" instead:

<pre>
this.playerHand.addToStockWithId( this.getCardUniqueId( 2 /* 2=hearts */, 5 ), my_card_id );
</pre>

If afterwards we want to remove this card from the stock:

<pre>
this.playerHand.removeFromStockById( my_card_id );
</pre>

== Complete stock component reference ==

'''create( page, container_div, item_width, item_height ):'''

With create, you create a new stock component.

Parameters:
* page: the container page. Usually: "this".
* container_div: the container "div" element (a void div element in your template, with an id).
* width and height (in pixels) for the stock component.

(See ''Hearts'' example above).

'''count():'''

Return the total number of items in the stock right now.

'''addItemType( type, weight, image, image_position ):'''

Define a new type of item and add it to the stock.

This is mandatory to define a new item type before adding it to the stock. Example: if you want to have a stock contain cubes of 3 different colors, you must add 3 item types (one for each color).

Parameters:
* type: ID of the type to add. You can choose any positive integer. All item types must have distinct IDs.
* weight: weight of items of this type. Weight value is used to sort items of the stock during the display. Note that you can specify the same weight for all items; in this case, they are not sorted and their order might change randomly at any time.
* image: URL of item image. Most of the time, you will use a CSS sprite for stock items, so you have to specify CSS sprite image here.

Be careful: you must specify the image url as this:

<pre>
g_gamethemeurl+'img/yourimage.png'
</pre>

* image_position: if "image" specify the URL of a CSS sprite, you must specify the position of the item image in this CSS sprite. For example, if you have a CSS sprite with 3 cubes with a size of 20x20 pixels each (so your CSS image has for example a size of 20x60 or 60x20), you specify "0" for the first cube image, 1 for the second, 2 for the third.

''Important'': if there is more than one line of items in your CSS sprite, you must specify how many items per line you have in your CSS sprite like this:

<pre>
// Specify that there are 10 image items per row in images used in "myStockObject" control.
this.myStockObject.image_items_per_row = 10;
</pre>

'''addToStock( type, from )'''

Add an item to the stock, with the specified type, but without a unique ID.

To make your life easier, in most cases we suggest you use '''addToStockWithId''' in order to give an ID to the item added. '''addToStock''' is suitable when you are using a stock to control items that are generic game materials that don't need to be addressed individually (example: a bunch of money tokens).

Parameters:
* type: ID of the item type to use (as specified in "addItemType")
* from: OPTIONAL: if you specify an HTML item here, the item will appear on this item and will be slid to its position on the stock item.

Example:
<pre>
// Add a money token to the "player money" stock.
// The money token will appear on "player_id" player panel and will move to its position.
this.playerMoney.addToStock( MONEY_TOKEN, 'overall_player_board_'+player_id );
</pre>

Important: for a given stock control, you must use either '''addToStock''' or '''addToStockWithId''', but NEVER BOTH OF THEM.

'''addToStockWithId( type, id, from )'''

This is the same method as '''addToStock''', except that it also associates an ID with the newly created item.

This is especially useful:

* When you need to know which item(s) have been selected by the user (see '''getSelectedItems''').
* When you need to remove a specific item from the stock with '''removeFromStockById'''.

Important: for a given stock control, you must use either '''addToStock''' or '''addToStockWithId''', but NEVER BOTH OF THEM.

'''removeFromStock( type, to )'''

Remove an item of the specific type from the stock.

"to" is an optional parameter. If "to" contains the ID of an HTML element, the item removed from the stock is slided to this HTML element before it disappear.

'''removeFromStockById( id, to, noupdate )'''

Remove an item with a specific ID from the stock.

"to" is an optional parameter. If "to" contains the ID of an HTML element, the item removed from the stock is slided to this HTML element before it disappear.

"noupdate" is an optional parameter. If set to "true" it will prevent the stock display from changing. This is useful when multiple (but not all) items are removed at the same time, to avoid ghost items appearing briefly. Be sure to call '''updateDisplay''' after all items are removed.

'''removeAll()'''

Remove all items from the stock.

'''removeAllTo( to )'''

Remove all items from the stock. If "to" contains the ID of an HTML element, the item removed from the stock is slided to this HTML element before it disappear.

'''getPresentTypeList()'''

Return an array with all the types of items present in the stock right now.

Example:
<pre>
this.myStockControl.removeAll();
this.myStockControl.addToStock( 65 );
this.myStockControl.addToStock( 34 );
this.myStockControl.addToStock( 89 );
this.myStockControl.addToStock( 65 );

// The following returns: { 34:1, 65:1, 89:1 }
var item_types = this.myStockControl.getPresentTypeList();
</pre>

'''resetItemsPosition()'''

If you moved an item from the stock control manually (ex: after a drag'n'drop) and want to reset their positions to their original ones, you can call this method.

'''item_margin'''

By default, there is a margin of 5px between the items of a stock. You can change the member variable "item_margin" to change this.

Example:
<pre>
this.myStockControl.item_margin=5;
</pre>

'''changeItemsWeight( newWeights )'''

With this method you can change dynamically the weight of the item types in a stock control.

Items are immediately re-sorted with the new weight.

Example: with a stock control that contains classic cards, you can order them by value or by color. Using changeItemsWeight you can switch from one sort method to another when a player request this.

newWeights is an associative array: item type id => new weight.

Example:
<pre>
// Item type 1 gets a new weight of 10, 2 a new weight of 20, 3 a new weight of 30.
this.myStockControl.changeItemsWeight( { 1: 10, 2: 20, 3: 30 } );
</pre>

'''centerItems'''

Center the stock items in the middle of the stock container.
e.g. this.myStock.centerItems = true;

'''setSelectionMode( mode )'''

For each stock control, you can specify a selection mode:
* 0: no item can be selected by the player.
* 1: a maximum of one item can be selected by the player at a time.
* 2 (default): multiple items can be selected by the player at the same time.

'''setSelectionAppearance( type )'''

For each stock control, you can specify a selection highlighting type:
* 'border': there will be a red border around selected items (this is the default). The attribute 'apparenceBorderWidth' can be used to manage the width of the border (in pixels).
* 'disappear': the selected item will fade out and disappear. This is useful when the selection has the effect of destroying the item.
* 'class': there will be an extra '''stockitem_selected''' css class added to the element when it is selected (and removed when unselected). You can override this class in the css file for your game.

By default this class definition is:
<pre>
.stockitem_selected {
border: 2px solid red ! important;
}
</pre>

If you want to override it (for example, to change the border color) add this in your <game>.css file:
<pre>
.stockitem_selected {
border: 2px solid orange ! important;
}
</pre>

'''isSelected( id )'''

Return a boolean indicating whether the specified item id has been selected.

'''selectItem( id )'''

Select the specified item.

'''unselectItem( id )'''

Unselect the specified item.

'''unselectAll()'''

Unselect all items of the stock.

'''onChangeSelection'''

This callback method is called when the player selects/unselects an item of the stock.

You can connect this to one of your methods like this:

<pre>
dojo.connect( this.myStockControl, 'onChangeSelection', this, 'onMyMethodToCall' );

(...)

onMyMethodToCall: function( control_name, item_id )
{
// This method is called when myStockControl selected items changed
var items = this.myStockControl.getSelectedItems();

// (do something)
},
</pre>

Nota bene:
- The "control_name" argument is the ID (the "DOM" id) of the "div" container of your stock control. Using "control_name", you can use the same callback method for different Stock control and see which one trigger the method.
- The "item_id" argument is the stock ID (index) of the stock item that has just been selected/unselected.

'''getSelectedItems()'''

Return the list of selected items, as an array with the following format:
<pre>
[
{ type:1, id: 1001 },
{ type:1, id: 1002 },
{ type:3, id: 1003 }
...
]
</pre>

'''getUnselectedItems()'''

Same as the previous one, but return unselected item instead of seleted ones.

'''getAllItems()'''

Get all items (same format as getSelectedItems and getUnselectedItems).

'''getItemDivId(id)'''

Get the div id using the stock item id (to manipulate element properties directly).

'''getItemById(id)'''

Get the Stock item with the id in parameter
ex : return the object { type:1, id: 1001 }

'''setOverlap( horizontal_percent, vertical_percent )'''

Make items of the stock control "overlap" each other, to save space.

By default, horizontal_overlap and vertical_overlap are 0.

When horizontal_overlap=20, it means that a stock item will overlap to only show 20% of the width of all the previous items. horizontal_overlap can't be greater than 100.

vertical_overlap works differently: one items on two are shifted up.

See the games "Jaipur" or "Koryŏ" to see examples of use of this function.

'''onItemCreate'''

Using onItemCreate, you can trigger a method each time a new item is added to the Stock, in order to customize it.

Complete example:
<pre>
// During "setup" phase, we associate our method "setupNewCard" with the creation of a new stock item:
this.myStockItem.onItemCreate = dojo.hitch( this, 'setupNewCard' );

(...)

// And here is our "setupNewCard":
setupNewCard: function( card_div, card_type_id, card_id )
{
// Add a special tooltip on the card:
this.addTooltip( card_div.id, _("Some nice tooltip for this item"), '' );

// Note that "card_type_id" contains the type of the item, so you can do special actions depending on the item type

// Add some custom HTML content INSIDE the Stock item:
dojo.place( this.format_block( 'jstpl_my_card_content', {
....
} ), card_div.id );
}

</pre>

== Tips when adding/removing items to/from Stock components ==

Most cases will be one of the following situations:

'''Situation A''':

When you add a card to a stock item, and this card is '''not''' coming from another stock:

* Use '''addToStockWithId''' with a "from" argument set to the element of your interface where the card should come from.

'''Situation B''':

When you add a card to a stock item, and this card is coming from another stock:

* On the destination Stock, use '''addToStockWithId''' with a "from" argument which is the HTML id of the corresponding item in the source Stock. For example, if the source stock id is "myHand", then the HTML id of card 48 is "myHand_item_48".
* Then, remove the source item with '''removeFromStockById'''.

(Note that it's important to do things in this order, because the source item must still exist when you use it as the origin of the slide.)

'''Situation C''':

When you move a card from a stock item to something that is not a stock item:

* Insert the card as a classic HTML template (dojo.place / this.format_block).
* Place it on the Stock item with '''this.placeOnObject''', using the Stock item HTML id (see above).
* Slide it to its new position with '''this.slideToObject'''.
* Remove the card from the Stock item with '''removeFromStockById'''.

Using the methods above, your cards should slide to, from, and between your Stock controls smoothly.

You can customize this (showing the default value):
<pre>

this.mystock.jstpl_stock_item= "<div id=\"${id}\" class=\"stockitem\" style=\"top:${top}px;left:${left}px;width:${width}px;height:${height}px;z-index:${position};background-image:url('${image}');\"></div>";
</pre>
To produce a different type of stock item