OpenTTD Source: src/game/game_text.hpp Source File

OpenTTD Source 12.2

game_text.hpp
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 #ifndef GAME_TEXT_HPP
11 #define GAME_TEXT_HPP
12
13 #include "../core/smallvec_type.hpp"
14
15 const char *GetGameStringPtr(uint id);
16 void RegisterGameTranslation(class Squirrel *engine);
17 void ReconsiderGameScriptLanguage();
18
20 struct LanguageStrings {
21 std::string language;
22 StringList lines;
23
24 LanguageStrings() {}
25 LanguageStrings(const std::string &lang) : language(lang) {}
26 LanguageStrings(const LanguageStrings &other) : language(other.language), lines(other.lines) {}
27 LanguageStrings(LanguageStrings &&other) : language(std::move(other.language)), lines(std::move(other.lines)) {}
28
29 bool IsValid() const { return !this->language.empty(); }
30 };
31
33 struct GameStrings {
34 uint version;
35 LanguageStrings *cur_language;
36
37 std::vector<LanguageStrings> raw_strings;
38 std::vector<LanguageStrings> compiled_strings;
39 StringList string_names;
40
41 void Compile();
42
43 GameStrings() = default;
44
45 GameStrings(const GameStrings &) = delete;
46 GameStrings(GameStrings &&) = delete;
47 GameStrings &operator=(const GameStrings &) = delete;
48 GameStrings &operator=(GameStrings &&) = delete;
49 };
50
51 #endif /* GAME_TEXT_HPP */
GameStrings::version
uint version
The version of the language strings.
Definition: game_text.hpp:34
GameStrings::string_names
StringList string_names
The names of the compiled strings.
Definition: game_text.hpp:39
Squirrel
Definition: squirrel.hpp:23
ReconsiderGameScriptLanguage
void ReconsiderGameScriptLanguage()
Reconsider the game script language, so we use the right one.
Definition: game_text.cpp:345
StringList
std::vector< std::string > StringList
Type for a list of strings.
Definition: string_type.h:58
GameStrings::raw_strings
std::vector< LanguageStrings > raw_strings
The raw strings per language, first must be English/the master language!.
Definition: game_text.hpp:37
LanguageStrings
Container for the raw (unencoded) language strings of a language.
Definition: game_text.hpp:20
RegisterGameTranslation
void RegisterGameTranslation(class Squirrel *engine)
Register the current translation to the Squirrel engine.
Definition: game_text.cpp:318
LanguageStrings::language
std::string language
Name of the language (base filename). Empty string if invalid.
Definition: game_text.hpp:21
GetGameStringPtr
const char * GetGameStringPtr(uint id)
Get the string pointer of a particular game string.
Definition: game_text.cpp:308
GameStrings::cur_language
LanguageStrings * cur_language
The current (compiled) language.
Definition: game_text.hpp:35
GameStrings::compiled_strings
std::vector< LanguageStrings > compiled_strings
The compiled strings per language, first must be English/the master language!.
Definition: game_text.hpp:38
LanguageStrings::lines
StringList lines
The lines of the file to pass into the parser/encoder.
Definition: game_text.hpp:22
GameStrings::Compile
void Compile()
Compile the language.
Definition: game_text.cpp:276
GameStrings
Container for all the game strings.
Definition: game_text.hpp:33