OpenTTD Source  20241108-master-g80f628063a
LanguageMap Struct Reference

Mapping of language data between a NewGRF and OpenTTD. More...

#include <newgrf_text_type.h>

Data Structures

struct  Mapping
 Mapping between NewGRF and OpenTTD IDs. More...
 

Public Member Functions

int GetMapping (int newgrf_id, bool gender) const
 Get the mapping from the NewGRF supplied ID to OpenTTD's internal ID. More...
 
int GetReverseMapping (int openttd_id, bool gender) const
 Get the mapping from OpenTTD's internal ID to the NewGRF supplied ID. More...
 

Static Public Member Functions

static const LanguageMapGetLanguageMap (uint32_t grfid, uint8_t language_id)
 Get the language map associated with a given NewGRF and language. More...
 

Data Fields

std::vector< Mappinggender_map
 Mapping of NewGRF and OpenTTD IDs for genders.
 
std::vector< Mappingcase_map
 Mapping of NewGRF and OpenTTD IDs for cases.
 
int plural_form
 The plural form used for this language.
 

Detailed Description

Mapping of language data between a NewGRF and OpenTTD.

Definition at line 28 of file newgrf_text_type.h.

Member Function Documentation

◆ GetLanguageMap()

const LanguageMap * LanguageMap::GetLanguageMap ( uint32_t  grfid,
uint8_t  language_id 
)
static

Get the language map associated with a given NewGRF and language.

Parameters
grfidThe NewGRF to get the map for.
language_idThe (NewGRF) language ID to get the map for.
Returns
The LanguageMap, or nullptr if it couldn't be found.

Definition at line 2662 of file newgrf.cpp.

References GetFileByGRFID(), and GRFFile::language_map.

◆ GetMapping()

int LanguageMap::GetMapping ( int  newgrf_id,
bool  gender 
) const

Get the mapping from the NewGRF supplied ID to OpenTTD's internal ID.

Parameters
newgrf_idThe NewGRF ID to map.
genderWhether to map genders or cases.
Returns
The, to OpenTTD's internal ID, mapped index, or -1 if there is no mapping.

Definition at line 83 of file newgrf_text.cpp.

References case_map, and gender_map.

◆ GetReverseMapping()

int LanguageMap::GetReverseMapping ( int  openttd_id,
bool  gender 
) const

Get the mapping from OpenTTD's internal ID to the NewGRF supplied ID.

Parameters
openttd_idThe OpenTTD ID to map.
genderWhether to map genders or cases.
Returns
The, to the NewGRF supplied ID, mapped index, or -1 if there is no mapping.

Definition at line 98 of file newgrf_text.cpp.

References case_map, and gender_map.


The documentation for this struct was generated from the following files: