OpenTTD Source 20260109-master-g241b5fcdfe
newgrf_townname.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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
6 */
7
10#ifndef NEWGRF_TOWNNAME_H
11#define NEWGRF_TOWNNAME_H
12
13#include "strings_type.h"
14
15struct NamePart {
16 std::string text;
17 uint8_t id;
18 uint8_t prob;
19};
20
22 uint8_t bitstart;
23 uint8_t bitcount;
24 uint16_t maxprob;
25 std::vector<NamePart> parts;
26};
27
30 uint8_t id;
31
32 TownNameStyle(StringID name, uint8_t id) : name(name), id(id) { }
33};
34
36 static const uint MAX_LISTS = 128;
37
38 uint32_t grfid;
39 std::vector<TownNameStyle> styles;
40 std::vector<NamePartList> partlists[MAX_LISTS];
41};
42
43GRFTownName *AddGRFTownName(uint32_t grfid);
44GRFTownName *GetGRFTownName(uint32_t grfid);
45void DelGRFTownName(uint32_t grfid);
46void CleanUpGRFTownNames();
47uint32_t GetGRFTownNameId(uint16_t gen);
48uint16_t GetGRFTownNameType(uint16_t gen);
49StringID GetGRFTownNameName(uint16_t gen);
50
51const std::vector<StringID> &GetGRFTownNameList();
52
53#endif /* NEWGRF_TOWNNAME_H */
Types related to strings.
uint32_t StringID
Numeric value that represents a string, independent of the selected language.
std::vector< NamePartList > partlists[MAX_LISTS]
Lists of town name parts.
static const uint MAX_LISTS
Maximum number of town name lists that can be defined per GRF.
std::vector< TownNameStyle > styles
Style names defined by the Town Name NewGRF.
uint32_t grfid
GRF ID of NewGRF.
uint8_t bitcount
Number of bits of random seed to use.
uint16_t maxprob
Total probability of all parts.
std::vector< NamePart > parts
List of parts to choose from.
uint8_t bitstart
Start of random seed bits to use.
uint8_t prob
The relative probability of the following name to appear in the bottom 7 bits.
uint8_t id
If probability bit 7 is set.
std::string text
If probability bit 7 is clear.
StringID name
String ID of this town name style.
uint8_t id
Index within partlist for this town name style.