OpenTTD
Data Structures | Functions
game_text.hpp File Reference

Base functions regarding game texts. More...

#include "../core/smallvec_type.hpp"

Go to the source code of this file.

Data Structures

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

Functions

const char * GetGameStringPtr (uint id)
 Get the string pointer 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

◆ 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 341 of file game_text.cpp.

References GameStrings::cur_language, SmallVector< T, S >::Length(), and LanguageStrings::lines.

◆ RegisterGameTranslation()

void RegisterGameTranslation ( Squirrel engine)

Register the current translation to the Squirrel engine.

Parameters
engineThe engine to update/

Definition at line 351 of file game_text.cpp.

References _current_data, SmallVector< T, S >::Begin(), SmallVector< T, S >::End(), Squirrel::GetVM(), LoadTranslations(), ReconsiderGameScriptLanguage(), and GameStrings::string_names.

Referenced by GameInstance::RegisterAPI().