Mercurial > hg > openttd

annotate src/townname_type.h @ 15620:f8e9a3f0c140 draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
(svn r20283) -Codechange: Unify start of doygen comments.
author frosch <frosch@openttd.org>
date Sun, 01 Aug 2010 19:22:34 +0000
parents ef8cf99dc344
children 5117fc12b816
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
13110
ef8cf99dc344 (svn r17612) -Feature: possibility to choose (randomise or enter custom) town name before its creation (original patch by Terkhen)
smatz <smatz@openttd.org>
parents:
diff changeset
1 /* $Id$ */
ef8cf99dc344 (svn r17612) -Feature: possibility to choose (randomise or enter custom) town name before its creation (original patch by Terkhen)
smatz <smatz@openttd.org>
parents:
diff changeset
2
ef8cf99dc344 (svn r17612) -Feature: possibility to choose (randomise or enter custom) town name before its creation (original patch by Terkhen)
smatz <smatz@openttd.org>
parents:
diff changeset
3 /*
ef8cf99dc344 (svn r17612) -Feature: possibility to choose (randomise or enter custom) town name before its creation (original patch by Terkhen)
smatz <smatz@openttd.org>
parents:
diff changeset
4 * This file is part of OpenTTD.
ef8cf99dc344 (svn r17612) -Feature: possibility to choose (randomise or enter custom) town name before its creation (original patch by Terkhen)
smatz <smatz@openttd.org>
parents:
diff changeset
5 * 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.
ef8cf99dc344 (svn r17612) -Feature: possibility to choose (randomise or enter custom) town name before its creation (original patch by Terkhen)
smatz <smatz@openttd.org>
parents:
diff changeset
6 * 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.
ef8cf99dc344 (svn r17612) -Feature: possibility to choose (randomise or enter custom) town name before its creation (original patch by Terkhen)
smatz <smatz@openttd.org>
parents:
diff changeset
7 * 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/>.
ef8cf99dc344 (svn r17612) -Feature: possibility to choose (randomise or enter custom) town name before its creation (original patch by Terkhen)
smatz <smatz@openttd.org>
parents:
diff changeset
8 */
ef8cf99dc344 (svn r17612) -Feature: possibility to choose (randomise or enter custom) town name before its creation (original patch by Terkhen)
smatz <smatz@openttd.org>
parents:
diff changeset
9
15620
f8e9a3f0c140 (svn r20283) -Codechange: Unify start of doygen comments.
frosch <frosch@openttd.org>
parents: 13110
diff changeset
10 /**
f8e9a3f0c140 (svn r20283) -Codechange: Unify start of doygen comments.
frosch <frosch@openttd.org>
parents: 13110
diff changeset
11 * @file townname_type.h
13110
ef8cf99dc344 (svn r17612) -Feature: possibility to choose (randomise or enter custom) town name before its creation (original patch by Terkhen)
smatz <smatz@openttd.org>
parents:
diff changeset
12 * Definition of structures used for generating town names.
ef8cf99dc344 (svn r17612) -Feature: possibility to choose (randomise or enter custom) town name before its creation (original patch by Terkhen)
smatz <smatz@openttd.org>
parents:
diff changeset
13 */
ef8cf99dc344 (svn r17612) -Feature: possibility to choose (randomise or enter custom) town name before its creation (original patch by Terkhen)
smatz <smatz@openttd.org>
parents:
diff changeset
14
ef8cf99dc344 (svn r17612) -Feature: possibility to choose (randomise or enter custom) town name before its creation (original patch by Terkhen)
smatz <smatz@openttd.org>
parents:
diff changeset
15 #ifndef TOWNNAME_TYPE_H
ef8cf99dc344 (svn r17612) -Feature: possibility to choose (randomise or enter custom) town name before its creation (original patch by Terkhen)
smatz <smatz@openttd.org>
parents:
diff changeset
16 #define TOWNNAME_TYPE_H
ef8cf99dc344 (svn r17612) -Feature: possibility to choose (randomise or enter custom) town name before its creation (original patch by Terkhen)
smatz <smatz@openttd.org>
parents:
diff changeset
17
ef8cf99dc344 (svn r17612) -Feature: possibility to choose (randomise or enter custom) town name before its creation (original patch by Terkhen)
smatz <smatz@openttd.org>
parents:
diff changeset
18 #include "newgrf_townname.h"
ef8cf99dc344 (svn r17612) -Feature: possibility to choose (randomise or enter custom) town name before its creation (original patch by Terkhen)
smatz <smatz@openttd.org>
parents:
diff changeset
19
ef8cf99dc344 (svn r17612) -Feature: possibility to choose (randomise or enter custom) town name before its creation (original patch by Terkhen)
smatz <smatz@openttd.org>
parents:
diff changeset
20 /**
ef8cf99dc344 (svn r17612) -Feature: possibility to choose (randomise or enter custom) town name before its creation (original patch by Terkhen)
smatz <smatz@openttd.org>
parents:
diff changeset
21 * Struct holding a parameters used to generate town name.
ef8cf99dc344 (svn r17612) -Feature: possibility to choose (randomise or enter custom) town name before its creation (original patch by Terkhen)
smatz <smatz@openttd.org>
parents:
diff changeset
22 * Speeds things up a bit because these values are computed only once per name generation.
ef8cf99dc344 (svn r17612) -Feature: possibility to choose (randomise or enter custom) town name before its creation (original patch by Terkhen)
smatz <smatz@openttd.org>
parents:
diff changeset
23 */
ef8cf99dc344 (svn r17612) -Feature: possibility to choose (randomise or enter custom) town name before its creation (original patch by Terkhen)
smatz <smatz@openttd.org>
parents:
diff changeset
24 struct TownNameParams {
ef8cf99dc344 (svn r17612) -Feature: possibility to choose (randomise or enter custom) town name before its creation (original patch by Terkhen)
smatz <smatz@openttd.org>
parents:
diff changeset
25 uint32 grfid; ///< newgrf ID (0 if not used)
ef8cf99dc344 (svn r17612) -Feature: possibility to choose (randomise or enter custom) town name before its creation (original patch by Terkhen)
smatz <smatz@openttd.org>
parents:
diff changeset
26 uint16 type; ///< town name style
ef8cf99dc344 (svn r17612) -Feature: possibility to choose (randomise or enter custom) town name before its creation (original patch by Terkhen)
smatz <smatz@openttd.org>
parents:
diff changeset
27
ef8cf99dc344 (svn r17612) -Feature: possibility to choose (randomise or enter custom) town name before its creation (original patch by Terkhen)
smatz <smatz@openttd.org>
parents:
diff changeset
28 /**
ef8cf99dc344 (svn r17612) -Feature: possibility to choose (randomise or enter custom) town name before its creation (original patch by Terkhen)
smatz <smatz@openttd.org>
parents:
diff changeset
29 * Initializes this struct from language ID
ef8cf99dc344 (svn r17612) -Feature: possibility to choose (randomise or enter custom) town name before its creation (original patch by Terkhen)
smatz <smatz@openttd.org>
parents:
diff changeset
30 * @param town_name town name 'language' ID
ef8cf99dc344 (svn r17612) -Feature: possibility to choose (randomise or enter custom) town name before its creation (original patch by Terkhen)
smatz <smatz@openttd.org>
parents:
diff changeset
31 */
ef8cf99dc344 (svn r17612) -Feature: possibility to choose (randomise or enter custom) town name before its creation (original patch by Terkhen)
smatz <smatz@openttd.org>
parents:
diff changeset
32 TownNameParams(byte town_name)
ef8cf99dc344 (svn r17612) -Feature: possibility to choose (randomise or enter custom) town name before its creation (original patch by Terkhen)
smatz <smatz@openttd.org>
parents:
diff changeset
33 {
ef8cf99dc344 (svn r17612) -Feature: possibility to choose (randomise or enter custom) town name before its creation (original patch by Terkhen)
smatz <smatz@openttd.org>
parents:
diff changeset
34 extern int _nb_orig_names;
ef8cf99dc344 (svn r17612) -Feature: possibility to choose (randomise or enter custom) town name before its creation (original patch by Terkhen)
smatz <smatz@openttd.org>
parents:
diff changeset
35 bool grf = town_name >= _nb_orig_names;
ef8cf99dc344 (svn r17612) -Feature: possibility to choose (randomise or enter custom) town name before its creation (original patch by Terkhen)
smatz <smatz@openttd.org>
parents:
diff changeset
36 this->grfid = grf ? GetGRFTownNameId(town_name - _nb_orig_names) : 0;
ef8cf99dc344 (svn r17612) -Feature: possibility to choose (randomise or enter custom) town name before its creation (original patch by Terkhen)
smatz <smatz@openttd.org>
parents:
diff changeset
37 this->type = grf ? GetGRFTownNameType(town_name - _nb_orig_names) : SPECSTR_TOWNNAME_START + town_name;
ef8cf99dc344 (svn r17612) -Feature: possibility to choose (randomise or enter custom) town name before its creation (original patch by Terkhen)
smatz <smatz@openttd.org>
parents:
diff changeset
38 }
ef8cf99dc344 (svn r17612) -Feature: possibility to choose (randomise or enter custom) town name before its creation (original patch by Terkhen)
smatz <smatz@openttd.org>
parents:
diff changeset
39
ef8cf99dc344 (svn r17612) -Feature: possibility to choose (randomise or enter custom) town name before its creation (original patch by Terkhen)
smatz <smatz@openttd.org>
parents:
diff changeset
40 TownNameParams(const struct Town *t);
ef8cf99dc344 (svn r17612) -Feature: possibility to choose (randomise or enter custom) town name before its creation (original patch by Terkhen)
smatz <smatz@openttd.org>
parents:
diff changeset
41 };
ef8cf99dc344 (svn r17612) -Feature: possibility to choose (randomise or enter custom) town name before its creation (original patch by Terkhen)
smatz <smatz@openttd.org>
parents:
diff changeset
42
ef8cf99dc344 (svn r17612) -Feature: possibility to choose (randomise or enter custom) town name before its creation (original patch by Terkhen)
smatz <smatz@openttd.org>
parents:
diff changeset
43 #endif /* TOWNNAME_TYPE_H */