Board Game Arena - Kullanıcı katkıları [tr]

Gamehelpnorthwestpassage

2013-06-02T10:38:27Z

Tirix:

'''''Looking for the Franklin Expedition'''''

''In 1845, Sir John Franklin led an expedition on behalf of the British Royal Navy to find and explore the last portion of the Northwest Passage. They sailed into unknown waters, and no-one ever heard from them again... Players must venture into these hazardous Arctic waters in order to discover Franklin’s fate and succeed where he failed: by finding the Northwest Passage.''

----

In the game, prestige is awarded for exploring islands and straits, getting information from Inuits or Cairns about the Franklin Expedition, finding shipwrecks of the expedition, and for being among the first to find their way up to the Northwest Passage and back to Groenland. The player with the most Prestige points at the end of the game is the winner. In case of a tie, the first tied player to have returned to Greenland is the winner.

== GAME CYCLE ==

The game is divided into ten rounds. At the end of each round, the solar disc moves, and part of the board above the sun freezes into ice or melts back to sea.

During one round, player will take up to 7 actions, in turn.

Actions can be taken either from the ship, using crewmen on the ship, or from the sled, using crewmen on the sled.

During one turn, one player can play one or more actions. However, '''all additional actions (beyond the first one) will cost one more crewman than normal'''. In order to stop playing more actions during one turn, click the blinking [End Turn] at the top of the screen.

At the end of the round, all used Crewmen move back to «Available».

The next turn order is the order in which players used their last crewmen (or passed). This is shown by the turn order markers at the top left of the board.

== ACTIONS ==

=== Draw a tile ===
''Cost: 1 Crewman''

<Click on the chosen tile at the top of the board.>

 

=== Refresh tiles and Draw ===
''Cost: 2 Crewmen''

<Click on the "Renew deck" icon.>

The player MUST:
# Refresh: all large tiles available on the board are replaced with four new tiles which are randomly drawn from the reserve. The replaced tiles are placed back into the reserve.
# Draw a tile: he takes either a large or a small Exploration tile and adds it to his personal reserve.
 

=== Place a tile ===
''Cost: 1 Crewman''

<Click on the tile from your hand, rotate it or flip it as fit, and click on the white marker on the board.>

The player places one tile on the board, which is taken from his personal reserve. He must meet the following conditions:
* The tile  must  be placed in line with the black grid on the board.
* The tile  must  be placed so that  at  least  one  side (long or large) must be flush with a tile on which the player has a presence (Ship or Sled, depending on which one executes this action).
* The land and sea areas of the newly-placed tile must correspond with all land and  sea tiles of adjacent tiles (both orthogonally and diagonally).
If, by placing a tile, a player creates a space the size of a small Exploration tile which is surrounded on all sides by tiles, a matching small Exploration tile is taken from the reserve and placed to fill the empty space.

An island is complete when the land areas of at least two tiles are completely surrounded by water or the edge of the board. In case a player completes one or several islands, he gets one Cartography token, and Prestige points according to the size of the island.

 

=== Transfer Crew ===
''Cost: 1 Crewman''

<Click on the back arrows on the player board>

Crewmen are moved from/to the ship/sled, thus deploying or taking back the sled into the ship. Taking back crewmen in the ship can only happen if the sled and ship are on the same tile. Both active and resting crewmen can be transferred.

 

=== Movement ===
''Cost: 1 Crewman''

<Click on the ship or sled, then on its destination.>

'''Ship Movement''': The player moves his ship onto one adjacent tile linked to the tile it currently occupies by a sea passage.

'''Sled Movement''': The player moves his sled onto one adjacent tile linked to the one it currently occupies by a land passage. The Sled cannot cross the sea unless it is frozen.

Multiple Ships and Sleds can be on the same tile.

A frozen tile is unreachable for a ship. If a ship, due to a season change, finds itself in frozen waters, the ship is blocked in and will not be able to move until the thaw. A frozen tile is considered to be entirely composed of land, so a Sled can move freely on it.

 

=== Explore a Franklin site or a Strait ===
''Cost: 3 Crewmen''

<Click on the bonus chip.>

1 prestige point is awarded for the discovery multiplied by the zone multiplier (x1 / x2 / x3), and additionally, points are awarded at the end of the game for the players having the most bonuses of a given type (see tooltip).

 

=== Discover an Inuit or a Cairn ===
''Cost: 2 Crewmen''

