OpenTTD Source  20241121-master-g67a0fccfad
game_text.hpp File Reference

Base functions regarding game texts. More...

Go to the source code of this file.

Data Structures

struct  StringParam
 
struct  LanguageStrings
 Container for the raw (unencoded) language strings of a language. More...
 
struct  GameStrings
 Container for all the game strings. More...
 

Typedefs

using StringParams = std::vector< StringParam >
 
using StringParamsList = std::vector< StringParams >
 

Functions

const char * GetGameStringPtr (uint id)
 Get the string pointer of a particular game string. More...
 
const StringParams & GetGameStringParams (uint id)
 Get the string parameters of a particular game string. More...
 
const std::string & GetGameStringName (uint id)
 Get the name of a particular game string. More...
 
void RegisterGameTranslation (class Squirrel *engine)
 Register the current translation to the Squirrel engine. More...
 
void ReconsiderGameScriptLanguage ()
 Reconsider the game script language, so we use the right one.
 

Detailed Description

Base functions regarding game texts.

Definition in file game_text.hpp.

Function Documentation

◆ GetGameStringName()

const std::string& GetGameStringName ( uint  id)

Get the name of a particular game string.

Parameters
idThe ID of the game string.
Returns
The name of the string.

Definition at line 343 of file game_text.cpp.

References _current_data, and GameStrings::string_names.

◆ GetGameStringParams()

const StringParams& GetGameStringParams ( uint  id)

Get the string parameters of a particular game string.

Parameters
idThe ID of the game string.
Returns
The string parameters.

Definition at line 329 of file game_text.cpp.

References _current_data, and GameStrings::string_params.

◆ GetGameStringPtr()

const char* GetGameStringPtr ( uint  id)

Get the string pointer of a particular game string.

Parameters
idThe ID of the game string.
Returns
The encoded string.

Definition at line 318 of file game_text.cpp.

References _current_data, GameStrings::cur_language, and LanguageStrings::lines.

◆ RegisterGameTranslation()

void RegisterGameTranslation ( Squirrel engine)

Register the current translation to the Squirrel engine.

Parameters
engineThe engine to update/

Definition at line 356 of file game_text.cpp.

References _current_data, Squirrel::GetVM(), LoadTranslations(), ReconsiderGameScriptLanguage(), and GameStrings::string_names.

Referenced by GameInstance::RegisterAPI().