/
stats.inc.php
95 lines (70 loc) · 3.42 KB
/
stats.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
<?php
/**
*------
* BGA framework: © Gregory Isabelli <gisabelli@boardgamearena.com> & Emmanuel Colin <ecolin@boardgamearena.com>
* MarcoPolo implementation : © <Your name here> <Your email address here>
*
* 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.
* -----
*
* stats.inc.php
*
* MarcoPolo game statistics description
*
*/
/*
In this file, you are describing game statistics, that will be displayed at the end of the
game.
!! After modifying this file, you must use "Reload statistics configuration" in BGA Studio backoffice
("Control Panel" / "Manage Game" / "Your Game")
There are 2 types of statistics:
_ table statistics, that are not associated to a specific player (ie: 1 value for each game).
_ player statistics, that are associated to each players (ie: 1 value for each player in the game).
Statistics types can be "int" for integer, "float" for floating point values, and "bool" for boolean
Once you defined your statistics there, you can start using "initStat", "setStat" and "incStat" method
in your game logic, using statistics names defined below.
!! It is not a good idea to modify this file when a game is running !!
If your game is already public on BGA, please read the following before any change:
http://en.doc.boardgamearena.com/Post-release_phase#Changes_that_breaks_the_games_in_progress
Notes:
* Statistic index is the reference used in setStat/incStat/initStat PHP method
* Statistic index must contains alphanumerical characters and no space. Example: 'turn_played'
* Statistics IDs must be >=10
* Two table statistics can't share the same ID, two player statistics can't share the same ID
* A table statistic can have the same ID than a player statistics
* Statistics ID is the reference used by BGA website. If you change the ID, you lost all historical statistic data. Do NOT re-use an ID of a deleted statistic
* Statistic name is the English description of the statistic as shown to players
*/
$stats_type = array(
// Statistics global to table
"table" => array(
"turns_number" => array("id"=> 10,
"name" => totranslate("Number of turns"),
"type" => "int" ),
/*
Examples:
"table_teststat1" => array( "id"=> 10,
"name" => totranslate("table test stat 1"),
"type" => "int" ),
"table_teststat2" => array( "id"=> 11,
"name" => totranslate("table test stat 2"),
"type" => "float" )
*/
),
// Statistics existing for each player
"player" => array(
"turns_number" => array("id"=> 10,
"name" => totranslate("Number of turns"),
"type" => "int" ),
/*
Examples:
"player_teststat1" => array( "id"=> 10,
"name" => totranslate("player test stat 1"),
"type" => "int" ),
"player_teststat2" => array( "id"=> 11,
"name" => totranslate("player test stat 2"),
"type" => "float" )
*/
)
);