<Click on the bonus chip.>

2 prestige point is awarded for the discovery multiplied by the zone multiplier (x1 / x2 / x3).

 

=== Pass ===
A player can choose to Pass and take no action during his turn, even if he still has available Crewmen. In this case, the player cannot take any more actions during this round.
If a player has no available Crewmen, he automatically passes.

== END OF THE GAME ==

The game ends either: at the end of the Action Phase of the tenth round or if all of the Expeditions have returned to Greenland.

In addition to the point earned during the game, players receive more Prestige points based on the tokens they picked up along the way.

==== Exploration Points: ====
Point are awarded to the player(s) with the most, second most, and third most Shipwrecks, Straits, and Cartography tokens (see tooltips for scoring).

==== Set Points: ====
Each set is composed of one token of each Discovery type – one Inuit, one Cairn, one Shipwreck, one Strait, and one Cartography token. Each set gives a bonus of 6 prestige points.

==== Abandonment Penalty: ====
Each Sled and/or Ship which did not return to Greenland before the end of the tenth Exploration season is lost. When a Ship or a Sled is lost, all of the crewmen in the corresponding column are lost with it.
Every lost Ship and/or Sled gives a penalty of -2 Prestige points for each corresponding lost Crewman. An abandoned ship gives a penalty of -2 Prestige points.

Gamehelpnorthwestpassage

2013-06-02T04:00:04Z

Tirix: Mentioned additional crewman cost for addititional actions

'''''Looking for the Franklin Expedition'''''

''In 1845, Sir John Franklin led an expedition on behalf of the British Royal Navy to find and explore the last portion of the Northwest Passage. They sailed into unknown waters, and no-one ever heard from them again... Players must venture into these hazardous Arctic waters in order to discover Franklin’s fate and succeed where he failed: by finding the Northwest Passage.''

----

In the game, prestige is awarded for exploring islands and straits, getting information from Inuits or Cairns about the Franklin Expedition, finding shipwrecks of the expedition, and for being among the first to find their way up to the Northwest Passage and back to Groenland. The player with the most Prestige points at the end of the game is the winner. In case of a tie, the first tied player to have returned to Greenland is the winner.

== GAME CYCLE ==

The game is divided into ten rounds. At the end of each round, the solar disc moves, and part of the board above the sun freezes into ice or melts back to sea.

During one round, player will take up to 7 actions, in turn.

Actions can be taken either from the ship, using crewmen on the ship, or from the sled, using crewmen on the sled.

During one turn, one player can play one or more actions. However, '''all additional actions (beyond the first one) will cost one more crewman than normal'''. In order to stop playing more actions during one turn, click the blincking [End Turn] at the top of the screen.

At the end of the round, all used Crewmen move back to «Available».

The next turn order is the order in which players used their last crewmen (or passed). This is shown by the turn order markers at the top left of the board.

== ACTIONS ==

=== Draw a tile ===
''Cost: 1 Crewman''

<Click on the chosen tile at the top of the board.>

 

=== Refresh tiles and Draw ===
''Cost: 2 Crewmen''

<Click on the "Renew deck" icon.>

The player MUST:
# Refresh: all large tiles available on the board are replaced with four new tiles which are randomly drawn from the reserve. The replaced tiles are placed back into the reserve.
# Draw a tile: he takes either a large or a small Exploration tile and adds it to his personal reserve.
 

=== Place a tile ===
''Cost: 1 Crewman''

<Click on the tile from your hand, rotate it or flip it as fit, and click on the white marker on the board.>

The player places one tile on the board, which is taken from his personal reserve. He must meet the following conditions:
* The tile  must  be placed in line with the black grid on the board.
* The tile  must  be placed so that  at  least  one  side (long or large) must be flush with a tile on which the player has a presence (Ship or Sled, depending on which one executes this action).
* The land and sea areas of the newly-placed tile must correspond with all land and  sea tiles of adjacent tiles (both orthogonally and diagonally).
If, by placing a tile, a player creates a space the size of a small Exploration tile which is surrounded on all sides by tiles, a matching small Exploration tile is taken from the reserve and placed to fill the empty space.

An island is complete when the land areas of at least two tiles are completely surrounded by water or the edge of the board. In case a player completes one or several islands, he gets one Cartography token, and Prestige points according to the size of the island.

 

=== Transfer Crew ===
''Cost: 1 Crewman''

