OpenTTD: src/industrytype.h Source File

OpenTTD

- Main Page
- Related Pages
- Modules
- Namespaces
- Data Structures
- Files

- File List
- Globals

industrytype.h
Go to the documentation of this file.
1 /* $Id: industrytype.h 24900 2013-01-08 22:46:42Z planetmaker $ */
2
3 /*
4 * This file is part of OpenTTD.
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.
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.
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/>.
8 */
9
12 #ifndef INDUSTRYTYPE_H
13 #define INDUSTRYTYPE_H
14
15 #include "map_type.h"
16 #include "slope_type.h"
17 #include "industry_type.h"
18 #include "landscape_type.h"
19 #include "cargo_type.h"
20 #include "newgrf_animation_type.h"
21 #include "newgrf_commons.h"
22
23 enum IndustryCleanupType {
24 CLEAN_RANDOMSOUNDS,
25 CLEAN_TILELAYOUT,
26 };
27
29 enum IndustryLifeType {
30 INDUSTRYLIFE_BLACK_HOLE = 0,
31 INDUSTRYLIFE_EXTRACTIVE = 1 << 0,
32 INDUSTRYLIFE_ORGANIC = 1 << 1,
33 INDUSTRYLIFE_PROCESSING = 1 << 2,
34 };
35
40 enum CheckProc {
41 CHECK_NOTHING,
42 CHECK_FOREST,
43 CHECK_REFINERY,
44 CHECK_FARM,
45 CHECK_PLANTATION,
46 CHECK_WATER,
47 CHECK_LUMBERMILL,
48 CHECK_BUBBLEGEN,
49 CHECK_OIL_RIG,
50 CHECK_END,
51 };
52
54 enum IndustryConstructionType {
55 ICT_UNKNOWN,
56 ICT_NORMAL_GAMEPLAY,
57 ICT_MAP_GENERATION,
58 ICT_SCENARIO_EDITOR,
59 };
60
62 enum IndustryBehaviour {
63 INDUSTRYBEH_NONE = 0,
64 INDUSTRYBEH_PLANT_FIELDS = 1 << 0,
65 INDUSTRYBEH_CUT_TREES = 1 << 1,
66 INDUSTRYBEH_BUILT_ONWATER = 1 << 2,
67 INDUSTRYBEH_TOWN1200_MORE = 1 << 3,
68 INDUSTRYBEH_ONLY_INTOWN = 1 << 4,
69 INDUSTRYBEH_ONLY_NEARTOWN = 1 << 5,
70 INDUSTRYBEH_PLANT_ON_BUILT = 1 << 6,
71 INDUSTRYBEH_DONT_INCR_PROD = 1 << 7,
72 INDUSTRYBEH_BEFORE_1950 = 1 << 8,
73 INDUSTRYBEH_AFTER_1960 = 1 << 9,
74 INDUSTRYBEH_AI_AIRSHIP_ROUTES = 1 << 10,
75 INDUSTRYBEH_AIRPLANE_ATTACKS = 1 << 11,
76 INDUSTRYBEH_CHOPPER_ATTACKS = 1 << 12,
77 INDUSTRYBEH_CAN_SUBSIDENCE = 1 << 13,
78 /* The following flags are only used for newindustries and do no represent any normal behaviour */
79 INDUSTRYBEH_PROD_MULTI_HNDLING = 1 << 14,
80 INDUSTRYBEH_PRODCALLBACK_RANDOM = 1 << 15,
81 INDUSTRYBEH_NOBUILT_MAPCREATION = 1 << 16,
82 INDUSTRYBEH_CANCLOSE_LASTINSTANCE = 1 << 17,
83 };
84 DECLARE_ENUM_AS_BIT_SET(IndustryBehaviour)
85
86
87 enum IndustryTileSpecialFlags {
88 INDTILE_SPECIAL_NONE = 0,
89 INDTILE_SPECIAL_NEXTFRAME_RANDOMBITS = 1 << 0,
90 };
91 DECLARE_ENUM_AS_BIT_SET(IndustryTileSpecialFlags)
92
93 struct IndustryTileTable {
94 TileIndexDiffC ti;
95 IndustryGfx gfx;
96 };
97
101 struct IndustrySpec {
102 const IndustryTileTable * const *table;
103 byte num_table;
104 uint8 cost_multiplier;
105 uint32 removal_cost_multiplier;
106 uint32 prospecting_chance;
107 IndustryType conflicting[3];
108 byte check_proc;
109 CargoID produced_cargo[2];
110 byte production_rate[2];
115 byte minimal_cargo;
116 CargoID accepts_cargo[3];
117 uint16 input_cargo_multiplier[3][2];
118 IndustryLifeType life_type;
119 byte climate_availability;
120 IndustryBehaviour behaviour;
121 byte map_colour;
122 StringID name;
123 StringID new_industry_text;
124 StringID closure_text;
125 StringID production_up_text;
126 StringID production_down_text;
127 StringID station_name;
128 byte appear_ingame[NUM_LANDSCAPE];
129 byte appear_creation[NUM_LANDSCAPE];
130 uint8 number_of_sounds;
131 const uint8 *random_sounds;
132 /* Newgrf data */
133 uint16 callback_mask;
134 uint8 cleanup_flag;
135 bool enabled;
136 GRFFileProps grf_prop;
137
138 bool IsRawIndustry() const;
139 bool IsProcessingIndustry() const;
140 Money GetConstructionCost() const;
141 Money GetRemovalCost() const;
142 bool UsesSmoothEconomy() const;
143 };
144
148 struct IndustryTileSpec {
149 CargoID accepts_cargo[3];
150 uint8 acceptance[3];
151 Slope slopes_refused;
152 byte anim_production;
153 byte anim_next;
154
158 bool anim_state;
159 /* Newgrf data */
160 uint8 callback_mask;
161 AnimationInfo animation;
162 IndustryTileSpecialFlags special_flags;
163 bool enabled;
164 GRFFileProps grf_prop;
165 };
166
167 /* industry_cmd.cpp*/
168 const IndustrySpec *GetIndustrySpec(IndustryType thistype);
169 const IndustryTileSpec *GetIndustryTileSpec(IndustryGfx gfx);
170 void ResetIndustries();
171
172 /* writable arrays of specs */
173 extern IndustrySpec _industry_specs[NUM_INDUSTRYTYPES];
174 extern IndustryTileSpec _industry_tile_specs[NUM_INDUSTRYTILES];
175
176 /* industry_gui.cpp */
177 void SortIndustryTypes();
178 /* Industry types sorted alphabetically by name. */
179 extern IndustryType _sorted_industry_types[NUM_INDUSTRYTYPES];
180
186 static inline IndustryGfx GetTranslatedIndustryTileID(IndustryGfx gfx)
187 {
188 /* the 0xFF should be GFX_WATERTILE_SPECIALCHECK but for reasons of include mess,
189 * we'll simplify the writing.
190 * Basically, the first test is required since the GFX_WATERTILE_SPECIALCHECK value
191 * will never be assigned as a tile index and is only required in order to do some
192 * tests while building the industry (as in WATER REQUIRED */
193 if (gfx != 0xFF) {
194 assert(gfx < INVALID_INDUSTRYTILE);
195 const IndustryTileSpec *it = &_industry_tile_specs[gfx];
196 return it->grf_prop.override == INVALID_INDUSTRYTILE ? gfx : it->grf_prop.override;
197 } else {
198 return gfx;
199 }
200 }
201
202 static const uint8 IT_INVALID = 255;
203
204 #endif /* INDUSTRYTYPE_H */