OpenTTD Source: src/townname_func.h Source File

OpenTTD Source 14.0-RC3

townname_func.h
Go to the documentation of this file.
1 /*
2 * This file is part of OpenTTD.
3 * 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.
4 * 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.
5 * 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/>.
6 */
7
10 #ifndef TOWNNAME_FUNC_H
11 #define TOWNNAME_FUNC_H
12
13 #include "core/random_func.hpp"
14 #include "townname_type.h"
15
16 std::string GetTownName(const TownNameParams *par, uint32_t townnameparts);
17 std::string GetTownName(const Town *t);
18 bool VerifyTownName(uint32_t r, const TownNameParams *par, TownNames *town_names = nullptr);
19 bool GenerateTownName(Randomizer &randomizer, uint32_t *townnameparts, TownNames *town_names = nullptr);
20
21 #endif /* TOWNNAME_FUNC_H */
GetTownName
std::string GetTownName(const TownNameParams *par, uint32_t townnameparts)
Get the town name for the given parameters and parts.
Definition: townname.cpp:65
townname_type.h
Randomizer
Structure to encapsulate the pseudo random number generators.
Definition: random_func.hpp:21
VerifyTownName
bool VerifyTownName(uint32_t r, const TownNameParams *par, TownNames *town_names=nullptr)
Verifies the town name is valid and unique.
Definition: townname.cpp:103
TownNameParams
Struct holding parameters used to generate town name.
Definition: townname_type.h:28
Town
Town data structure.
Definition: town.h:50
random_func.hpp
GenerateTownName
bool GenerateTownName(Randomizer &randomizer, uint32_t *townnameparts, TownNames *town_names=nullptr)
Generates valid town name.
Definition: townname.cpp:136