<Click on the back arrows on the player board>

Crewmen are moved from/to the ship/sled, thus deploying or taking back the sled into the ship. Taking back crewmen in the ship can only happen if the sled and ship are on the same tile. Both active and resting crewmen can be transferred.

 

=== Movement ===
''Cost: 1 Crewman''

<Click on the ship or sled, then on its destination.>

'''Ship Movement''': The player moves his ship onto one adjacent tile linked to the tile it currently occupies by a sea passage.

'''Sled Movement''': The player moves his sled onto one adjacent tile linked to the one it currently occupies by a land passage. The Sled cannot cross the sea unless it is frozen.

Multiple Ships and Sleds can be on the same tile.

A frozen tile is unreachable for a ship. If a ship, due to a season change, finds itself in frozen waters, the ship is blocked in and will not be able to move until the thaw. A frozen tile is considered to be entirely composed of land, so a Sled can move freely on it.

 

=== Explore a Franklin site or a Strait ===
''Cost: 3 Crewmen''

<Click on the bonus chip.>

1 prestige point is awarded for the discovery multiplied by the zone multiplier (x1 / x2 / x3), and additionally, points are awarded at the end of the game for the players having the most bonuses of a given type (see tooltip).

 

=== Discover an Inuit or a Cairn ===
''Cost: 2 Crewmen''

<Click on the bonus chip.>

2 prestige point is awarded for the discovery multiplied by the zone multiplier (x1 / x2 / x3).

 

=== Pass ===
A player can choose to Pass and take no action during his turn, even if he still has available Crewmen. In this case, the player cannot take any more actions during this round.
If a player has no available Crewmen, he automatically passes.

== END OF THE GAME ==

The game ends either: at the end of the Action Phase of the tenth round or if all of the Expeditions have returned to Greenland.

In addition to the point earned during the game, players receive more Prestige points based on the tokens they picked up along the way.

==== Exploration Points: ====
Point are awarded to the player(s) with the most, second most, and third most Shipwrecks, Straits, and Cartography tokens (see tooltips for scoring).

==== Set Points: ====
Each set is composed of one token of each Discovery type – one Inuit, one Cairn, one Shipwreck, one Strait, and one Cartography token. Each set gives a bonus of 6 prestige points.

==== Abandonment Penalty: ====
Each Sled and/or Ship which did not return to Greenland before the end of the tenth Exploration season is lost. When a Ship or a Sled is lost, all of the crewmen in the corresponding column are lost with it.
Every lost Ship and/or Sled gives a penalty of -2 Prestige points for each corresponding lost Crewman. An abandoned ship gives a penalty of -2 Prestige points.

Gamehelpnorthwestpassage

2013-05-25T11:12:01Z

Tirix: Completed action description

'''''Looking for the Franklin Expedition'''''

''In 1845, Sir John Franklin led an expedition on behalf of the British Royal Navy to find and explore the last portion of the Northwest Passage. They sailed into unknown waters, and no-one ever heard from them again... Players must venture into these hazardous Arctic waters in order to discover Franklin’s fate and succeed where he failed: by finding the Northwest Passage.''

----

In the game, prestige is awarded for exploring islands and straits, getting information from Inuits or Cairns about the Franklin Expedition, finding shipwrecks of the expedition, and for being among the first to find their way up to the Northwest Passage and back to Groenland. The player with the most Prestige points at the end of the game is the winner. In case of a tie, the first tied player to have returned to Greenland is the winner.

== GAME CYCLE ==

The game is divided into ten rounds. At the end of each round, the solar disc moves, and part of the board above the sun freezes into ice or melts back to sea.

During one round, player will take up to 7 actions, in turn.

Actions can be taken either from the ship, using crewmen on the ship, or from the sled, using crewmen on the sled.

At the end of the round, all used Crewmen move back to «Available».

The next turn order is the order in which players used their last crewmen (or passed). This is shown by the turn order markers at the top left of the board.

== ACTIONS ==

=== Draw a tile ===
''Cost: 1 Crewman''

<Click on the chosen tile at the top of the board.>

 

=== Refresh tiles and Draw ===
''Cost: 2 Crewmen''

<Click on the "Renew deck" icon.>

The player MUST:
# Refresh: all large tiles available on the board are replaced with four new tiles which are randomly drawn from the reserve. The replaced tiles are placed back into the reserve.
# Draw a tile: he takes either a large or a small Exploration tile and adds it to his personal reserve.
 

