OpenTTD

game_text.hpp
Go to the documentation of this file.
1 /* $Id: game_text.hpp 27756 2017-02-26 19:40:53Z frosch $ */
2
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 */
9
12 #ifndef GAME_TEXT_HPP
13 #define GAME_TEXT_HPP
14
15 #include "../core/smallvec_type.hpp"
16
17 const char *GetGameStringPtr(uint id);
18 void RegisterGameTranslation(class Squirrel *engine);
19 void ReconsiderGameScriptLanguage();
20
22 struct LanguageStrings {
23 const char *language;
24 StringList lines;
25
26 LanguageStrings(const char *language, const char *end = NULL);
27 ~LanguageStrings();
28 };
29
31 struct GameStrings {
32 uint version;
33 LanguageStrings *cur_language;
34
35 AutoDeleteSmallVector<LanguageStrings *, 4> raw_strings;
36 AutoDeleteSmallVector<LanguageStrings *, 4> compiled_strings;
37 StringList string_names;
38
39 void Compile();
40 };
41
42 #endif /* GAME_TEXT_HPP */
GameStrings::cur_language
LanguageStrings * cur_language
The current (compiled) language.
Definition: game_text.hpp:33
GetGameStringPtr
const char * GetGameStringPtr(uint id)
Get the string pointer of a particular game string.
Definition: game_text.cpp:341
GameStrings
Container for all the game strings.
Definition: game_text.hpp:31
GameStrings::raw_strings
AutoDeleteSmallVector< LanguageStrings *, 4 > raw_strings
The raw strings per language, first must be English/the master language!.
Definition: game_text.hpp:35
GameStrings::compiled_strings
AutoDeleteSmallVector< LanguageStrings *, 4 > compiled_strings
The compiled strings per language, first must be English/the master language!.
Definition: game_text.hpp:36
RegisterGameTranslation
void RegisterGameTranslation(class Squirrel *engine)
Register the current translation to the Squirrel engine.
Definition: game_text.cpp:351
LanguageStrings::LanguageStrings
LanguageStrings(const char *language, const char *end=NULL)
Create a new container for language strings.
Definition: game_text.cpp:67
GameStrings::version
uint version
The version of the language strings.
Definition: game_text.hpp:32
AutoDeleteSmallVector< LanguageStrings *, 4 >
LanguageStrings
Container for the raw (unencoded) language strings of a language.
Definition: game_text.hpp:22
LanguageStrings::lines
StringList lines
The lines of the file to pass into the parser/encoder.
Definition: game_text.hpp:24
AutoFreeSmallVector< char *, 4 >
ReconsiderGameScriptLanguage
void ReconsiderGameScriptLanguage()
Reconsider the game script language, so we use the right one.
Definition: game_text.cpp:377
LanguageStrings::~LanguageStrings
~LanguageStrings()
Free everything.
Definition: game_text.cpp:73
Squirrel
Definition: squirrel.hpp:23
LanguageStrings::language
const char * language
Name of the language (base filename).
Definition: game_text.hpp:23
GameStrings::string_names
StringList string_names
The names of the compiled strings.
Definition: game_text.hpp:37