OpenTTD Source: src/highscore.cpp Source File

OpenTTD Source 14.0-beta1

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 <http://www.gnu.org/licenses/>.
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 "table/strings.h"
19 #include "debug.h"
20
21 #include "safeguards.h"
22
23 HighScoresTable _highscore_table;
24 std::string _highscore_file;
25
26 static const StringID _endgame_perf_titles[] = {
27 STR_HIGHSCORE_PERFORMANCE_TITLE_BUSINESSMAN,
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_ENTREPRENEUR,
33 STR_HIGHSCORE_PERFORMANCE_TITLE_ENTREPRENEUR,
34 STR_HIGHSCORE_PERFORMANCE_TITLE_INDUSTRIALIST,
35 STR_HIGHSCORE_PERFORMANCE_TITLE_INDUSTRIALIST,
36 STR_HIGHSCORE_PERFORMANCE_TITLE_CAPITALIST,
37 STR_HIGHSCORE_PERFORMANCE_TITLE_CAPITALIST,
38 STR_HIGHSCORE_PERFORMANCE_TITLE_MAGNATE,
39 STR_HIGHSCORE_PERFORMANCE_TITLE_MAGNATE,
40 STR_HIGHSCORE_PERFORMANCE_TITLE_MOGUL,
41 STR_HIGHSCORE_PERFORMANCE_TITLE_MOGUL,
42 STR_HIGHSCORE_PERFORMANCE_TITLE_TYCOON_OF_THE_CENTURY
43 };
44
45 StringID EndGameGetPerformanceTitleFromValue(uint value)
46 {
47 value = std::min<uint>(value / 64, lengthof(_endgame_perf_titles) - 1);
48
49 return _endgame_perf_titles[value];
50 }
51
57 int8_t SaveHighScoreValue(const Company *c)
58 {
59 /* Exclude cheaters from the honour of being in the highscore table */
60 if (CheatHasBeenUsed()) return -1;
61
62 auto &highscores = _highscore_table[SP_CUSTOM];
63 uint16_t score = c->old_economy[0].performance_history;
64
65 auto it = std::find_if(highscores.begin(), highscores.end(), [&score](auto &highscore) { return highscore.score <= score; });
66
67 /* If we cannot find it, our score is not high enough. */
68 if (it == highscores.end()) return -1;
69
70 /* Move all elements one down starting from the replaced one */
71 std::move_backward(it, highscores.end() - 1, highscores.end());
72
73 /* Fill the elements. */
74 SetDParam(0, c->index);
75 SetDParam(1, c->index);
76 it->name = GetString(STR_HIGHSCORE_NAME); // get manager/company name string
77 it->score = score;
78 it->title = EndGameGetPerformanceTitleFromValue(score);
79 return std::distance(highscores.begin(), it);
80 }
81
83 static bool HighScoreSorter(const Company * const &a, const Company * const &b)
84 {
85 return b->old_economy[0].performance_history < a->old_economy[0].performance_history;
86 }
87
92 int8_t SaveHighScoreValueNetwork()
93 {
94 const Company *cl[MAX_COMPANIES];
95 size_t count = 0;
96 int8_t local_company_place = -1;
97
98 /* Sort all active companies with the highest score first */
99 for (const Company *c : Company::Iterate()) cl[count++] = c;
100
101 std::sort(std::begin(cl), std::begin(cl) + count, HighScoreSorter);
102
103 /* Clear the high scores from the previous network game. */
104 auto &highscores = _highscore_table[SP_MULTIPLAYER];
105 std::fill(highscores.begin(), highscores.end(), HighScore{});
106
107 for (size_t i = 0; i < count && i < highscores.size(); i++) {
108 const Company *c = cl[i];
109 auto &highscore = highscores[i];
110 SetDParam(0, c->index);
111 SetDParam(1, c->index);
112 highscore.name = GetString(STR_HIGHSCORE_NAME); // get manager/company name string
113 highscore.score = c->old_economy[0].performance_history;
114 highscore.title = EndGameGetPerformanceTitleFromValue(highscore.score);
115
116 if (c->index == _local_company) local_company_place = static_cast<int8_t>(i);
117 }
118
119 return local_company_place;
120 }
121
123 void SaveToHighScore()
124 {
125 std::unique_ptr<FILE, FileDeleter> fp(fopen(_highscore_file.c_str(), "wb"));
126 if (fp == nullptr) return;
127
128 /* Does not iterate through the complete array!. */
129 for (int i = 0; i < SP_SAVED_HIGHSCORE_END; i++) {
130 for (HighScore &hs : _highscore_table[i]) {
131 /* This code is weird and old fashioned to keep compatibility with the old high score files. */
132 byte name_length = ClampTo<byte>(hs.name.size());
133 if (fwrite(&name_length, sizeof(name_length), 1, fp.get()) != 1 || // Write the string length of the name
134 fwrite(hs.name.data(), name_length, 1, fp.get()) > 1 || // Yes... could be 0 bytes too
135 fwrite(&hs.score, sizeof(hs.score), 1, fp.get()) != 1 ||
136 fwrite(" ", 2, 1, fp.get()) != 1) { // Used to be hs.title, not saved anymore; compatibility
137 Debug(misc, 1, "Could not save highscore.");
138 return;
139 }
140 }
141 }
142 }
143
145 void LoadFromHighScore()
146 {
147 std::fill(_highscore_table.begin(), _highscore_table.end(), HighScores{});
148
149 std::unique_ptr<FILE, FileDeleter> fp(fopen(_highscore_file.c_str(), "rb"));
150 if (fp == nullptr) return;
151
152 /* Does not iterate through the complete array!. */
153 for (int i = 0; i < SP_SAVED_HIGHSCORE_END; i++) {
154 for (HighScore &hs : _highscore_table[i]) {
155 /* This code is weird and old fashioned to keep compatibility with the old high score files. */
156 byte name_length;
157 char buffer[std::numeric_limits<decltype(name_length)>::max() + 1];
158
159 if (fread(&name_length, sizeof(name_length), 1, fp.get()) != 1 ||
160 fread(buffer, name_length, 1, fp.get()) > 1 || // Yes... could be 0 bytes too
161 fread(&hs.score, sizeof(hs.score), 1, fp.get()) != 1 ||
162 fseek(fp.get(), 2, SEEK_CUR) == -1) { // Used to be hs.title, not saved anymore; compatibility
163 Debug(misc, 1, "Highscore corrupted");
164 return;
165 }
166 hs.name = StrMakeValid(std::string_view(buffer, name_length));
167 hs.title = EndGameGetPerformanceTitleFromValue(hs.score);
168 }
169 }
170 }
company_base.h
HighScore
Definition: highscore.h:17
StringID
uint32_t StringID
Numeric value that represents a string, independent of the selected language.
Definition: strings_type.h:16
Pool::PoolItem::index
Tindex index
Index of this pool item.
Definition: pool_type.hpp:234
SP_MULTIPLAYER
@ SP_MULTIPLAYER
Special "multiplayer" highscore. Not saved, always specific to the current game.
Definition: settings_type.h:49
StrMakeValid
static void StrMakeValid(T &dst, const char *str, const char *last, StringValidationSettings settings)
Copies the valid (UTF-8) characters from str up to last to the dst.
Definition: string.cpp:114
fileio_func.h
LoadFromHighScore
void LoadFromHighScore()
Initialize the highscore table to 0 and if any file exists, load in values.
Definition: highscore.cpp:145
Debug
#define Debug(category, level, format_string,...)
Ouptut a line of debugging information.
Definition: debug.h:37
_highscore_table
HighScoresTable _highscore_table
Table with all the high scores.
Definition: highscore.cpp:23
highscore.h
SP_CUSTOM
@ SP_CUSTOM
No profile, special "custom" highscore.
Definition: settings_type.h:46
MAX_COMPANIES
@ MAX_COMPANIES
Maximum number of companies.
Definition: company_type.h:23
_local_company
CompanyID _local_company
Company controlled by the human player at this client. Can also be COMPANY_SPECTATOR.
Definition: company_cmd.cpp:49
safeguards.h
stdafx.h
string_func.h
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:384
strings_func.h
CompanyEconomyEntry::performance_history
int32_t performance_history
Company score (scale 0-1000)
Definition: company_base.h:28
SaveToHighScore
void SaveToHighScore()
Save HighScore table to file.
Definition: highscore.cpp:123
SetDParam
void SetDParam(size_t n, uint64_t v)
Set a string parameter v at index n in the global string parameter array.
Definition: strings.cpp:104
CheatHasBeenUsed
bool CheatHasBeenUsed()
Return true if any cheat has been used, false otherwise.
Definition: cheat.cpp:28
SP_SAVED_HIGHSCORE_END
@ SP_SAVED_HIGHSCORE_END
End of saved highscore tables.
Definition: settings_type.h:47
GetString
std::string GetString(StringID string)
Resolve the given StringID into a std::string with all the associated DParam lookups and formatting.
Definition: strings.cpp:327
SaveHighScoreValue
int8_t SaveHighScoreValue(const Company *c)
Save the highscore for the company.
Definition: highscore.cpp:57
company_func.h
lengthof
#define lengthof(x)
Return the length of an fixed size array.
Definition: stdafx.h:300
HighScores
std::array< HighScore, 5 > HighScores
Record 5 high scores.
Definition: highscore.h:23
HighScoresTable
std::array< HighScores, SP_HIGHSCORE_END > HighScoresTable
Record high score for each of the difficulty levels.
Definition: highscore.h:24
SaveHighScoreValueNetwork
int8_t SaveHighScoreValueNetwork()
Save the highscores in a network game when it has ended.
Definition: highscore.cpp:92
HighScoreSorter
static bool HighScoreSorter(const Company *const &a, const Company *const &b)
Sort all companies given their performance.
Definition: highscore.cpp:83
_highscore_file
std::string _highscore_file
The file to store the highscore data in.
Definition: highscore.cpp:24
Company
Definition: company_base.h:116
CompanyProperties::old_economy
CompanyEconomyEntry old_economy[MAX_HISTORY_QUARTERS]
Economic data of the company of the last MAX_HISTORY_QUARTERS quarters.
Definition: company_base.h:99
debug.h
cheat_func.h