=== Place a tile ===
''Cost: 1 Crewman''

<Click on the tile from your hand, rotate it or flip it as fit, and click on the white marker on the board.>

The player places one tile on the board, which is taken from his personal reserve. He must meet the following conditions:
* The tile  must  be placed in line with the black grid on the board.
* The tile  must  be placed so that  at  least  one  side (long or large) must be flush with a tile on which the player has a presence (Ship or Sled, depending on which one executes this action).
* The land and sea areas of the newly-placed tile must correspond with all land and  sea tiles of adjacent tiles (both orthogonally and diagonally).
If, by placing a tile, a player creates a space the size of a small Exploration tile which is surrounded on all sides by tiles, a matching small Exploration tile is taken from the reserve and placed to fill the empty space.

An island is complete when the land areas of at least two tiles are completely surrounded by water or the edge of the board. In case a player completes one or several islands, he gets one Cartography token, and Prestige points according to the size of the island.

 

=== Transfer Crew ===
''Cost: 1 Crewman''

<Click on the back arrows on the player board>

Crewmen are moved from/to the ship/sled, thus deploying or taking back the sled into the ship. Taking back crewmen in the ship can only happen if the sled and ship are on the same tile. Both active and resting crewmen can be transferred.

 

=== Movement ===
''Cost: 1 Crewman''

<Click on the ship or sled, then on its destination.>

'''Ship Movement''': The player moves his ship onto one adjacent tile linked to the tile it currently occupies by a sea passage.

'''Sled Movement''': The player moves his sled onto one adjacent tile linked to the one it currently occupies by a land passage. The Sled cannot cross the sea unless it is frozen.

Multiple Ships and Sleds can be on the same tile.

A frozen tile is unreachable for a ship. If a ship, due to a season change, finds itself in frozen waters, the ship is blocked in and will not be able to move until the thaw. A frozen tile is considered to be entirely composed of land, so a Sled can move freely on it.

 

=== Explore a Franklin site or a Strait ===
''Cost: 3 Crewmen''

<Click on the bonus chip.>

1 prestige point is awarded for the discovery multiplied by the zone multiplier (x1 / x2 / x3), and additionally, points are awarded at the end of the game for the players having the most bonuses of a given type (see tooltip).

 

=== Discover an Inuit or a Cairn ===
''Cost: 2 Crewmen''

<Click on the bonus chip.>

2 prestige point is awarded for the discovery multiplied by the zone multiplier (x1 / x2 / x3).

 

=== Pass ===
A player can choose to Pass and take no action during his turn, even if he still has available Crewmen. In this case, the player cannot take any more actions during this round.
If a player has no available Crewmen, he automatically passes.

== END OF THE GAME ==

The game ends either: at the end of the Action Phase of the tenth round or if all of the Expeditions have returned to Greenland.

In addition to the point earned during the game, players receive more Prestige points based on the tokens they picked up along the way.

==== Exploration Points: ====
Point are awarded to the player(s) with the most, second most, and third most Shipwrecks, Straits, and Cartography tokens (see tooltips for scoring).

==== Set Points: ====
Each set is composed of one token of each Discovery type – one Inuit, one Cairn, one Shipwreck, one Strait, and one Cartography token. Each set gives a bonus of 6 prestige points.

==== Abandonment Penalty: ====
Each Sled and/or Ship which did not return to Greenland before the end of the tenth Exploration season is lost. When a Ship or a Sled is lost, all of the crewmen in the corresponding column are lost with it.
Every lost Ship and/or Sled gives a penalty of -2 Prestige points for each corresponding lost Crewman. An abandoned ship gives a penalty of -2 Prestige points.

Gamehelpnorthwestpassage

2013-05-13T16:48:33Z

Tirix: Early version

'''''Looking for the Franklin Expedition'''''

''In 1845, Sir John Franklin led an expedition on behalf of the British Royal Navy to find and explore the last portion of the Northwest Passage. They sailed into unknown waters, and no-one ever heard from them again... Players must venture into these hazardous Arctic waters in order to discover Franklin’s fate and succeed where he failed: by finding the Northwest Passage.''

----

In the game, prestige is awarded for exploring islands and straits, getting information from Inuits or Cairns about the Franklin Expedition, finding shipwrecks of the expedition, and for being among the first to find their way up to the Northwest Passage and back to Groenland. The player with the most Prestige points at the end of the game is the winner. In case of a tie, the first tied player to have returned to Greenland is the winner.

