Codefix: Documentation comment in IndustryDirectoryWindow (#13059)
[openttd-github.git] / src / townname_func.h
blobb3c0a601b54adc36d1c7f7eab1f4dc99c47a3c96
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 */
8 /** @file townname_func.h %Town name generator stuff. */
10 #ifndef TOWNNAME_FUNC_H
11 #define TOWNNAME_FUNC_H
13 #include "core/random_func.hpp"
14 #include "townname_type.h"
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);
21 #endif /* TOWNNAME_FUNC_H */