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/>.
8 /** @file industry_map.h Accessors for industries */
10 #ifndef INDUSTRY_MAP_H
11 #define INDUSTRY_MAP_H
13 #include "industrytype.h"
14 #include "water_map.h"
18 * The following enums are indices used to know what to draw for this industry tile.
19 * They all are pointing toward array _industry_draw_tile_data, in table/industry_land.h
20 * How to calculate the correct position ? GFXid << 2 | IndustryStage (0 to 3)
22 enum IndustryGraphics
{
23 GFX_COAL_MINE_TOWER_NOT_ANIMATED
= 0,
24 GFX_COAL_MINE_TOWER_ANIMATED
= 1,
25 GFX_POWERPLANT_CHIMNEY
= 8,
26 GFX_POWERPLANT_SPARKS
= 10,
32 GFX_OILWELL_NOT_ANIMATED
= 29,
33 GFX_OILWELL_ANIMATED_1
= 30,
34 GFX_OILWELL_ANIMATED_2
= 31,
35 GFX_OILWELL_ANIMATED_3
= 32,
36 GFX_COPPER_MINE_TOWER_NOT_ANIMATED
= 47,
37 GFX_COPPER_MINE_TOWER_ANIMATED
= 48,
38 GFX_COPPER_MINE_CHIMNEY
= 49,
39 GFX_GOLD_MINE_TOWER_NOT_ANIMATED
= 79,
40 GFX_GOLD_MINE_TOWER_ANIMATED
= 88,
41 GFX_TOY_FACTORY
= 143,
42 GFX_PLASTIC_FOUNTAIN_ANIMATED_1
= 148,
43 GFX_PLASTIC_FOUNTAIN_ANIMATED_2
= 149,
44 GFX_PLASTIC_FOUNTAIN_ANIMATED_3
= 150,
45 GFX_PLASTIC_FOUNTAIN_ANIMATED_4
= 151,
46 GFX_PLASTIC_FOUNTAIN_ANIMATED_5
= 152,
47 GFX_PLASTIC_FOUNTAIN_ANIMATED_6
= 153,
48 GFX_PLASTIC_FOUNTAIN_ANIMATED_7
= 154,
49 GFX_PLASTIC_FOUNTAIN_ANIMATED_8
= 155,
50 GFX_BUBBLE_GENERATOR
= 161,
51 GFX_BUBBLE_CATCHER
= 162,
52 GFX_TOFFEE_QUARY
= 165,
53 GFX_SUGAR_MINE_SIEVE
= 174,
54 GFX_WATERTILE_SPECIALCHECK
= 255, ///< not really a tile, but rather a very special check
58 * Get the industry ID of the given tile
59 * @param t the tile to get the industry ID from
60 * @pre IsTileType(t, MP_INDUSTRY)
61 * @return the industry ID
63 inline IndustryID
GetIndustryIndex(Tile t
)
65 assert(IsTileType(t
, MP_INDUSTRY
));
70 * Is this industry tile fully built?
71 * @param t the tile to analyze
72 * @pre IsTileType(t, MP_INDUSTRY)
73 * @return true if and only if the industry tile is fully built
75 inline bool IsIndustryCompleted(Tile t
)
77 assert(IsTileType(t
, MP_INDUSTRY
));
78 return HasBit(t
.m1(), 7);
81 IndustryType
GetIndustryType(Tile tile
);
84 * Set if the industry that owns the tile as under construction or not
85 * @param tile the tile to query
86 * @pre IsTileType(tile, MP_INDUSTRY)
88 inline void SetIndustryCompleted(Tile tile
)
90 assert(IsTileType(tile
, MP_INDUSTRY
));
91 SB(tile
.m1(), 7, 1, 1);
95 * Returns the industry construction stage of the specified tile
96 * @param tile the tile to query
97 * @pre IsTileType(tile, MP_INDUSTRY)
98 * @return the construction stage
100 inline byte
GetIndustryConstructionStage(Tile tile
)
102 assert(IsTileType(tile
, MP_INDUSTRY
));
103 return IsIndustryCompleted(tile
) ? (byte
)INDUSTRY_COMPLETED
: GB(tile
.m1(), 0, 2);
107 * Sets the industry construction stage of the specified tile
108 * @param tile the tile to query
109 * @param value the new construction stage
110 * @pre IsTileType(tile, MP_INDUSTRY)
112 inline void SetIndustryConstructionStage(Tile tile
, byte value
)
114 assert(IsTileType(tile
, MP_INDUSTRY
));
115 SB(tile
.m1(), 0, 2, value
);
119 * Get the industry graphics ID for the given industry tile as
120 * stored in the without translation.
121 * @param t the tile to get the gfx for
122 * @pre IsTileType(t, MP_INDUSTRY)
125 inline IndustryGfx
GetCleanIndustryGfx(Tile t
)
127 assert(IsTileType(t
, MP_INDUSTRY
));
128 return t
.m5() | (GB(t
.m6(), 2, 1) << 8);
132 * Get the industry graphics ID for the given industry tile
133 * @param t the tile to get the gfx for
134 * @pre IsTileType(t, MP_INDUSTRY)
137 inline IndustryGfx
GetIndustryGfx(Tile t
)
139 assert(IsTileType(t
, MP_INDUSTRY
));
140 return GetTranslatedIndustryTileID(GetCleanIndustryGfx(t
));
144 * Set the industry graphics ID for the given industry tile
145 * @param t the tile to set the gfx for
146 * @pre IsTileType(t, MP_INDUSTRY)
147 * @param gfx the graphics ID
149 inline void SetIndustryGfx(Tile t
, IndustryGfx gfx
)
151 assert(IsTileType(t
, MP_INDUSTRY
));
152 t
.m5() = GB(gfx
, 0, 8);
153 SB(t
.m6(), 2, 1, GB(gfx
, 8, 1));
157 * Returns this industry tile's construction counter value
158 * @param tile the tile to query
159 * @pre IsTileType(tile, MP_INDUSTRY)
160 * @return the construction counter
162 inline byte
GetIndustryConstructionCounter(Tile tile
)
164 assert(IsTileType(tile
, MP_INDUSTRY
));
165 return GB(tile
.m1(), 2, 2);
169 * Sets this industry tile's construction counter value
170 * @param tile the tile to query
171 * @param value the new value for the construction counter
172 * @pre IsTileType(tile, MP_INDUSTRY)
174 inline void SetIndustryConstructionCounter(Tile tile
, byte value
)
176 assert(IsTileType(tile
, MP_INDUSTRY
));
177 SB(tile
.m1(), 2, 2, value
);
181 * Reset the construction stage counter of the industry,
182 * as well as the completion bit.
183 * In fact, it is the same as restarting construction frmo ground up
184 * @param tile the tile to query
185 * @pre IsTileType(tile, MP_INDUSTRY)
187 inline void ResetIndustryConstructionStage(Tile tile
)
189 assert(IsTileType(tile
, MP_INDUSTRY
));
190 SB(tile
.m1(), 0, 4, 0);
191 SB(tile
.m1(), 7, 1, 0);
195 * Get the animation loop number
196 * @param tile the tile to get the animation loop number of
197 * @pre IsTileType(tile, MP_INDUSTRY)
199 inline byte
GetIndustryAnimationLoop(Tile tile
)
201 assert(IsTileType(tile
, MP_INDUSTRY
));
206 * Set the animation loop number
207 * @param tile the tile to set the animation loop number of
208 * @param count the new animation frame number
209 * @pre IsTileType(tile, MP_INDUSTRY)
211 inline void SetIndustryAnimationLoop(Tile tile
, byte count
)
213 assert(IsTileType(tile
, MP_INDUSTRY
));
218 * Get the random bits for this tile.
219 * Used for grf callbacks
220 * @param tile the tile to query
221 * @pre IsTileType(tile, MP_INDUSTRY)
222 * @return requested bits
224 inline byte
GetIndustryRandomBits(Tile tile
)
226 assert(IsTileType(tile
, MP_INDUSTRY
));
231 * Set the random bits for this tile.
232 * Used for grf callbacks
233 * @param tile the tile to query
234 * @param bits the random bits
235 * @pre IsTileType(tile, MP_INDUSTRY)
237 inline void SetIndustryRandomBits(Tile tile
, byte bits
)
239 assert(IsTileType(tile
, MP_INDUSTRY
));
244 * Get the activated triggers bits for this industry tile
245 * Used for grf callbacks
246 * @param tile the tile to query
247 * @pre IsTileType(tile, MP_INDUSTRY)
248 * @return requested triggers
250 inline byte
GetIndustryTriggers(Tile tile
)
252 assert(IsTileType(tile
, MP_INDUSTRY
));
253 return GB(tile
.m6(), 3, 3);
258 * Set the activated triggers bits for this industry tile
259 * Used for grf callbacks
260 * @param tile the tile to query
261 * @param triggers the triggers to set
262 * @pre IsTileType(tile, MP_INDUSTRY)
264 inline void SetIndustryTriggers(Tile tile
, byte triggers
)
266 assert(IsTileType(tile
, MP_INDUSTRY
));
267 SB(tile
.m6(), 3, 3, triggers
);
271 * Make the given tile an industry tile
272 * @param t the tile to make an industry tile
273 * @param index the industry this tile belongs to
274 * @param gfx the graphics to use for the tile
275 * @param random the random value
276 * @param wc the water class for this industry; only useful when build on water
278 inline void MakeIndustry(Tile t
, IndustryID index
, IndustryGfx gfx
, uint8_t random
, WaterClass wc
)
280 SetTileType(t
, MP_INDUSTRY
);
283 SetIndustryRandomBits(t
, random
); // m3
285 SetIndustryGfx(t
, gfx
); // m5, part of m6
286 SetIndustryTriggers(t
, 0); // rest of m6
287 SetWaterClass(t
, wc
);
291 #endif /* INDUSTRY_MAP_H */