== GAME CYCLE ==

The game is divided into ten rounds. At the end of each round, the solar disc moves, and part of the board above the sun freezes into ice or melts back to sea.

During one round, player will take up to 7 actions, in turn.

Actions can be taken either from the ship, using crewmen on the ship, or from the sled, using crewmen on the sled.

On the player board,
:Ship: 1/2 - Sled: 3/5
means for example that there are two crewmen on the ship and five on the sled, and that one crewman is available (out of two) on the ship, and three crewmen (out of five) are available on the sled.

At the end of the round, all used Crewmen move back to «Available».

The next turn order is the order in which players used their last crewmen (or passed). This is shown by the turn order markers at the top left of the board.

== ACTIONS ==

=== Draw a tile ===
''Cost: 1 Crewman''

<Click on the chosen tile at the top of the board.>

The player chooses either :
* ONE large exploration tiles, chosen from the four available.
* ONE small exploration tile, chosen from among the six available.
 

=== Refresh tiles and Draw ===
''Cost: 2 Crewmen''

<Click on the "Renew deck" icon.>

The player MUST:
# Refresh: all large tiles available on the board are replaced with four new tiles which are randomly drawn from the reserve. The replaced tiles are placed back into the reserve.
# Draw a tile: he takes either a large or a small Exploration tile and adds it to his personal reserve.
 

=== Place a tile ===
''Cost: 1 Crewman''

<Click on the tile from your hand, rotate it or flip it as fit, and click on the white marker on the board.>

The player places one tile on the board, which is taken from his personal reserve. He must meet the following conditions:
* The tile  must  be placed in line with the black grid on the board.
* The tile  must  be placed so that  at  least  one  side (long or large) must be flush with a tile on which the player has a presence (Ship or Sled, depending on which one executes this action).
* The land and sea areas of the newly-placed tile must correspond with all land and  sea tiles of adjacent tiles (both orthogonally and diagonally).
If, by placing a tile, a player creates a space the size of a small Exploration tile which is surrounded on all sides by tiles, a matching small Exploration tile is taken from the reserve and placed to fill the empty space.

An island is complete when the land areas of at least two tiles are completely surrounded by water or the edge of the board. In case a player completes one or several islands, he gets one Cartography token, and Prestige points according to the size of the island.

 

=== Transfer Crew ===
''Cost: 1 Crewman''

 

=== Movement ===
''Cost: 1 Crewman''

<Click on the ship or sled, then on its destination.>

'''Ship Movement''': The player moves his ship onto one adjacent tile linked to the tile it currently occupies by a sea passage.

'''Sled Movement''': The player moves his sled onto one adjacent tile linked to the one it currently occupies by a land passage. The Sled cannot cross the sea unless it is frozen.

Multiple Ships and Sleds can be on the same tile.

A frozen tile is unreachable for a ship. If a ship, due to a season change, finds itself in frozen waters, the ship is blocked in and will not be able to move until the thaw. A frozen tile is considered to be entirely composed of land, so a Sled can move freely on it.

 

=== Explore a Franklin site or a Strait ===
''Cost: 3 Crewmen''

<Click on the ship or sled, then on its destination.>

 

=== Discover an Inuit or a Cairn ===
''Cost: 2 Crewmen''

<Click on the ship or sled, then on its destination.>

 

=== Pass ===
A player can choose to Pass and take no action during his turn, even if he still has available Crewmen. In this case, the player cannot take any more actions during this round.
If a player has no available Crewmen, he automatically passes.

== END OF THE GAME ==

The game ends either: at the end of the Action Phase of the tenth round or if all of the Expeditions have returned to Greenland.

In addition to the point earned during the game, players receive more Prestige points based on the tokens they picked up along the way.

==== Exploration Points: ====
Point are awarded to the player(s) with the most, second most, and third most Shipwrecks, Straits, and Cartography tokens (see tooltips for scoring).

==== Set Points: ====
Each set is composed of one token of each Discovery type – one Inuit, one Cairn, one Shipwreck, one Strait, and one Cartography token. Each set gives a bonus of 6 prestige points.

