OpenTTD
Functions
townname_func.h File Reference

Town name generator stuff. More...

#include "townname_type.h"

Go to the source code of this file.

Functions

char * GenerateTownNameString (char *buf, const char *last, size_t lang, uint32 seed)
 Generates town name from given seed. More...
 
char * GetTownName (char *buff, const TownNameParams *par, uint32 townnameparts, const char *last)
 Fills buffer with specified town name. More...
 
char * GetTownName (char *buff, const Town *t, const char *last)
 Fills buffer with town's name. More...
 
bool VerifyTownName (uint32 r, const TownNameParams *par, TownNames *town_names=NULL)
 Verifies the town name is valid and unique. More...
 
bool GenerateTownName (uint32 *townnameparts, TownNames *town_names=NULL)
 Generates valid town name. More...
 

Detailed Description

Town name generator stuff.

Definition in file townname_func.h.

Function Documentation

◆ GenerateTownName()

bool GenerateTownName ( uint32 *  townnameparts,
TownNames *  town_names 
)

Generates valid town name.

Parameters
townnamepartsif a name is generated, it's stored there
town_namesif a name is generated, check its uniqueness with the set
Returns
true iff a name was generated

Definition at line 122 of file townname.cpp.

References _generating_world, _settings_game, GameSettings::game_creation, Layouter::ReduceLineCache(), and GameCreationSettings::town_name.

◆ GenerateTownNameString()

char* GenerateTownNameString ( char *  buf,
const char *  last,
size_t  lang,
uint32  seed 
)

Generates town name from given seed.

a language.

Parameters
bufoutput buffer
lastend of buffer
langtown name language
seedgeneration seed
Returns
last character ('/0')

Definition at line 1055 of file townname.cpp.

◆ GetTownName() [1/2]

char* GetTownName ( char *  buff,
const TownNameParams par,
uint32  townnameparts,
const char *  last 
)

Fills buffer with specified town name.

Parameters
buffbuffer start
partown name parameters
townnameparts'encoded' town name
lastend of buffer
Returns
pointer to terminating '\0'

Definition at line 51 of file townname.cpp.

References GetStringWithArgs(), TownNameParams::grfid, and TownNameParams::type.

Referenced by GetTownName(), and VerifyTownName().

◆ GetTownName() [2/2]

char* GetTownName ( char *  buff,
const Town t,
const char *  last 
)

Fills buffer with town's name.

Parameters
buffbuffer start
twe want to get name of this town
lastend of buffer
Returns
pointer to terminating '\0'

Definition at line 70 of file townname.cpp.

References GetTownName().

◆ VerifyTownName()

bool VerifyTownName ( uint32  r,
const TownNameParams par,
TownNames *  town_names 
)

Verifies the town name is valid and unique.

Parameters
rrandom bits
partown name parameters
town_namesif a name is generated, check its uniqueness with the set
Returns
true iff name is valid and unique

Definition at line 84 of file townname.cpp.

References GetTownName(), lastof, MAX_CHAR_LENGTH, MAX_LENGTH_TOWN_NAME_CHARS, and Utf8StringLength().