src/highscore.h

   1 /*
   2  * This file is part of OpenTTD.
   3  * 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.
   4  * 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.
   5  * 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/>.
   6  */
   7
   8 /** @file highscore.h Declaration of functions and types defined in highscore.h and highscore_gui.h */
   9
  10 #ifndef HIGHSCORE_H
  11 #define HIGHSCORE_H
  12
  13 #include "strings_type.h"
  14 #include "company_type.h"
  15 #include "settings_type.h"
  16
  17 struct HighScore {
  18         /**
  19          * The name of the company and president.
  20          * The + 5 is for the comma and space or possibly other characters
  21          * that join the two names in this single string and the '\0'.
  22          */
  23         char company[(MAX_LENGTH_COMPANY_NAME_CHARS + MAX_LENGTH_PRESIDENT_NAME_CHARS + 5) * MAX_CHAR_LENGTH];
  24         StringID title; ///< NOSAVE, has troubles with changing string-numbers.
  25         uint16 score;   ///< The score for this high score. Do NOT change type, will break hs.dat
  26 };
  27
  28 extern HighScore _highscore_table[SP_HIGHSCORE_END][5];
  29
  30 void SaveToHighScore();
  31 void LoadFromHighScore();
  32 int8 SaveHighScoreValue(const Company *c);
  33 int8 SaveHighScoreValueNetwork();
  34 StringID EndGameGetPerformanceTitleFromValue(uint value);
  35 void ShowHighscoreTable(int difficulty = SP_CUSTOM, int8 rank = -1);
  36
  37 #endif /* HIGHSCORE_H */