==== Abandonment Penalty: ====
Each Sled and/or Ship which did not return to Greenland before the end of the tenth Exploration season is lost. When a Ship or a Sled is lost, all of the crewmen in the corresponding column are lost with it.
Every lost Ship and/or Sled gives a penalty of -2 Prestige points for each corresponding lost Crewman. An abandoned ship gives a penalty of -2 Prestige points.

Your game state machine: states.inc.php

2013-03-23T10:33:02Z

Tirix: Corrected 'arg'=>'args'

This file describes the game states machine of your game (all the game states properties, and the transitions to get from one state to another).

Important: to understand the game state machine, the best is to read this presentation first:

[http://www.slideshare.net/boardgamearena/bga-studio-focus-on-bga-game-state-machine Focus on BGA game state machine]

== Overall structure ==

The machine states is described by a PHP associative array.

Example:

<pre>
$machinestates = array(

// The initial state. Please do not modify.
1 => array(
"name" => "gameSetup",
"description" => clienttranslate("Game setup"),
"type" => "manager",
"action" => "stGameSetup",
"transitions" => array( "" => 2 )
),

// Note: ID=2 => your first state

2 => array(
"name" => "playerTurn",
"description" => clienttranslate('${actplayer} must play a card or pass'),
"descriptionmyturn" => clienttranslate('${you} must play a card or pass'),
"type" => "activeplayer",
"possibleactions" => array( "playCard", "pass" ),
"transitions" => array( "playCard" => 2, "pass" => 2 )
),
</pre>

== Syntax ==

=== id ===

The keys determine game states IDs (in the example above: 1 and 2).

IDs must be positive integers.

ID=1 is reserved for the first game state and should not be used (and you must not modify it).

ID=99 is reserved for the last game state of the game (end of the game) (and you must not modify it).

Note: you may use any ID, even ID greater than 100. But you cannot use 1 and 99.

Note²: You can't of course use the same ID twice.

=== name ===

(mandatory)

The name of a game state is used to identify it in your game logic.

Several game states can share the same name, however this is not recommended.

PHP example:
<pre>

// Get current game state
$state = $this->gamestate->state();
if( $state['name'] == 'myGameState' )
{
...
}

</pre>

JS example:
<pre>
onEnteringState: function( stateName, args )
{
console.log( 'Entering state: '+stateName );

switch( stateName )
case 'myGameState':

// Do some stuff at the beginning at this game state
....

break;
</pre>

=== type ===

(mandatory)

You can use 3 types of game states:
* activeplayer (1 player is active and must play)
* multipleactiveplayer (1..N players can be active and must play)
* game (no player is active. This is a transitional state to do something automatic specified by game rules)

=== description ===

(mandatory)

The description is the string that is displayed in the main action bar (top of the screen) when the state is active.

When a string is specified as a description, you must use "clienttranslate" in order the string can be translate on the client side:

<pre>
"description" => clienttranslate('${actplayer} must play a card or pass'),
</pre>

In the description string, you can use ${actplayer} to refer to the active player.

You can also use custom arguments in your description. These custom arguments correspond to values returned by your "args" PHP method (see below "args" field).

Example of custom field:
<pre>

In states.inc.php:
"description" => clienttranslate('${actplayer} must choose ${nbr} identical energies'),
"args" => "argMyArgumentMethod"

In mygame.game.php:
function argMyArgumentMethod()
{
return array(
'nbr' => 2 // In this case ${nbr} in the description will be replaced by "2"
);
}
</pre>

Note: You may specify an empty string ("") here if it never happens that the game remains in this state (ie: if this state immediately jump to another state when activated).

Note²: Usually, you specify a string for "activeplayer" and "multipleactiveplayer" game states, and you specify an empty string for "game" game states. BUT, if you are using synchronous notifications, the client can remains few seconds on a "game" type game state, and in this case this may be useful to display a description in the status bar during this state.

=== descriptionmyturn ===

(mandatory for "activeplayer" and "multipleactiveplayer" game states type)

"descriptionmyturn" has exactly the same role and properties than "description", except that this value is displayed to the current active player - or to all active players in case of a multipleactiveplayer game state.

In general, we have this situation:

<pre>
"description" => clienttranslate('${actplayer} can take some actions'),
"descriptionmyturn" => clienttranslate('${you} can take some actions'),
</pre>

Note: you can use ${you} in description my turn in order the description can display "You" instead of the name of the player.

=== action ===

(mandatory for "game" game state type)

"action" specify a PHP method to call when entering into this game state.

Example:
<pre>
In states.inc.php:
28 => array(
"name" => "startPlayerTurn",
"description" => '',
"type" => "game",
"action" => "stStartPlayerTurn",

In mygame.game.php:
function stStartPlayerTurn()
{
// ... do something at the beginning of this game state
</pre>

Usually, for "game" game state type, the action method is used to do some automatic stuff specified by the rules (ex: check victory conditions, deal cards for a new round, go to the next player...) and then jump to another game state.

Note: a BGA convention specify that PHP method called with "action" are prefixed by "st".

=== transitions ===

(mandatory)

With "transition" you specify in which game state you can jump from a given game state.

Example:
<pre>
25 => array(
"name" => "myGameState",
"transitions" => array( "nextPlayer" => 27, "endRound" => 39 ),
....
}
</pre>

In the example above, if "myGameState" is the current active game state, I can jump to game state with ID 27, or game state with ID 39.

Example to jump to ID 27:
<pre>
In mygame.game.php:
$this->gamestate->nextState( "nextPlayer" );
</pre>

Important: "nextPlayer" is the name of the transition, and NOT the name of the target game state. Several transitions can lead to the same game state.

Note: if you have only 1 transition, you may give it an empty name.

Example:
<pre>
In states.inc.php:
"transitions" => array( "" => 27 ),

In mygame.game.php:
$this->gamestate->nextState( ); // We don't need to specify a transition as there is only one here
</pre>

=== possibleactions ===

(mandatory for "activeplayer" and "multipleactiveplayer" game states)

"possibleactions" defines the actions possible by the players at this game state.

By defining "possibleactions", you make sure players can't do actions that they are not allowed to do at this game states.

Example:

<pre>
In states.game.php:
"possibleactions" => array( "playCard", "pass" ),

In mygame.game.php:
function playCard( ...)
{
self::checkAction( "playCard" ); // Will failed if "playCard" is not specified in "possibleactions" in current game state.

....

In mygame.js:
playCard: function( ... )
{
if( this.checkAction( "playCard" ) ) // Will failed if "playCard" is not specified in "possibleactions" in current game state.
{ return ; }

....

</pre>

=== args ===

(optional)

From time to time, it happens that you need some information on the client side (ie : for your game interface) only for a specific game state.

Example 1 : for Reversi, the list of possible moves during playerTurn state.
Example 2 : in Caylus, the number of remaining king's favor to choose in the state where the player is choosing a favor.
Example 3 : in Can't stop, the list of possible die combination to be displayed to the active player in order he can choose among them.

In such a situation, you can specify a method name as the « args » argument for your game state. This method must get some piece of information about the game (ex : for Reversi, the possible moves) and return them.

Thus, this data can be transmitted to the clients and used by the clients to display it.

Let's see a complete example using args with « Reversi » game :

In states.inc.php, we specify some « args » argument for gamestate « playerTurn » :
<pre>
10 => array(
"name" => "placeWorkers",
"description" => clienttranslate('${actplayer} must place some workers'),
"descriptionmyturn" => clienttranslate('${you} must place some workers'),
"type" => "activeplayer",
"args" => "argPlaceWorkers", <================================== HERE
"possibleactions" => array( "placeWorkers" ),
"transitions" => array( "nextPlayer" => 11, "nextPhase" => 12, "zombiePass" => 11 )
),
</pre>

It corresponds to a « argPlaceWorkers » method in our PHP code (reversi.game.php):
<pre>
function argPlayerTurn()
{
return array(
'possibleMoves' => self::getPossibleMoves()
);
}
</pre>

Then, when we enter into « playerTurn » game state on the client side, we can highlight the possible moves on the board using information returned by argPlayerTurn :

<pre>
onEnteringState: function( stateName, args )
{
console.log( 'Entering state: '+stateName );

switch( stateName )
{
case 'playerTurn':
this.updatePossibleMoves( args.args.possibleMoves );
break;
}
},
</pre>

Note: you can also used values returned by your "args" method to have some custom values in your "description"/"descriptionmyturn" (see above).

Note: as a BGA convention, PHP methods called with "args" are prefixed by "arg" (ex: argPlayerTurn).

=== updateGameProgression ===

(optional)

IF you specify "updateGameProgression => true" in a game state, your "getGameProgression" PHP method will be called at the beginning of this game state - and thus the game progression of the game will be updated.

At least one of your game state (any of them) must specify updateGameProgression=>true.