belugas@7380: /* $Id$ */ belugas@7380: belugas@7380: /** @file newgrf_industrytiles.cpp */ belugas@7380: belugas@7380: #include "stdafx.h" belugas@7380: #include "openttd.h" belugas@7380: #include "variables.h" belugas@7380: #include "debug.h" rubidium@8721: #include "viewport_func.h" belugas@7380: #include "landscape.h" belugas@7380: #include "newgrf.h" belugas@7380: #include "industry.h" belugas@7380: #include "newgrf_commons.h" belugas@7380: #include "newgrf_spritegroup.h" belugas@7380: #include "newgrf_callbacks.h" belugas@7380: #include "newgrf_industries.h" rubidium@7725: #include "newgrf_industrytiles.h" rubidium@7708: #include "newgrf_text.h" belugas@7380: #include "industry_map.h" belugas@7380: #include "clear_map.h" belugas@7380: #include "sprite.h" belugas@8345: #include "transparency.h" rubidium@8627: #include "functions.h" rubidium@8709: #include "town.h" rubidium@8771: #include "command_func.h" belugas@7380: rubidium@8760: #include "table/sprites.h" rubidium@8760: #include "table/strings.h" rubidium@8760: rubidium@8586: static uint32 GetGRFParameter(IndustryGfx indtile_id, byte parameter) rubidium@8586: { rubidium@8586: const IndustryTileSpec *indtspec = GetIndustryTileSpec(indtile_id); rubidium@8586: const GRFFile *file = indtspec->grf_prop.grffile; rubidium@8586: rubidium@8586: if (parameter >= file->param_end) return 0; rubidium@8586: return file->param[parameter]; rubidium@8586: } rubidium@8586: belugas@7380: /** belugas@7380: * Based on newhouses equivalent, but adapted for newindustries belugas@7380: * @param parameter from callback. It's in fact a pair of coordinates belugas@7380: * @param tile TileIndex from which the callback was initiated belugas@7380: * @param index of the industry been queried for belugas@7380: * @return a construction of bits obeying the newgrf format belugas@7380: */ rubidium@7730: uint32 GetNearbyIndustryTileInformation(byte parameter, TileIndex tile, IndustryID index) belugas@7380: { belugas@7942: if (parameter != 0) tile = GetNearbyTile(parameter, tile); // only perform if it is required frosch@8954: bool is_same_industry = (IsTileType(tile, MP_INDUSTRY) && GetIndustryIndex(tile) == index); belugas@7380: frosch@8954: return GetNearbyTileInformation(tile) | (is_same_industry ? 1 : 0) << 8; belugas@7380: } belugas@7380: belugas@7380: /** This is the position of the tile relative to the northernmost tile of the industry. belugas@7380: * Format: 00yxYYXX belugas@7380: * Variable Content belugas@7380: * x the x offset from the northernmost tile belugas@7380: * XX same, but stored in a byte instead of a nibble belugas@7380: * y the y offset from the northernmost tile belugas@7380: * YY same, but stored in a byte instead of a nibble belugas@7380: * @param tile TileIndex of the tile to evaluate belugas@7380: * @param ind_tile northernmost tile of the industry belugas@7380: */ belugas@7380: static uint32 GetRelativePosition(TileIndex tile, TileIndex ind_tile) belugas@7380: { belugas@7415: byte x = TileX(tile) - TileX(ind_tile); belugas@7415: byte y = TileY(tile) - TileY(ind_tile); belugas@7380: belugas@7380: return ((y & 0xF) << 20) | ((x & 0xF) << 16) | (y << 8) | x; belugas@7380: } belugas@7380: belugas@7380: static uint32 IndustryTileGetVariable(const ResolverObject *object, byte variable, byte parameter, bool *available) belugas@7380: { belugas@7380: const Industry *inds = object->u.industry.ind; belugas@7380: TileIndex tile = object->u.industry.tile; belugas@7380: belugas@7380: if (object->scope == VSG_SCOPE_PARENT) { belugas@7380: return IndustryGetVariable(object, variable, parameter, available); belugas@7380: } belugas@7380: belugas@7380: switch (variable) { belugas@7395: /* Construction state of the tile: a value between 0 and 3 */ belugas@7395: case 0x40 : return (IsTileType(tile, MP_INDUSTRY)) ? GetIndustryConstructionStage(tile) : 0; belugas@7380: belugas@7380: case 0x41 : return GetTerrainType(tile); belugas@7380: belugas@7395: /* Current town zone of the tile in the nearest town */ belugas@7395: case 0x42 : return GetTownRadiusGroup(ClosestTownFromTile(tile, (uint)-1), tile); belugas@7380: belugas@7395: /* Relative position */ belugas@7395: case 0x43 : return GetRelativePosition(tile, inds->xy); belugas@7380: belugas@7395: /* Animation frame. Like house variable 46 but can contain anything 0..FF. */ belugas@7395: case 0x44 : return (IsTileType(tile, MP_INDUSTRY)) ? GetIndustryAnimationState(tile) : 0; belugas@7380: belugas@7395: /* Land info of nearby tiles */ rubidium@7708: case 0x60 : return GetNearbyIndustryTileInformation(parameter, tile, inds == NULL ? (IndustryID)INVALID_INDUSTRY : inds->index); belugas@7380: rubidium@7730: /* Animation stage of nearby tiles */ rubidium@7730: case 0x61 : { belugas@7380: tile = GetNearbyTile(parameter, tile); belugas@7395: if (IsTileType(tile, MP_INDUSTRY) && GetIndustryByTile(tile) == inds) { belugas@7395: return GetIndustryAnimationState(tile); belugas@7395: } belugas@7395: return 0xFFFFFFFF; belugas@7380: } belugas@7380: belugas@7380: /* Get industry tile ID at offset */ rubidium@8118: case 0x62 : return GetIndustryIDAtOffset(GetNearbyTile(parameter, tile), inds); rubidium@8586: rubidium@8586: /* Read GRF parameter */ rubidium@8586: case 0x7F: return GetGRFParameter(GetIndustryGfx(tile), parameter); belugas@7380: } belugas@7380: rubidium@7729: DEBUG(grf, 1, "Unhandled industry tile property 0x%X", variable); rubidium@7729: rubidium@7729: *available = false; rubidium@7729: return (uint32)-1; belugas@7380: } belugas@7380: belugas@7380: static const SpriteGroup *IndustryTileResolveReal(const ResolverObject *object, const SpriteGroup *group) belugas@7380: { belugas@7380: /* IndustryTile do not have 'real' groups. Or do they?? */ belugas@7380: return NULL; belugas@7380: } belugas@7380: rubidium@8117: static uint32 IndustryTileGetRandomBits(const ResolverObject *object) belugas@7380: { belugas@7380: const TileIndex tile = object->u.industry.tile; rubidium@8117: if (tile == INVALID_TILE || !IsTileType(tile, MP_INDUSTRY)) return 0; rubidium@8356: return (object->scope == VSG_SCOPE_SELF) ? GetIndustryRandomBits(tile) : GetIndustryByTile(tile)->random; belugas@7380: } belugas@7380: rubidium@8117: static uint32 IndustryTileGetTriggers(const ResolverObject *object) belugas@7380: { belugas@7380: const TileIndex tile = object->u.industry.tile; rubidium@8117: if (tile == INVALID_TILE || !IsTileType(tile, MP_INDUSTRY)) return 0; rubidium@8356: return (object->scope == VSG_SCOPE_SELF) ? GetIndustryTriggers(tile) : GetIndustryByTile(tile)->random_triggers; belugas@7380: } belugas@7380: rubidium@8117: static void IndustryTileSetTriggers(const ResolverObject *object, int triggers) belugas@7380: { belugas@7380: const TileIndex tile = object->u.industry.tile; rubidium@8117: if (tile == INVALID_TILE || !IsTileType(tile, MP_INDUSTRY)) return; rubidium@8117: rubidium@8356: if (object->scope == VSG_SCOPE_SELF) { rubidium@8117: SetIndustryTriggers(tile, triggers); rubidium@8117: } else { rubidium@8356: GetIndustryByTile(tile)->random_triggers = triggers; rubidium@8117: } belugas@7380: } belugas@7380: belugas@7380: static void NewIndustryTileResolver(ResolverObject *res, IndustryGfx gfx, TileIndex tile, Industry *indus) belugas@7380: { belugas@7380: res->GetRandomBits = IndustryTileGetRandomBits; belugas@7380: res->GetTriggers = IndustryTileGetTriggers; belugas@7380: res->SetTriggers = IndustryTileSetTriggers; belugas@7380: res->GetVariable = IndustryTileGetVariable; belugas@7380: res->ResolveReal = IndustryTileResolveReal; belugas@7380: rubidium@8106: res->psa = &indus->psa; belugas@7380: res->u.industry.tile = tile; belugas@7380: res->u.industry.ind = indus; belugas@7380: res->u.industry.gfx = gfx; belugas@8736: res->u.industry.type = indus->type; belugas@7380: rubidium@7823: res->callback = CBID_NO_CALLBACK; belugas@7380: res->callback_param1 = 0; belugas@7380: res->callback_param2 = 0; belugas@7380: res->last_value = 0; belugas@7380: res->trigger = 0; belugas@7380: res->reseed = 0; belugas@7380: } belugas@7380: belugas@7466: void IndustryDrawTileLayout(const TileInfo *ti, const SpriteGroup *group, byte rnd_color, byte stage, IndustryGfx gfx) belugas@7466: { belugas@7466: const DrawTileSprites *dts = group->g.layout.dts; belugas@7466: const DrawTileSeqStruct *dtss; belugas@7466: frosch@9067: SpriteID image = dts->ground.sprite; frosch@9067: SpriteID pal = dts->ground.pal; belugas@7466: rubidium@8152: if (IS_CUSTOM_SPRITE(image)) image += stage; rubidium@8152: belugas@7466: if (GB(image, 0, SPRITE_WIDTH) != 0) DrawGroundSprite(image, pal); belugas@7466: belugas@7466: foreach_draw_tile_seq(dtss, dts->seq) { frosch@9066: if (GB(dtss->image.sprite, 0, SPRITE_WIDTH) == 0) continue; belugas@7466: frosch@9066: image = dtss->image.sprite; frosch@9066: pal = dtss->image.pal; belugas@7466: rubidium@8152: if (IS_CUSTOM_SPRITE(image)) image += stage; rubidium@8152: skidd13@8424: if (HasBit(image, PALETTE_MODIFIER_COLOR)) { rubidium@8321: if (pal == 0) { rubidium@8321: pal = GENERAL_SPRITE_COLOR(rnd_color); rubidium@8321: } belugas@7466: } else { belugas@7466: pal = PAL_NONE; belugas@7466: } belugas@7466: belugas@7466: if ((byte)dtss->delta_z != 0x80) { belugas@7466: AddSortableSpriteToDraw( belugas@7466: image, pal, belugas@7466: ti->x + dtss->delta_x, ti->y + dtss->delta_y, belugas@7466: dtss->size_x, dtss->size_y, rubidium@7829: dtss->size_z, ti->z + dtss->delta_z, skidd13@8424: !HasBit(image, SPRITE_MODIFIER_OPAQUE) && IsTransparencySet(TO_INDUSTRIES) belugas@7466: ); belugas@7466: } else { belugas@8345: AddChildSpriteScreen(image, pal, (byte)dtss->delta_x, (byte)dtss->delta_y, IsTransparencySet(TO_INDUSTRIES)); belugas@7466: } belugas@7466: } belugas@7466: } belugas@7466: rubidium@7823: uint16 GetIndustryTileCallback(CallbackID callback, uint32 param1, uint32 param2, IndustryGfx gfx_id, Industry *industry, TileIndex tile) belugas@7380: { belugas@7380: ResolverObject object; belugas@7380: const SpriteGroup *group; belugas@7380: belugas@7380: NewIndustryTileResolver(&object, gfx_id, tile, industry); belugas@7380: object.callback = callback; belugas@7380: object.callback_param1 = param1; belugas@7380: object.callback_param2 = param2; belugas@7380: belugas@7380: group = Resolve(GetIndustryTileSpec(gfx_id)->grf_prop.spritegroup, &object); belugas@7380: if (group == NULL || group->type != SGT_CALLBACK) return CALLBACK_FAILED; belugas@7380: belugas@7380: return group->g.callback.result; belugas@7380: } belugas@7466: belugas@7466: bool DrawNewIndustryTile(TileInfo *ti, Industry *i, IndustryGfx gfx, const IndustryTileSpec *inds) belugas@7466: { belugas@7466: const SpriteGroup *group; belugas@7466: ResolverObject object; belugas@7466: belugas@7466: if (ti->tileh != SLOPE_FLAT) { belugas@7466: bool draw_old_one = true; skidd13@8424: if (HasBit(inds->callback_flags, CBM_INDT_DRAW_FOUNDATIONS)) { belugas@7466: /* Called to determine the type (if any) of foundation to draw for industry tile */ belugas@7466: uint32 callback_res = GetIndustryTileCallback(CBID_INDUSTRY_DRAW_FOUNDATIONS, 0, 0, gfx, i, ti->tile); rubidium@7704: draw_old_one = callback_res != 0; belugas@7466: } belugas@7466: rubidium@7831: if (draw_old_one) DrawFoundation(ti, FOUNDATION_LEVELED); belugas@7466: } belugas@7466: belugas@7466: NewIndustryTileResolver(&object, gfx, ti->tile, i); belugas@7466: belugas@7466: group = Resolve(inds->grf_prop.spritegroup, &object); belugas@7466: if (group == NULL || group->type != SGT_TILELAYOUT) { belugas@7466: return false; belugas@7466: } else { belugas@7466: /* Limit the building stage to the number of stages supplied. */ belugas@7466: byte stage = GetIndustryConstructionStage(ti->tile); skidd13@8418: stage = Clamp(stage - 4 + group->g.layout.num_sprites, 0, group->g.layout.num_sprites - 1); belugas@7466: IndustryDrawTileLayout(ti, group, i->random_color, stage, gfx); belugas@7466: return true; belugas@7466: } belugas@7466: } rubidium@7708: rubidium@8158: extern bool IsSlopeRefused(Slope current, Slope refused); rubidium@8158: rubidium@8158: bool PerformIndustryTileSlopeCheck(TileIndex ind_base_tile, TileIndex ind_tile, const IndustryTileSpec *its, IndustryType type, IndustryGfx gfx, uint itspec_index) rubidium@7708: { rubidium@7712: Industry ind; rubidium@8158: ind.index = INVALID_INDUSTRY; rubidium@8158: ind.xy = ind_base_tile; belugas@7942: ind.width = 0; rubidium@7712: ind.type = type; rubidium@7712: rubidium@8158: uint16 callback_res = GetIndustryTileCallback(CBID_INDTILE_SHAPE_CHECK, 0, itspec_index, gfx, &ind, ind_tile); rubidium@8158: if (callback_res == CALLBACK_FAILED) { rubidium@8158: return !IsSlopeRefused(GetTileSlope(ind_tile, NULL), its->slopes_refused); rubidium@8158: } rubidium@7708: if (its->grf_prop.grffile->grf_version < 7) { frosch@9182: return (callback_res & 0xFF) != 0; // mask to 8 bit callback result rubidium@7708: } rubidium@7708: rubidium@8246: /* Copy some parameters from the registers to the error message text ref. stack */ rubidium@8246: SwitchToErrorRefStack(); rubidium@8246: PrepareTextRefStackUsage(4); rubidium@8246: SwitchToNormalRefStack(); rubidium@8246: rubidium@7708: switch (callback_res) { rubidium@7708: case 0x400: return true; rubidium@7708: case 0x401: _error_message = STR_0239_SITE_UNSUITABLE; return false; rubidium@7708: case 0x402: _error_message = STR_0317_CAN_ONLY_BE_BUILT_IN_RAINFOREST; return false; rubidium@7708: case 0x403: _error_message = STR_0318_CAN_ONLY_BE_BUILT_IN_DESERT; return false; rubidium@7708: default: _error_message = GetGRFStringID(its->grf_prop.grffile->grfid, 0xD000 + callback_res); return false; rubidium@7708: } rubidium@7708: } rubidium@7725: rubidium@7725: void AnimateNewIndustryTile(TileIndex tile) rubidium@7725: { rubidium@7725: Industry *ind = GetIndustryByTile(tile); rubidium@7725: IndustryGfx gfx = GetIndustryGfx(tile); rubidium@7725: const IndustryTileSpec *itspec = GetIndustryTileSpec(gfx); rubidium@7725: byte animation_speed = itspec->animation_speed; rubidium@7725: skidd13@8424: if (HasBit(itspec->callback_flags, CBM_INDT_ANIM_SPEED)) { rubidium@7725: uint16 callback_res = GetIndustryTileCallback(CBID_INDTILE_ANIMATION_SPEED, 0, 0, gfx, ind, tile); skidd13@8418: if (callback_res != CALLBACK_FAILED) animation_speed = Clamp(callback_res & 0xFF, 0, 16); rubidium@7725: } rubidium@7725: rubidium@7725: /* An animation speed of 2 means the animation frame changes 4 ticks, and rubidium@7725: * increasing this value by one doubles the wait. 0 is the minimum value rubidium@7725: * allowed for animation_speed, which corresponds to 30ms, and 16 is the rubidium@7725: * maximum, corresponding to around 33 minutes. */ rubidium@7725: if ((_tick_counter % (1 << animation_speed)) != 0) return; rubidium@7725: rubidium@7725: bool frame_set_by_callback = false; rubidium@7725: byte frame = GetIndustryAnimationState(tile); belugas@8203: uint16 num_frames = GB(itspec->animation_info, 0, 8); rubidium@7725: skidd13@8424: if (HasBit(itspec->callback_flags, CBM_INDT_ANIM_NEXT_FRAME)) { skidd13@8424: uint16 callback_res = GetIndustryTileCallback(CBID_INDTILE_ANIM_NEXT_FRAME, HasBit(itspec->animation_special_flags, 0) ? Random() : 0, 0, gfx, ind, tile); rubidium@7725: rubidium@7725: if (callback_res != CALLBACK_FAILED) { rubidium@7725: frame_set_by_callback = true; rubidium@7725: rubidium@7725: switch (callback_res & 0xFF) { rubidium@7725: case 0xFF: rubidium@7725: DeleteAnimatedTile(tile); rubidium@7725: break; rubidium@7725: case 0xFE: rubidium@7725: /* Carry on as normal. */ rubidium@7725: frame_set_by_callback = false; rubidium@7725: break; rubidium@7725: default: rubidium@7725: frame = callback_res & 0xFF; rubidium@7725: break; rubidium@7725: } rubidium@7725: } rubidium@7725: } rubidium@7725: rubidium@7725: if (!frame_set_by_callback) { rubidium@7725: if (frame < num_frames) { rubidium@7725: frame++; rubidium@7725: } else if (frame == num_frames && GB(itspec->animation_info, 8, 8) == 1) { rubidium@7725: /* This animation loops, so start again from the beginning */ rubidium@7725: frame = 0; rubidium@7725: } else { rubidium@7725: /* This animation doesn't loop, so stay here */ rubidium@7725: DeleteAnimatedTile(tile); rubidium@7725: } rubidium@7725: } rubidium@7725: rubidium@7725: SetIndustryAnimationState(tile, frame); rubidium@7725: MarkTileDirtyByTile(tile); rubidium@7725: } rubidium@7725: rubidium@7725: static void ChangeIndustryTileAnimationFrame(TileIndex tile, IndustryAnimationTrigger iat, uint32 random_bits, IndustryGfx gfx, Industry *ind) rubidium@7725: { rubidium@7725: uint16 callback_res = GetIndustryTileCallback(CBID_INDTILE_ANIM_START_STOP, random_bits, iat, gfx, ind, tile); rubidium@7725: if (callback_res == CALLBACK_FAILED) return; rubidium@7725: rubidium@7725: switch (callback_res & 0xFF) { rubidium@7725: case 0xFD: /* Do nothing. */ break; rubidium@7725: case 0xFE: AddAnimatedTile(tile); break; rubidium@7725: case 0xFF: DeleteAnimatedTile(tile); break; rubidium@7725: default: rubidium@7725: SetIndustryAnimationState(tile, callback_res & 0xFF); rubidium@7725: AddAnimatedTile(tile); rubidium@7725: break; rubidium@7725: } rubidium@7725: } rubidium@7725: rubidium@7725: bool StartStopIndustryTileAnimation(TileIndex tile, IndustryAnimationTrigger iat, uint32 random) rubidium@7725: { rubidium@7725: IndustryGfx gfx = GetIndustryGfx(tile); rubidium@7725: const IndustryTileSpec *itspec = GetIndustryTileSpec(gfx); rubidium@7725: skidd13@8424: if (!HasBit(itspec->animation_triggers, iat)) return false; rubidium@7725: rubidium@7725: Industry *ind = GetIndustryByTile(tile); rubidium@7725: ChangeIndustryTileAnimationFrame(tile, iat, random, gfx, ind); rubidium@7725: return true; rubidium@7725: } rubidium@7725: rubidium@7725: bool StartStopIndustryTileAnimation(const Industry *ind, IndustryAnimationTrigger iat) rubidium@7725: { rubidium@7725: bool ret = true; rubidium@7725: uint32 random = Random(); rubidium@7725: BEGIN_TILE_LOOP(tile, ind->width, ind->height, ind->xy) rubidium@7725: if (IsTileType(tile, MP_INDUSTRY) && GetIndustryIndex(tile) == ind->index) { rubidium@8123: if (StartStopIndustryTileAnimation(tile, iat, random)) { rubidium@8123: SB(random, 0, 16, Random()); rubidium@8123: } else { rubidium@8123: ret = false; rubidium@8123: } rubidium@7725: } rubidium@7725: END_TILE_LOOP(tile, ind->width, ind->height, ind->xy) rubidium@7725: rubidium@7725: return ret; rubidium@7725: } rubidium@8356: rubidium@8356: static void DoTriggerIndustryTile(TileIndex tile, IndustryTileTrigger trigger, Industry *ind) rubidium@8356: { rubidium@8356: ResolverObject object; rubidium@8356: rubidium@8356: IndustryGfx gfx = GetIndustryGfx(tile); rubidium@8356: const IndustryTileSpec *itspec = GetIndustryTileSpec(gfx); rubidium@8356: rubidium@10323: if (itspec->grf_prop.spritegroup == NULL) return; rubidium@10323: rubidium@8356: NewIndustryTileResolver(&object, gfx, tile, ind); rubidium@8356: rubidium@8356: object.callback = CBID_RANDOM_TRIGGER; rubidium@8356: object.trigger = trigger; rubidium@8356: rubidium@8356: const SpriteGroup *group = Resolve(itspec->grf_prop.spritegroup, &object); rubidium@8356: if (group == NULL) return; rubidium@8356: rubidium@8356: byte new_random_bits = Random(); rubidium@8356: byte random_bits = GetIndustryRandomBits(tile); rubidium@8356: random_bits &= ~object.reseed; rubidium@8356: random_bits |= new_random_bits & object.reseed; rubidium@8356: SetIndustryRandomBits(tile, random_bits); rubidium@8356: } rubidium@8356: rubidium@8356: void TriggerIndustryTile(TileIndex tile, IndustryTileTrigger trigger) rubidium@8356: { rubidium@8356: DoTriggerIndustryTile(tile, trigger, GetIndustryByTile(tile)); rubidium@8356: } rubidium@8356: rubidium@8356: void TriggerIndustry(Industry *ind, IndustryTileTrigger trigger) rubidium@8356: { rubidium@8356: BEGIN_TILE_LOOP(tile, ind->width, ind->height, ind->xy) rubidium@8356: if (IsTileType(tile, MP_INDUSTRY) && GetIndustryIndex(tile) == ind->index) { rubidium@8356: DoTriggerIndustryTile(tile, trigger, ind); rubidium@8356: } rubidium@8356: END_TILE_LOOP(tile, ind->width, ind->height, ind->xy) rubidium@8356: }