OpenTTD
newgrf_industrytiles.cpp
Go to the documentation of this file.
1 /* $Id: newgrf_industrytiles.cpp 27928 2017-10-25 15:38:14Z frosch $ */
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 #include "stdafx.h"
13 #include "debug.h"
14 #include "landscape.h"
15 #include "newgrf_industrytiles.h"
16 #include "newgrf_sound.h"
17 #include "industry.h"
18 #include "town.h"
19 #include "command_func.h"
20 #include "water.h"
21 #include "newgrf_animation_base.h"
22 
23 #include "table/strings.h"
24 
25 #include "safeguards.h"
26 
36 uint32 GetNearbyIndustryTileInformation(byte parameter, TileIndex tile, IndustryID index, bool signed_offsets, bool grf_version8)
37 {
38  if (parameter != 0) tile = GetNearbyTile(parameter, tile, signed_offsets); // only perform if it is required
39  bool is_same_industry = (IsTileType(tile, MP_INDUSTRY) && GetIndustryIndex(tile) == index);
40 
41  return GetNearbyTileInformation(tile, grf_version8) | (is_same_industry ? 1 : 0) << 8;
42 }
43 
55 uint32 GetRelativePosition(TileIndex tile, TileIndex ind_tile)
56 {
57  byte x = TileX(tile) - TileX(ind_tile);
58  byte y = TileY(tile) - TileY(ind_tile);
59 
60  return ((y & 0xF) << 20) | ((x & 0xF) << 16) | (y << 8) | x;
61 }
62 
63 /* virtual */ uint32 IndustryTileScopeResolver::GetVariable(byte variable, uint32 parameter, bool *available) const
64 {
65  switch (variable) {
66  /* Construction state of the tile: a value between 0 and 3 */
67  case 0x40: return (IsTileType(this->tile, MP_INDUSTRY)) ? GetIndustryConstructionStage(this->tile) : 0;
68 
69  /* Terrain type */
70  case 0x41: return GetTerrainType(this->tile);
71 
72  /* Current town zone of the tile in the nearest town */
73  case 0x42: return GetTownRadiusGroup(ClosestTownFromTile(this->tile, UINT_MAX), this->tile);
74 
75  /* Relative position */
76  case 0x43: return GetRelativePosition(this->tile, this->industry->location.tile);
77 
78  /* Animation frame. Like house variable 46 but can contain anything 0..FF. */
79  case 0x44: return IsTileType(this->tile, MP_INDUSTRY) ? GetAnimationFrame(this->tile) : 0;
80 
81  /* Land info of nearby tiles */
82  case 0x60: return GetNearbyIndustryTileInformation(parameter, this->tile,
83  this->industry == NULL ? (IndustryID)INVALID_INDUSTRY : this->industry->index, true, this->ro.grffile->grf_version >= 8);
84 
85  /* Animation stage of nearby tiles */
86  case 0x61: {
87  TileIndex tile = GetNearbyTile(parameter, this->tile);
88  if (IsTileType(tile, MP_INDUSTRY) && Industry::GetByTile(tile) == this->industry) {
89  return GetAnimationFrame(tile);
90  }
91  return UINT_MAX;
92  }
93 
94  /* Get industry tile ID at offset */
95  case 0x62: return GetIndustryIDAtOffset(GetNearbyTile(parameter, this->tile), this->industry, this->ro.grffile->grfid);
96  }
97 
98  DEBUG(grf, 1, "Unhandled industry tile variable 0x%X", variable);
99 
100  *available = false;
101  return UINT_MAX;
102 }
103 
104 /* virtual */ uint32 IndustryTileScopeResolver::GetRandomBits() const
105 {
106  assert(this->industry != NULL && IsValidTile(this->tile));
107  assert(this->industry->index == INVALID_INDUSTRY || IsTileType(this->tile, MP_INDUSTRY));
108 
109  return (this->industry->index != INVALID_INDUSTRY) ? GetIndustryRandomBits(this->tile) : 0;
110 }
111 
112 /* virtual */ uint32 IndustryTileScopeResolver::GetTriggers() const
113 {
114  assert(this->industry != NULL && IsValidTile(this->tile));
115  assert(this->industry->index == INVALID_INDUSTRY || IsTileType(this->tile, MP_INDUSTRY));
116  if (this->industry->index == INVALID_INDUSTRY) return 0;
117  return GetIndustryTriggers(this->tile);
118 }
119 
125 static const GRFFile *GetIndTileGrffile(IndustryGfx gfx)
126 {
127  const IndustryTileSpec *its = GetIndustryTileSpec(gfx);
128  return (its != NULL) ? its->grf_prop.grffile : NULL;
129 }
130 
141  CallbackID callback, uint32 callback_param1, uint32 callback_param2)
142  : ResolverObject(GetIndTileGrffile(gfx), callback, callback_param1, callback_param2),
143  indtile_scope(*this, indus, tile),
144  ind_scope(*this, tile, indus, indus->type)
145 {
147 }
148 
156 {
157  this->industry = industry;
158  this->tile = tile;
159 }
160 
161 static void IndustryDrawTileLayout(const TileInfo *ti, const TileLayoutSpriteGroup *group, byte rnd_colour, byte stage, IndustryGfx gfx)
162 {
163  const DrawTileSprites *dts = group->ProcessRegisters(&stage);
164 
165  SpriteID image = dts->ground.sprite;
166  PaletteID pal = dts->ground.pal;
167 
168  if (HasBit(image, SPRITE_MODIFIER_CUSTOM_SPRITE)) image += stage;
169  if (HasBit(pal, SPRITE_MODIFIER_CUSTOM_SPRITE)) pal += stage;
170 
171  if (GB(image, 0, SPRITE_WIDTH) != 0) {
172  /* If the ground sprite is the default flat water sprite, draw also canal/river borders
173  * Do not do this if the tile's WaterClass is 'land'. */
174  if (image == SPR_FLAT_WATER_TILE && IsTileOnWater(ti->tile)) {
175  DrawWaterClassGround(ti);
176  } else {
177  DrawGroundSprite(image, GroundSpritePaletteTransform(image, pal, GENERAL_SPRITE_COLOUR(rnd_colour)));
178  }
179  }
180 
181  DrawNewGRFTileSeq(ti, dts, TO_INDUSTRIES, stage, GENERAL_SPRITE_COLOUR(rnd_colour));
182 }
183 
184 uint16 GetIndustryTileCallback(CallbackID callback, uint32 param1, uint32 param2, IndustryGfx gfx_id, Industry *industry, TileIndex tile)
185 {
186  assert(industry != NULL && IsValidTile(tile));
187  assert(industry->index == INVALID_INDUSTRY || IsTileType(tile, MP_INDUSTRY));
188 
189  IndustryTileResolverObject object(gfx_id, tile, industry, callback, param1, param2);
190  return object.ResolveCallback();
191 }
192 
193 bool DrawNewIndustryTile(TileInfo *ti, Industry *i, IndustryGfx gfx, const IndustryTileSpec *inds)
194 {
195  if (ti->tileh != SLOPE_FLAT) {
196  bool draw_old_one = true;
198  /* Called to determine the type (if any) of foundation to draw for industry tile */
199  uint32 callback_res = GetIndustryTileCallback(CBID_INDTILE_DRAW_FOUNDATIONS, 0, 0, gfx, i, ti->tile);
200  if (callback_res != CALLBACK_FAILED) draw_old_one = ConvertBooleanCallback(inds->grf_prop.grffile, CBID_INDTILE_DRAW_FOUNDATIONS, callback_res);
201  }
202 
203  if (draw_old_one) DrawFoundation(ti, FOUNDATION_LEVELED);
204  }
205 
206  IndustryTileResolverObject object(gfx, ti->tile, i);
207 
208  const SpriteGroup *group = object.Resolve();
209  if (group == NULL || group->type != SGT_TILELAYOUT) return false;
210 
211  /* Limit the building stage to the number of stages supplied. */
212  const TileLayoutSpriteGroup *tlgroup = (const TileLayoutSpriteGroup *)group;
213  byte stage = GetIndustryConstructionStage(ti->tile);
214  IndustryDrawTileLayout(ti, tlgroup, i->random_colour, stage, gfx);
215  return true;
216 }
217 
218 extern bool IsSlopeRefused(Slope current, Slope refused);
219 
233 CommandCost PerformIndustryTileSlopeCheck(TileIndex ind_base_tile, TileIndex ind_tile, const IndustryTileSpec *its, IndustryType type, IndustryGfx gfx, uint itspec_index, uint16 initial_random_bits, Owner founder, IndustryAvailabilityCallType creation_type)
234 {
235  Industry ind;
236  ind.index = INVALID_INDUSTRY;
237  ind.location.tile = ind_base_tile;
238  ind.location.w = 0;
239  ind.type = type;
240  ind.random = initial_random_bits;
241  ind.founder = founder;
242 
243  uint16 callback_res = GetIndustryTileCallback(CBID_INDTILE_SHAPE_CHECK, 0, creation_type << 8 | itspec_index, gfx, &ind, ind_tile);
244  if (callback_res == CALLBACK_FAILED) {
245  if (!IsSlopeRefused(GetTileSlope(ind_tile), its->slopes_refused)) return CommandCost();
246  return_cmd_error(STR_ERROR_SITE_UNSUITABLE);
247  }
248  if (its->grf_prop.grffile->grf_version < 7) {
249  if (callback_res != 0) return CommandCost();
250  return_cmd_error(STR_ERROR_SITE_UNSUITABLE);
251  }
252 
253  return GetErrorMessageFromLocationCallbackResult(callback_res, its->grf_prop.grffile, STR_ERROR_SITE_UNSUITABLE);
254 }
255 
256 /* Simple wrapper for GetHouseCallback to keep the animation unified. */
257 uint16 GetSimpleIndustryCallback(CallbackID callback, uint32 param1, uint32 param2, const IndustryTileSpec *spec, Industry *ind, TileIndex tile, int extra_data)
258 {
259  return GetIndustryTileCallback(callback, param1, param2, spec - GetIndustryTileSpec(0), ind, tile);
260 }
261 
263 struct IndustryAnimationBase : public AnimationBase<IndustryAnimationBase, IndustryTileSpec, Industry, int, GetSimpleIndustryCallback> {
264  static const CallbackID cb_animation_speed = CBID_INDTILE_ANIMATION_SPEED;
265  static const CallbackID cb_animation_next_frame = CBID_INDTILE_ANIM_NEXT_FRAME;
266 
267  static const IndustryTileCallbackMask cbm_animation_speed = CBM_INDT_ANIM_SPEED;
268  static const IndustryTileCallbackMask cbm_animation_next_frame = CBM_INDT_ANIM_NEXT_FRAME;
269 };
270 
271 void AnimateNewIndustryTile(TileIndex tile)
272 {
273  const IndustryTileSpec *itspec = GetIndustryTileSpec(GetIndustryGfx(tile));
274  if (itspec == NULL) return;
275 
277 }
278 
279 bool StartStopIndustryTileAnimation(TileIndex tile, IndustryAnimationTrigger iat, uint32 random)
280 {
281  const IndustryTileSpec *itspec = GetIndustryTileSpec(GetIndustryGfx(tile));
282 
283  if (!HasBit(itspec->animation.triggers, iat)) return false;
284 
286  return true;
287 }
288 
289 bool StartStopIndustryTileAnimation(const Industry *ind, IndustryAnimationTrigger iat)
290 {
291  bool ret = true;
292  uint32 random = Random();
293  TILE_AREA_LOOP(tile, ind->location) {
294  if (ind->TileBelongsToIndustry(tile)) {
295  if (StartStopIndustryTileAnimation(tile, iat, random)) {
296  SB(random, 0, 16, Random());
297  } else {
298  ret = false;
299  }
300  }
301  }
302 
303  return ret;
304 }
305 
313 static void DoTriggerIndustryTile(TileIndex tile, IndustryTileTrigger trigger, Industry *ind, uint32 &reseed_industry)
314 {
315  assert(IsValidTile(tile) && IsTileType(tile, MP_INDUSTRY));
316 
317  IndustryGfx gfx = GetIndustryGfx(tile);
318  const IndustryTileSpec *itspec = GetIndustryTileSpec(gfx);
319 
320  if (itspec->grf_prop.spritegroup[0] == NULL) return;
321 
322  IndustryTileResolverObject object(gfx, tile, ind, CBID_RANDOM_TRIGGER);
323  object.waiting_triggers = GetIndustryTriggers(tile) | trigger;
324  SetIndustryTriggers(tile, object.waiting_triggers); // store now for var 5F
325 
326  const SpriteGroup *group = object.Resolve();
327  if (group == NULL) return;
328 
329  /* Store remaining triggers. */
330  SetIndustryTriggers(tile, object.GetRemainingTriggers());
331 
332  /* Rerandomise tile bits */
333  byte new_random_bits = Random();
334  byte random_bits = GetIndustryRandomBits(tile);
335  random_bits &= ~object.reseed[VSG_SCOPE_SELF];
336  random_bits |= new_random_bits & object.reseed[VSG_SCOPE_SELF];
337  SetIndustryRandomBits(tile, random_bits);
338  MarkTileDirtyByTile(tile);
339 
340  reseed_industry |= object.reseed[VSG_SCOPE_PARENT];
341 }
342 
348 static void DoReseedIndustry(Industry *ind, uint32 reseed)
349 {
350  if (reseed == 0 || ind == NULL) return;
351 
352  uint16 random_bits = Random();
353  ind->random &= reseed;
354  ind->random |= random_bits & reseed;
355 }
356 
363 {
364  uint32 reseed_industry = 0;
365  Industry *ind = Industry::GetByTile(tile);
366  DoTriggerIndustryTile(tile, trigger, ind, reseed_industry);
367  DoReseedIndustry(ind, reseed_industry);
368 }
369 
376 {
377  uint32 reseed_industry = 0;
378  TILE_AREA_LOOP(tile, ind->location) {
379  if (ind->TileBelongsToIndustry(tile)) {
380  DoTriggerIndustryTile(tile, trigger, ind, reseed_industry);
381  }
382  }
383  DoReseedIndustry(ind, reseed_industry);
384 }
385