Worldmap now supports an additional level sprite action that indicates completion...
[supertux.git] / src / supertux / statistics.cpp
1 //  SuperTux (Statistics module)
2 //  Copyright (C) 2004 Ricardo Cruz <rick2@aeiou.pt>
3 //  Copyright (C) 2006 Ondrej Hosek <ondra.hosek@gmail.com>
4 //  Copyright (C) 2006 Christoph Sommer <christoph.sommer@2006.expires.deltadevelopment.de>
5 //
6 //  This program is free software: you can redistribute it and/or modify
7 //  it under the terms of the GNU General Public License as published by
8 //  the Free Software Foundation, either version 3 of the License, or
9 //  (at your option) any later version.
10 //
11 //  This program is distributed in the hope that it will be useful,
12 //  but WITHOUT ANY WARRANTY; without even the implied warranty of
13 //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14 //  GNU General Public License for more details.
15 //
16 //  You should have received a copy of the GNU General Public License
17 //  along with this program.  If not, see <http://www.gnu.org/licenses/>.
18
19 #include "supertux/statistics.hpp"
20
21 #include <iomanip>
22 #include <limits>
23
24 #include "scripting/squirrel_util.hpp"
25 #include "supertux/globals.hpp"
26 #include "supertux/resources.hpp"
27 #include "util/gettext.hpp"
28 #include "video/drawing_context.hpp"
29
30 namespace {
31 const int nv_coins = std::numeric_limits<int>::min();
32 const int nv_badguys = std::numeric_limits<int>::min();
33 const float nv_time = std::numeric_limits<float>::max();
34 const int nv_secrets = std::numeric_limits<int>::min();
35 }
36
37 float WMAP_INFO_LEFT_X;
38 float WMAP_INFO_RIGHT_X;
39 float WMAP_INFO_TOP_Y1;
40 float WMAP_INFO_TOP_Y2;
41
42 Statistics::Statistics() : 
43   coins(nv_coins), 
44   total_coins(nv_coins), 
45   badguys(nv_badguys), 
46   total_badguys(nv_badguys), 
47   time(nv_time), 
48   secrets(nv_secrets), 
49   total_secrets(nv_secrets), 
50   valid(true) 
51 {
52   WMAP_INFO_LEFT_X = (SCREEN_WIDTH/2 + 80) + 32;
53   WMAP_INFO_RIGHT_X = SCREEN_WIDTH/2 + 368;
54   WMAP_INFO_TOP_Y1 = SCREEN_HEIGHT/2 + 172 - 16;
55   WMAP_INFO_TOP_Y2 = SCREEN_HEIGHT/2 + 172;
56 }
57
58 Statistics::~Statistics()
59 {
60 }
61
62 void
63 Statistics::serialize_to_squirrel(HSQUIRRELVM vm)
64 {
65   // TODO: there's some bug in the unserialization routines that breaks stuff when an empty statistics table is written, so -- as a workaround -- let's make sure we will actually write something first
66   if (!((coins != nv_coins) || (total_coins != nv_coins) || (badguys != nv_badguys) || (total_badguys != nv_badguys) || (time != nv_time) || (secrets != nv_secrets) || (total_secrets != nv_secrets))) return;
67
68   sq_pushstring(vm, "statistics", -1);
69   sq_newtable(vm);
70   if (coins != nv_coins) scripting::store_int(vm, "coins-collected", coins);
71   if (total_coins != nv_coins) scripting::store_int(vm, "coins-collected-total", total_coins);
72   if (badguys != nv_badguys) scripting::store_int(vm, "badguys-killed", badguys);
73   if (total_badguys != nv_badguys) scripting::store_int(vm, "badguys-killed-total", total_badguys);
74   if (time != nv_time) scripting::store_float(vm, "time-needed", time);
75   if (secrets != nv_secrets) scripting::store_int(vm, "secrets-found", secrets);
76   if (total_secrets != nv_secrets) scripting::store_int(vm, "secrets-found-total", total_secrets);
77   sq_createslot(vm, -3);
78 }
79
80 void
81 Statistics::unserialize_from_squirrel(HSQUIRRELVM vm)
82 {
83   sq_pushstring(vm, "statistics", -1);
84   if(SQ_FAILED(sq_get(vm, -2))) {
85     return;
86   }
87   scripting::get_int(vm, "coins-collected", coins);
88   scripting::get_int(vm, "coins-collected-total", total_coins);
89   scripting::get_int(vm, "badguys-killed", badguys);
90   scripting::get_int(vm, "badguys-killed-total", total_badguys);
91   scripting::get_float(vm, "time-needed", time);
92   scripting::get_int(vm, "secrets-found", secrets);
93   scripting::get_int(vm, "secrets-found-total", total_secrets);
94   sq_pop(vm, 1);
95 }
96
97 void
98 Statistics::draw_worldmap_info(DrawingContext& context)
99 {
100   // skip draw if level was never played
101   if (coins == nv_coins) return;
102
103   // skip draw if stats were declared invalid
104   if (!valid) return;
105
106   context.draw_text(Resources::small_font, std::string("- ") + _("Best Level Statistics") + " -", 
107                     Vector((WMAP_INFO_LEFT_X + WMAP_INFO_RIGHT_X) / 2, WMAP_INFO_TOP_Y1), 
108                     ALIGN_CENTER, LAYER_HUD,Statistics::header_color);
109
110   std::string caption_buf;
111   std::string stat_buf;
112   float posy = WMAP_INFO_TOP_Y2;
113   for (int stat_no = 0; stat_no < 4; stat_no++) {
114     switch (stat_no)
115     {
116       case 0:
117         caption_buf = _("Max coins collected:");
118         stat_buf = coins_to_string(coins, total_coins);
119         break;
120       case 1:
121         caption_buf = _("Max fragging:");
122         stat_buf = frags_to_string(badguys, total_badguys);
123         break;
124       case 2:
125         caption_buf = _("Min time needed:");
126         stat_buf = time_to_string(time);
127         break;
128       case 3:
129         caption_buf = _("Max secrets found:");
130         stat_buf = secrets_to_string(secrets, total_secrets);
131         break;
132       default:
133         log_debug << "Invalid stat requested to be drawn" << std::endl;
134         break;
135     }
136
137     context.draw_text(Resources::small_font, caption_buf, Vector(WMAP_INFO_LEFT_X, posy), ALIGN_LEFT, LAYER_HUD, Statistics::header_color);
138     context.draw_text(Resources::small_font, stat_buf, Vector(WMAP_INFO_RIGHT_X, posy), ALIGN_RIGHT, LAYER_HUD, Statistics::header_color);
139     posy += Resources::small_font->get_height() + 2;
140   }
141
142 }
143
144 void
145 Statistics::draw_endseq_panel(DrawingContext& context, Statistics* best_stats, SurfacePtr backdrop)
146 {
147   // skip draw if stats were declared invalid
148   if (!valid) return;
149
150   // abort if we have no backdrop
151   if (!backdrop) return;
152
153   int box_w = 220+110+110;
154   int box_h = 30+20+20+20;
155   int box_x = (int)((SCREEN_WIDTH - box_w) / 2);
156   int box_y = (int)(SCREEN_HEIGHT / 2) - box_h;
157
158   int bd_w = (int)backdrop->get_width();
159   int bd_h = (int)backdrop->get_height();
160   int bd_x = (int)((SCREEN_WIDTH - bd_w) / 2);
161   int bd_y = box_y + (box_h / 2) - (bd_h / 2);
162
163   int col1_x = box_x;
164   int col2_x = col1_x+200;
165   int col3_x = col2_x+130;
166
167   int row1_y = box_y;
168   int row2_y = row1_y+30;
169   int row3_y = row2_y+20;
170   int row4_y = row3_y+20;
171   int row5_y = row4_y+20;
172
173   context.push_transform();
174   context.set_alpha(0.5);
175   context.draw_surface(backdrop, Vector(bd_x, bd_y), LAYER_HUD);
176   context.pop_transform();
177
178   context.draw_text(Resources::normal_font, _("You"), Vector(col2_x, row1_y), ALIGN_LEFT, LAYER_HUD, Statistics::header_color);
179   if (best_stats)
180     context.draw_text(Resources::normal_font, _("Best"), Vector(col3_x, row1_y), ALIGN_LEFT, LAYER_HUD, Statistics::header_color);
181
182   context.draw_text(Resources::normal_font, _("Coins"), Vector(col2_x-16, row3_y), ALIGN_RIGHT, LAYER_HUD, Statistics::header_color);
183   context.draw_text(Resources::normal_font, coins_to_string(coins, total_coins), Vector(col2_x, row3_y), ALIGN_LEFT, LAYER_HUD, Statistics::text_color);
184   if (best_stats) {
185     int coins_best = (best_stats->coins > coins) ? best_stats->coins : coins;
186     int total_coins_best = (best_stats->total_coins > total_coins) ? best_stats->total_coins : total_coins;
187     context.draw_text(Resources::normal_font, coins_to_string(coins_best, total_coins_best), Vector(col3_x, row3_y), ALIGN_LEFT, LAYER_HUD, Statistics::text_color);
188   }
189
190   context.draw_text(Resources::normal_font, _("Badguys"), Vector(col2_x-16, row4_y), ALIGN_RIGHT, LAYER_HUD, Statistics::header_color);
191   context.draw_text(Resources::normal_font, frags_to_string(badguys, total_badguys), Vector(col2_x, row4_y), ALIGN_LEFT, LAYER_HUD, Statistics::text_color);
192   if (best_stats) {
193         int badguys_best = (best_stats->badguys > badguys) ? best_stats->badguys : badguys;
194         int total_badguys_best = (best_stats->total_badguys > total_badguys) ? best_stats->total_badguys : total_badguys;
195         context.draw_text(Resources::normal_font, frags_to_string(badguys_best, total_badguys_best), Vector(col3_x, row4_y), ALIGN_LEFT, LAYER_HUD, Statistics::text_color);
196   }
197
198   context.draw_text(Resources::normal_font, _("Secrets"), Vector(col2_x-16, row5_y), ALIGN_RIGHT, LAYER_HUD, Statistics::header_color);
199   context.draw_text(Resources::normal_font, secrets_to_string(secrets, total_secrets), Vector(col2_x, row5_y), ALIGN_LEFT, LAYER_HUD, Statistics::text_color);
200   if (best_stats) {
201     int secrets_best = (best_stats->secrets > secrets) ? best_stats->secrets : secrets;
202     int total_secrets_best = (best_stats->total_secrets > total_secrets) ? best_stats->total_secrets : total_secrets;
203     context.draw_text(Resources::normal_font, secrets_to_string(secrets_best, total_secrets_best), Vector(col3_x, row5_y), ALIGN_LEFT, LAYER_HUD, Statistics::text_color);
204   }
205
206   context.draw_text(Resources::normal_font, _("Time"), Vector(col2_x-16, row2_y), ALIGN_RIGHT, LAYER_HUD, Statistics::header_color);
207   context.draw_text(Resources::normal_font, time_to_string(time), Vector(col2_x, row2_y), ALIGN_LEFT, LAYER_HUD, Statistics::text_color);
208   if (best_stats) {
209     float time_best = (best_stats->time < time) ? best_stats->time : time;
210     context.draw_text(Resources::normal_font, time_to_string(time_best), Vector(col3_x, row2_y), ALIGN_LEFT, LAYER_HUD, Statistics::text_color);
211   }
212 }
213
214 void
215 Statistics::zero()
216 {
217   reset();
218   total_coins = 0;
219   total_badguys = 0;
220   total_secrets = 0;
221 }
222
223 void
224 Statistics::reset()
225 {
226   coins = 0;
227   badguys = 0;
228   time = 0;
229   secrets = 0;
230 }
231
232 void
233 Statistics::merge(const Statistics& s2)
234 {
235   if (!s2.valid) return;
236   coins = std::max(coins, s2.coins);
237   total_coins = s2.total_coins;
238   coins = std::min(coins, total_coins);
239   badguys = std::max(badguys, s2.badguys);
240   total_badguys = s2.total_badguys;
241   badguys = std::min(badguys, total_badguys);
242   time = std::min(time, s2.time);
243   secrets = std::max(secrets, s2.secrets);
244   total_secrets = s2.total_secrets;
245   secrets = std::min(secrets, total_secrets);
246 }
247
248 void
249 Statistics::operator+=(const Statistics& s2)
250 {
251   if (!s2.valid) return;
252   if (s2.coins != nv_coins) coins += s2.coins;
253   if (s2.total_coins != nv_coins) total_coins += s2.total_coins;
254   if (s2.badguys != nv_badguys) badguys += s2.badguys;
255   if (s2.total_badguys != nv_badguys) total_badguys += s2.total_badguys;
256   if (s2.time != nv_time) time += s2.time;
257   if (s2.secrets != nv_secrets) secrets += s2.secrets;
258   if (s2.total_secrets != nv_secrets) total_secrets += s2.total_secrets;
259 }
260
261 bool
262 Statistics::completed(const Statistics& stats)
263 {
264   return (stats.coins == stats.total_coins && 
265       stats.badguys == stats.total_badguys && 
266       stats.secrets == stats.total_secrets);
267 }
268
269 void
270 Statistics::declare_invalid()
271 {
272   valid = false;
273 }
274
275 std::string
276 Statistics::coins_to_string(int coins, int total_coins) {
277   std::ostringstream os;
278   os << std::min(coins, 999) << "/" << std::min(total_coins, 999);
279   return os.str();
280 }
281
282 std::string
283 Statistics::frags_to_string(int badguys, int total_badguys) {
284   std::ostringstream os;
285   os << std::min(badguys, 999) << "/" << std::min(total_badguys, 999);
286   return os.str();
287 }
288
289 std::string 
290 Statistics::time_to_string(float time) {
291   int time_csecs = std::min(static_cast<int>(time * 100), 99 * 6000 + 9999);
292   int mins = (time_csecs / 6000);
293   int secs = (time_csecs % 6000) / 100;
294   int cscs = (time_csecs % 6000) % 100;
295
296   std::ostringstream os;
297   os << std::setw(2) << std::setfill('0') << mins << ":" << std::setw(2) << std::setfill('0') << secs << "." << std::setw(2) << std::setfill('0') << cscs;
298   return os.str();
299 }
300
301 std::string
302 Statistics::secrets_to_string(int secrets, int total_secrets) {
303   std::ostringstream os;
304   os << std::min(secrets, 999) << "/" << std::min(total_secrets, 999);
305   return os.str();
306 }
307
308 /* EOF */