/
states.inc.php
186 lines (159 loc) · 6.83 KB
/
states.inc.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
<?php
/**
*------
* BGA framework: © Gregory Isabelli <gisabelli@boardgamearena.com> & Emmanuel Colin <ecolin@boardgamearena.com>
* aknile implementation : © Andrew Kerrison <adesignforlife@gmail.com>
*
* This code has been produced on the BGA studio platform for use on http://boardgamearena.com.
* See http://en.boardgamearena.com/#!doc/Studio for more information.
* -----
*
* states.inc.php
*
* aknile game states description
*
*/
/*
Game state machine is a tool used to facilitate game developpement by doing common stuff that can be set up
in a very easy way from this configuration file.
Please check the BGA Studio presentation about game state to understand this, and associated documentation.
Summary:
States types:
_ activeplayer: in this type of state, we expect some action from the active player.
_ multipleactiveplayer: in this type of state, we expect some action from multiple players (the active players)
_ game: this is an intermediary state where we don't expect any actions from players. Your game logic must decide what is the next game state.
_ manager: special type for initial and final state
Arguments of game states:
_ name: the name of the GameState, in order you can recognize it on your own code.
_ description: the description of the current game state is always displayed in the action status bar on
the top of the game. Most of the time this is useless for game state with "game" type.
_ descriptionmyturn: the description of the current game state when it's your turn.
_ type: defines the type of game states (activeplayer / multipleactiveplayer / game / manager)
_ action: name of the method to call when this game state become the current game state. Usually, the
action method is prefixed by "st" (ex: "stMyGameStateName").
_ possibleactions: array that specify possible player actions on this step. It allows you to use "checkAction"
method on both client side (Javacript: this.checkAction) and server side (PHP: self::checkAction).
_ transitions: the transitions are the possible paths to go from a game state to another. You must name
transitions in order to use transition names in "nextState" PHP method, and use IDs to
specify the next game state for each transition.
_ args: name of the method to call to retrieve arguments for this gamestate. Arguments are sent to the
client side to be used on "onEnteringState" or to set arguments in the gamestate description.
_ updateGameProgression: when specified, the game progression is updated (=> call to your getGameProgression
method).
*/
// !! It is not a good idea to modify this file when a game is running !!
$machinestates = array(
// The initial state. Please do not modify.
1 => array(
"name" => "gameSetup",
"description" => clienttranslate("Game setup"),
"type" => "manager",
"action" => "stGameSetup",
"transitions" => array( "" => 2 )
),
2 => array(
"name" => "flood",
"type" => "game",
"action" => "stFlood",
"updateGameProgression" => true,
"transitions" => array( "plague" => 3, "speculationPlague" => 4, "harvest" => 5, "gameEnd" => 90 ) //end game if no cards to draw
),
3 => array(
"name" => "floodPlague",
"type" => "game",
"action" => "stPlague",
"updateGameProgression" => true,
"transitions" => array("" => 2)
),
4 => array(
"name" => "speculationPlague",
"type" => "game",
"action" => "stPlague",
"updateGameProgression" => true,
"transitions" => array("" => 5) //continue to harvest
),
5 => array(
"name" => "harvest",
"type" => "game",
"action" => "stHarvest",
"updateGameProgression" => true,
"transitions" => array( "playerTrade" => 10, "gameEnd" => 90 ) //game ends if flood drew last card
),
10 => array(
"name" => "playerTrade",
"description" => clienttranslate('${actplayer} must trade or pass'),
"descriptionmyturn" => clienttranslate('${you} must trade or pass'),
"type" => "activeplayer",
"possibleactions" => array( "market", "offering", "pass", "zombiePass" ),
"updateGameProgression" => true,
"transitions" => array( "plague" => 13, "market" => 10, "offering" => 2, "pass" => 15, "zombiePass" => 15, "gameEnd" => 90 ) //game ends if cards are exhausted
),
13 => array(
"name" => "marketCardPlague",
"type" => "game",
"action" => "stPlague",
"transitions" => array("" => 10)
),
15 => array(
"name" => "playerPlantOrSpeculate",
"description" => clienttranslate('${actplayer} must plant or speculate'),
"descriptionmyturn" => clienttranslate('${you} must plant or speculate'),
"type" => "activeplayer",
"possibleactions" => array( "back", "plant", "speculate", "pass", "zombiePass" ),
"transitions" => array( "back" => 10, "plant" => 20, "speculate" => 20, "pass" => 20, "zombiePass" => 20 )
),
20 => array(
"name" => "drawCards",
"type" => "game",
"action" => "stDrawCards",
"transitions" => array("plague" => 22, "nextPlayer" => 25, "gameEnd" => 90 ) //game ends if cards are exhausted
),
22 => array(
"name" => "drawCardPlague",
"type" => "game",
"action" => "stPlague",
"transitions" => array("" => 25)
),
25 => array(
"name" => "nextPlayer",
"type" => "game",
"action" => "stNextPlayer",
"updateGameProgression" => true,
"transitions" => array( "" => 2 )
),
90 => array(
"name" => "gameEndScoring",
"type" => "game",
"action" => "stGameEndScoring",
"updateGameProgression" => true,
"transitions" => array( "" => 99 )
),
/*
Examples:
2 => array(
"name" => "nextPlayer",
"description" => '',
"type" => "game",
"action" => "stNextPlayer",
"updateGameProgression" => true,
"transitions" => array( "endGame" => 99, "nextPlayer" => 10 )
),
10 => 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 )
),
*/
// Final state.
// Please do not modify.
99 => array(
"name" => "gameEnd",
"description" => clienttranslate("End of game"),
"type" => "manager",
"action" => "stGameEnd",
"args" => "argGameEnd"
)
);