(svn r27950) -Merge: Documentation updates from 1.7 branch
[openttd.git] / src / highscore.h
blob5d4b919ee5944600b2b07f40c318278603386f66
1 /* $Id$ */
3 /*
4 * This file is part of OpenTTD.
5 * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
6 * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
7 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
8 */
10 /** @file highscore.h Declaration of functions and types defined in highscore.h and highscore_gui.h */
12 #ifndef HIGHSCORE_H
13 #define HIGHSCORE_H
15 #include "strings_type.h"
16 #include "company_type.h"
17 #include "settings_type.h"
19 struct HighScore {
20 /**
21 * The name of the company and president.
22 * The + 5 is for the comma and space or possibly other characters
23 * that join the two names in this single string and the '\0'.
25 char company[(MAX_LENGTH_COMPANY_NAME_CHARS + MAX_LENGTH_PRESIDENT_NAME_CHARS + 5) * MAX_CHAR_LENGTH];
26 StringID title; ///< NOSAVE, has troubles with changing string-numbers.
27 uint16 score; ///< The score for this high score. Do NOT change type, will break hs.dat
30 extern HighScore _highscore_table[SP_HIGHSCORE_END][5];
32 void SaveToHighScore();
33 void LoadFromHighScore();
34 int8 SaveHighScoreValue(const Company *c);
35 int8 SaveHighScoreValueNetwork();
36 StringID EndGameGetPerformanceTitleFromValue(uint value);
37 void ShowHighscoreTable(int difficulty = SP_CUSTOM, int8 rank = -1);
39 #endif /* HIGHSCORE_H */