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