OpenTTD Source: src/highscore.cpp Source File

OpenTTD Source 15.0-RC2

highscore.cpp
Go to the documentation of this file.
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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
6 */
7
10#include "stdafx.h"
11#include "highscore.h"
12#include "company_base.h"
13#include "company_func.h"
14#include "cheat_func.h"
15#include "fileio_func.h"
16#include "string_func.h"
17#include "strings_func.h"
18#include "debug.h"
19
20#include "table/strings.h"
21
22#include "safeguards.h"
23
24 HighScoresTable _highscore_table;
25std::string _highscore_file;
26
27static const StringID _endgame_perf_titles[] = {
28 STR_HIGHSCORE_PERFORMANCE_TITLE_BUSINESSMAN,
29 STR_HIGHSCORE_PERFORMANCE_TITLE_BUSINESSMAN,
30 STR_HIGHSCORE_PERFORMANCE_TITLE_BUSINESSMAN,
31 STR_HIGHSCORE_PERFORMANCE_TITLE_BUSINESSMAN,
32 STR_HIGHSCORE_PERFORMANCE_TITLE_BUSINESSMAN,
33 STR_HIGHSCORE_PERFORMANCE_TITLE_ENTREPRENEUR,
34 STR_HIGHSCORE_PERFORMANCE_TITLE_ENTREPRENEUR,
35 STR_HIGHSCORE_PERFORMANCE_TITLE_INDUSTRIALIST,
36 STR_HIGHSCORE_PERFORMANCE_TITLE_INDUSTRIALIST,
37 STR_HIGHSCORE_PERFORMANCE_TITLE_CAPITALIST,
38 STR_HIGHSCORE_PERFORMANCE_TITLE_CAPITALIST,
39 STR_HIGHSCORE_PERFORMANCE_TITLE_MAGNATE,
40 STR_HIGHSCORE_PERFORMANCE_TITLE_MAGNATE,
41 STR_HIGHSCORE_PERFORMANCE_TITLE_MOGUL,
42 STR_HIGHSCORE_PERFORMANCE_TITLE_MOGUL,
43 STR_HIGHSCORE_PERFORMANCE_TITLE_TYCOON_OF_THE_CENTURY
44};
45
46 StringID EndGameGetPerformanceTitleFromValue(uint value)
47{
48 value = std::min<uint>(value / 64, lengthof(_endgame_perf_titles) - 1);
49
50 return _endgame_perf_titles[value];
51}
52
58int8_t SaveHighScoreValue(const Company *c)
59{
60 auto &highscores = _highscore_table[SP_CUSTOM];
61 uint16_t score = c->old_economy[0].performance_history;
62
63 auto it = std::ranges::find_if(highscores, [&score](auto &highscore) { return highscore.score <= score; });
64
65 /* If we cannot find it, our score is not high enough. */
66 if (it == highscores.end()) return -1;
67
68 /* Move all elements one down starting from the replaced one */
69 std::move_backward(it, highscores.end() - 1, highscores.end());
70
71 /* Fill the elements. */
72 it->name = GetString(STR_HIGHSCORE_NAME, c->index, c->index); // get manager/company name string
73 it->score = score;
74 it->title = EndGameGetPerformanceTitleFromValue(score);
75 return std::distance(highscores.begin(), it);
76}
77
79 static bool HighScoreSorter(const Company * const &a, const Company * const &b)
80{
81 return b->old_economy[0].performance_history < a->old_economy[0].performance_history;
82}
83
88int8_t SaveHighScoreValueNetwork()
89{
90 std::vector<const Company *> cl;
91 int8_t local_company_place = -1;
92
93 /* Sort all active companies with the highest score first */
94 for (const Company *c : Company::Iterate()) cl.push_back(c);
95
96 std::ranges::sort(cl, HighScoreSorter);
97
98 /* Clear the high scores from the previous network game. */
99 auto &highscores = _highscore_table[SP_MULTIPLAYER];
100 std::fill(highscores.begin(), highscores.end(), HighScore{});
101
102 for (size_t i = 0; i < cl.size() && i < highscores.size(); i++) {
103 const Company *c = cl[i];
104 auto &highscore = highscores[i];
105 highscore.name = GetString(STR_HIGHSCORE_NAME, c->index, c->index); // get manager/company name string
106 highscore.score = c->old_economy[0].performance_history;
107 highscore.title = EndGameGetPerformanceTitleFromValue(highscore.score);
108
109 if (c->index == _local_company) local_company_place = static_cast<int8_t>(i);
110 }
111
112 return local_company_place;
113}
114
116 void SaveToHighScore()
117{
118 auto ofp = FileHandle::Open(_highscore_file, "wb");
119 if (!ofp.has_value()) return;
120 auto &fp = *ofp;
121
122 /* Does not iterate through the complete array!. */
123 for (int i = 0; i < SP_SAVED_HIGHSCORE_END; i++) {
124 for (HighScore &hs : _highscore_table[i]) {
125 /* This code is weird and old fashioned to keep compatibility with the old high score files. */
126 uint8_t name_length = ClampTo<uint8_t>(hs.name.size());
127 if (fwrite(&name_length, sizeof(name_length), 1, fp) != 1 || // Write the string length of the name
128 fwrite(hs.name.data(), name_length, 1, fp) > 1 || // Yes... could be 0 bytes too
129 fwrite(&hs.score, sizeof(hs.score), 1, fp) != 1 ||
130 fwrite(" ", 2, 1, fp) != 1) { // Used to be hs.title, not saved anymore; compatibility
131 Debug(misc, 1, "Could not save highscore.");
132 return;
133 }
134 }
135 }
136}
137
139 void LoadFromHighScore()
140{
141 std::fill(_highscore_table.begin(), _highscore_table.end(), HighScores{});
142
143 auto ofp = FileHandle::Open(_highscore_file, "rb");
144 if (!ofp.has_value()) return;
145 auto &fp = *ofp;
146
147 /* Does not iterate through the complete array!. */
148 for (int i = 0; i < SP_SAVED_HIGHSCORE_END; i++) {
149 for (HighScore &hs : _highscore_table[i]) {
150 /* This code is weird and old fashioned to keep compatibility with the old high score files. */
151 uint8_t name_length;
152 char buffer[std::numeric_limits<decltype(name_length)>::max() + 1];
153
154 if (fread(&name_length, sizeof(name_length), 1, fp) != 1 ||
155 fread(buffer, name_length, 1, fp) > 1 || // Yes... could be 0 bytes too
156 fread(&hs.score, sizeof(hs.score), 1, fp) != 1 ||
157 fseek(fp, 2, SEEK_CUR) == -1) { // Used to be hs.title, not saved anymore; compatibility
158 Debug(misc, 1, "Highscore corrupted");
159 return;
160 }
161 hs.name = StrMakeValid(std::string_view(buffer, name_length));
162 hs.title = EndGameGetPerformanceTitleFromValue(hs.score);
163 }
164 }
165}
cheat_func.h
Functions related to cheating.
FileHandle::Open
static std::optional< FileHandle > Open(const std::string &filename, std::string_view mode)
Open an RAII file handle if possible.
Definition fileio.cpp:1171
company_base.h
Definition of stuff that is very close to a company, like the company struct itself.
_local_company
CompanyID _local_company
Company controlled by the human player at this client. Can also be COMPANY_SPECTATOR.
Definition company_cmd.cpp:55
company_func.h
Functions related to companies.
debug.h
Functions related to debugging.
Debug
#define Debug(category, level, format_string,...)
Output a line of debugging information.
Definition debug.h:37
fileio_func.h
Functions for Standard In/Out file operations.
LoadFromHighScore
void LoadFromHighScore()
Initialize the highscore table to 0 and if any file exists, load in values.
Definition highscore.cpp:139
SaveHighScoreValueNetwork
int8_t SaveHighScoreValueNetwork()
Save the highscores in a network game when it has ended.
Definition highscore.cpp:88
SaveToHighScore
void SaveToHighScore()
Save HighScore table to file.
Definition highscore.cpp:116
HighScoreSorter
static bool HighScoreSorter(const Company *const &a, const Company *const &b)
Sort all companies given their performance.
Definition highscore.cpp:79
_highscore_table
HighScoresTable _highscore_table
Table with all the high scores.
Definition highscore.cpp:24
_highscore_file
std::string _highscore_file
The file to store the highscore data in.
Definition highscore.cpp:25
SaveHighScoreValue
int8_t SaveHighScoreValue(const Company *c)
Save the highscore for the company.
Definition highscore.cpp:58
highscore.h
Declaration of functions and types defined in highscore.h and highscore_gui.h.
HighScoresTable
std::array< HighScores, SP_HIGHSCORE_END > HighScoresTable
Record high score for each of the difficulty levels.
Definition highscore.h:24
HighScores
std::array< HighScore, 5 > HighScores
Record 5 high scores.
Definition highscore.h:23
safeguards.h
A number of safeguards to prevent using unsafe methods.
SP_CUSTOM
@ SP_CUSTOM
No profile, special "custom" highscore.
Definition settings_type.h:47
SP_MULTIPLAYER
@ SP_MULTIPLAYER
Special "multiplayer" highscore. Not saved, always specific to the current game.
Definition settings_type.h:50
SP_SAVED_HIGHSCORE_END
@ SP_SAVED_HIGHSCORE_END
End of saved highscore tables.
Definition settings_type.h:48
stdafx.h
Definition of base types and functions in a cross-platform compatible way.
lengthof
#define lengthof(array)
Return the length of an fixed size array.
Definition stdafx.h:271
StrMakeValid
static void StrMakeValid(Builder &builder, StringConsumer &consumer, StringValidationSettings settings)
Copies the valid (UTF-8) characters from consumer to the builder.
Definition string.cpp:119
string_func.h
Functions related to low-level strings.
GetString
std::string GetString(StringID string)
Resolve the given StringID into a std::string with formatting but no parameters.
Definition strings.cpp:424
strings_func.h
Functions related to OTTD's strings.
StringID
uint32_t StringID
Numeric value that represents a string, independent of the selected language.
Definition strings_type.h:19
CompanyProperties::old_economy
std::array< CompanyEconomyEntry, MAX_HISTORY_QUARTERS > old_economy
Economic data of the company of the last MAX_HISTORY_QUARTERS quarters.
Definition company_base.h:118
CompanyProperties::name
std::string name
Name of the company if the user changed it.
Definition company_base.h:74
Company
Definition company_base.h:127
HighScore
Definition highscore.h:17
Pool::PoolItem<&_company_pool >::Iterate
static Pool::IterateWrapper< Titem > Iterate(size_t from=0)
Returns an iterable ensemble of all valid Titem.
Definition pool_type.hpp:436
Pool::PoolItem::index
Tindex index
Index of this pool item.
Definition pool_type.hpp:286