belugas@6835: /* $Id$ */ belugas@6835: belugas@6835: /** @file newgrf_industries.cpp */ belugas@6835: belugas@6835: #include "stdafx.h" belugas@6835: #include "openttd.h" belugas@6835: #include "debug.h" belugas@6835: #include "functions.h" belugas@6835: #include "macros.h" rubidium@7207: #include "variables.h" rubidium@7207: #include "landscape.h" rubidium@7207: #include "table/strings.h" belugas@6835: #include "industry.h" belugas@6868: #include "industry_map.h" belugas@6835: #include "newgrf.h" belugas@6835: #include "newgrf_callbacks.h" belugas@6835: #include "newgrf_spritegroup.h" belugas@6835: #include "newgrf_industries.h" belugas@6835: #include "newgrf_commons.h" rubidium@7207: #include "newgrf_text.h" rubidium@7207: #include "newgrf_town.h" rubidium@7186: #include "date.h" belugas@6835: belugas@6835: /* Since the industry IDs defined by the GRF file don't necessarily correlate belugas@6835: * to those used by the game, the IDs used for overriding old industries must be belugas@6835: * translated when the idustry spec is set. */ belugas@6835: IndustryOverrideManager _industry_mngr(NEW_INDUSTRYOFFSET, NUM_INDUSTRYTYPES, INVALID_INDUSTRYTYPE); belugas@7000: IndustryTileOverrideManager _industile_mngr(NEW_INDUSTRYTILEOFFSET, NUM_INDUSTRYTILES, INVALID_INDUSTRYTILE); belugas@6835: rubidium@7233: IndustryType MapNewGRFIndustryType(IndustryType grf_type, uint32 grf_id) rubidium@7233: { rubidium@7233: if (grf_type == IT_INVALID) return IT_INVALID; rubidium@7233: if (!HASBIT(grf_type, 7)) return GB(grf_type, 0, 6); rubidium@7233: rubidium@7233: return _industry_mngr.GetID(GB(grf_type, 0, 6), grf_id); rubidium@7233: } rubidium@7233: belugas@6835: /** belugas@6835: * Finds the distance for the closest tile with water/land given a tile belugas@6835: * @param tile the tile to find the distance too belugas@6835: * @param water whether to find water or land belugas@6835: * @note FAILS when an industry should be seen as water belugas@6835: */ belugas@6835: static uint GetClosestWaterDistance(TileIndex tile, bool water) belugas@6835: { belugas@6835: TileIndex t; rubidium@7236: int best_dist; rubidium@7236: for (t = 0; t < MapSize(); t++) { belugas@6835: if (IsTileType(t, MP_WATER) == water) break; belugas@6835: } belugas@6835: best_dist = DistanceManhattan(tile, t); belugas@6835: belugas@6835: for (; t < MapSize(); t++) { rubidium@7236: int dist = DistanceManhattan(tile, t); belugas@6835: if (dist < best_dist) { belugas@6835: if (IsTileType(t, MP_WATER) == water) best_dist = dist; belugas@6835: } else { belugas@6835: /* When the Y distance between the current row and the 'source' tile belugas@6835: * is larger than the best distance, we've found the best distance */ rubidium@7236: if ((int)TileY(t) - (int)TileY(tile) > best_dist) break; belugas@6835: if (TileX(tile) > TileX(t)) { belugas@6835: /* We can safely skip this many tiles; from here all tiles have a belugas@6835: * higher or equal distance than the best distance */ belugas@6835: t |= MapMaxX(); belugas@6835: continue; belugas@6835: } else { belugas@6835: /* We can safely skip this many tiles; up to here all tiles have a belugas@6835: * higher or equal distance than the best distance */ rubidium@7236: t += max(best_dist - dist, 0); belugas@6835: continue; belugas@6835: } belugas@6835: } belugas@6835: } belugas@6835: belugas@6835: return best_dist; belugas@6835: } belugas@6835: belugas@6868: /** Make an analysis of a tile and check for its belonging to the same belugas@6868: * industry, and/or the same grf file belugas@6868: * @param new_tile TileIndex of the tile to query belugas@6868: * @param old_tile TileINdex of teh reference tile belugas@6868: * @param i Industry to which old_tile belongs to belugas@6868: * @return value encoded as per NFO specs */ belugas@6868: uint32 GetIndustryIDAtOffset(TileIndex new_tile, TileIndex old_tile, const Industry *i) belugas@6868: { belugas@6868: if (IsTileType(new_tile, MP_INDUSTRY)) { // Is this an industry tile? belugas@6868: belugas@6868: if (GetIndustryIndex(new_tile) == i->index) { // Does it belong to the same industry? belugas@6868: IndustryGfx gfx = GetIndustryGfx(new_tile); belugas@6868: const IndustryTileSpec *indtsp = GetIndustryTileSpec(gfx); belugas@6868: const IndustryTileSpec *indold = GetIndustryTileSpec(GetIndustryGfx(old_tile)); belugas@6868: belugas@6868: if (gfx < NEW_INDUSTRYOFFSET) { // Does it belongs to an old type? belugas@6868: /* It is an old tile. We have to see if it's been overriden */ belugas@6868: if (indtsp->grf_prop.override == INVALID_INDUSTRYTILE) { // has it been overridden? belugas@6868: return 0xFF << 8 | gfx; // no. Tag FF + the gfx id of that tile belugas@6868: } else { // yes. FInd out if it is from the same grf file or not belugas@6868: const IndustryTileSpec *old_tile_ovr = GetIndustryTileSpec(indtsp->grf_prop.override); belugas@6868: belugas@6868: if (old_tile_ovr->grf_prop.grffile->grfid == indold->grf_prop.grffile->grfid) { belugas@6868: return old_tile_ovr->grf_prop.local_id; // same grf file belugas@6868: } else { belugas@6868: return 0xFFFE; // not the same grf file belugas@6868: } belugas@6868: } belugas@6868: } else { belugas@6868: if (indtsp->grf_prop.spritegroup != NULL) { // tile has a spritegroup ? belugas@6868: if (indtsp->grf_prop.grffile->grfid == indold->grf_prop.grffile->grfid) { // same industry, same grf ? belugas@6868: return indtsp->grf_prop.local_id; belugas@6868: } else { belugas@6868: return 0xFFFE; // Defined in another grf file belugas@6868: } belugas@6868: } else { // tile has no spritegroup belugas@6868: return 0xFF << 8 | indtsp->grf_prop.subst_id; // so just give him the substitute belugas@6868: } belugas@6868: } belugas@6868: } belugas@6868: } belugas@6868: belugas@6868: return 0xFFFF; // tile is not an industry one or does not belong to the current industry belugas@6868: } belugas@6868: rubidium@7233: static uint32 GetClosestIndustry(TileIndex tile, IndustryType type, const Industry *current) rubidium@7233: { rubidium@7233: uint32 best_dist = MAX_UVALUE(uint32); rubidium@7233: const Industry *i; rubidium@7233: FOR_ALL_INDUSTRIES(i) { rubidium@7233: if (i->type != type || i == current) continue; rubidium@7233: rubidium@7233: best_dist = min(best_dist, DistanceManhattan(tile, i->xy)); rubidium@7233: } rubidium@7233: rubidium@7233: return best_dist; rubidium@7233: } rubidium@7233: belugas@6835: /** This function implements the industries variables that newGRF defines. belugas@6835: * @param variable that is queried belugas@6835: * @param parameter unused belugas@6835: * @param available will return false if ever the variable asked for does not exist belugas@6835: * @param ind is of course the industry we are inquiring belugas@6835: * @return the value stored in the corresponding variable*/ belugas@6835: uint32 IndustryGetVariable(const ResolverObject *object, byte variable, byte parameter, bool *available) belugas@6835: { belugas@6835: const Industry *industry = object->u.industry.ind; rubidium@7207: TileIndex tile = object->u.industry.tile; belugas@6835: const IndustrySpec *indspec = GetIndustrySpec(industry->type); belugas@6835: belugas@6835: switch (variable) { belugas@6835: case 0x40: belugas@6835: case 0x41: belugas@6835: case 0x42: { // waiting cargo, but only if those two callback flags are set belugas@6835: uint16 callback = indspec->callback_flags; rubidium@7166: if (HASBIT(callback, CBM_IND_PRODUCTION_CARGO_ARRIVAL) || HASBIT(callback, CBM_IND_PRODUCTION_256_TICKS)) { rubidium@7191: return min(industry->incoming_cargo_waiting[variable - 0x40], (uint16)0xFFFF); belugas@6835: } else { belugas@6835: return 0; belugas@6835: } belugas@6835: } rubidium@7207: rubidium@7207: /* Manhattan distance of closes dry/water tile */ rubidium@7207: case 0x43: return GetClosestWaterDistance(tile, (object->u.industry_location.spec->behaviour & INDUSTRYBEH_BUILT_ONWATER) == 0); belugas@6835: belugas@6868: /* Get industry ID at offset param */ belugas@6868: case 0x60: return GetIndustryIDAtOffset(GetNearbyTile(parameter, industry->xy), tile, industry); belugas@6835: belugas@6835: case 0x61: return 0; // Get random tile bits at offset param belugas@6835: rubidium@7234: /* Land info of nearby tiles */ rubidium@7234: case 0x62: return GetNearbyIndustryTileInformation(parameter, tile, INVALID_INDUSTRY); rubidium@7234: rubidium@7234: /* Animation stage of nearby tiles */ rubidium@7234: case 0x63 : { rubidium@7234: tile = GetNearbyTile(parameter, tile); rubidium@7234: if (IsTileType(tile, MP_INDUSTRY) && GetIndustryByTile(tile) == industry) { rubidium@7234: return GetIndustryAnimationState(tile); rubidium@7234: } rubidium@7234: return 0xFFFFFFFF; rubidium@7234: } rubidium@7234: rubidium@7234: /* Distance of nearest industry of given type */ rubidium@7233: case 0x64: return GetClosestIndustry(tile, MapNewGRFIndustryType(parameter, indspec->grf_prop.grffile->grfid), industry); // Distance of nearest industry of given type belugas@6835: /* Get town zone and Manhattan distance of closest town */ belugas@6835: case 0x65: return GetTownRadiusGroup(industry->town, tile) << 16 | min(DistanceManhattan(tile, industry->town->xy), 0xFFFF); belugas@6835: /* Get square of Euclidian distance of closes town */ belugas@6835: case 0x66: return GetTownRadiusGroup(industry->town, tile) << 16 | min(DistanceSquare(tile, industry->town->xy), 0xFFFF); belugas@6835: belugas@6835: /* Count of industry, distance of closest instance belugas@6835: * format is rr(reserved) cc(count) dddd(manhattan distance of closest sister) belugas@6835: * A lot more should be done, since it has to check for local id, grf id etc... belugas@6835: * let's just say it is a beginning ;) */ belugas@6835: case 0x67: return GetIndustryTypeCount(industry->type) << 16 | 0; belugas@6835: belugas@6835: /* Industry structure access*/ belugas@6835: case 0x80: return industry->xy; belugas@6835: case 0x81: return GB(industry->xy, 8, 8); belugas@6835: /* Pointer to the town the industry is associated with */ rubidium@7191: case 0x82: return industry->town->index; belugas@6835: case 0x83: belugas@6835: case 0x84: rubidium@7186: case 0x85: DEBUG(grf, 0, "NewGRFs shouldn't be doing pointer magic"); break; // not supported belugas@6835: case 0x86: return industry->width; belugas@6835: case 0x87: return industry->height;// xy dimensions belugas@6835: /* */ belugas@6835: case 0x88: belugas@6835: case 0x89: return indspec->produced_cargo[variable - 0x88]; rubidium@7165: case 0x8A: return industry->produced_cargo_waiting[0]; rubidium@7165: case 0x8B: return GB(industry->produced_cargo_waiting[0], 8, 8); rubidium@7165: case 0x8C: return industry->produced_cargo_waiting[1]; rubidium@7165: case 0x8D: return GB(industry->produced_cargo_waiting[1], 8, 8); belugas@6835: case 0x8E: belugas@6835: case 0x8F: return industry->production_rate[variable - 0x8E]; belugas@6835: case 0x90: belugas@6835: case 0x91: belugas@6835: case 0x92: return indspec->accepts_cargo[variable - 0x90]; belugas@6835: case 0x93: return industry->prod_level; belugas@6835: /* amount of cargo produced so far THIS month. */ belugas@6835: case 0x94: return industry->this_month_production[0]; belugas@6835: case 0x95: return GB(industry->this_month_production[0], 8, 8); belugas@6835: case 0x96: return industry->this_month_production[1]; belugas@6835: case 0x97: return GB(industry->this_month_production[1], 8, 8); belugas@6835: /* amount of cargo transported so far THIS month. */ belugas@6835: case 0x98: return industry->this_month_transported[0]; belugas@6835: case 0x99: return GB(industry->this_month_transported[0], 8, 8); belugas@6835: case 0x9A: return industry->this_month_transported[1]; belugas@6835: case 0x9B: return GB(industry->this_month_transported[0], 8, 8); belugas@6835: /* fraction of cargo transported LAST month. */ belugas@6835: case 0x9C: belugas@6835: case 0x9D: return industry->last_month_pct_transported[variable - 0x9C]; belugas@6835: /* amount of cargo produced LAST month. */ belugas@6835: case 0x9E: return industry->last_month_production[0]; belugas@6835: case 0x9F: return GB(industry->last_month_production[0], 8, 8); belugas@6835: case 0xA0: return industry->last_month_production[1]; belugas@6835: case 0xA1: return GB(industry->last_month_production[1], 8, 8); belugas@6835: /* amount of cargo transported last month. */ belugas@6835: case 0xA2: return industry->last_month_transported[0]; belugas@6835: case 0xA3: return GB(industry->last_month_transported[0], 8, 8); belugas@6835: case 0xA4: return industry->last_month_transported[1]; belugas@6835: case 0xA5: return GB(industry->last_month_transported[0], 8, 8); belugas@6835: belugas@6835: case 0xA6: return industry->type; rubidium@7186: case 0xA7: return industry->founder; belugas@6835: case 0xA8: return industry->random_color; rubidium@7186: case 0xA9: return clamp(0, industry->last_prod_year - 1920, 255); belugas@6835: case 0xAA: return industry->counter; belugas@6835: case 0xAB: return GB(industry->counter, 8, 8); belugas@6835: case 0xAC: return industry->was_cargo_delivered; rubidium@7186: rubidium@7186: case 0xB0: return clamp(0, industry->construction_date - DAYS_TILL_ORIGINAL_BASE_YEAR, 65535); // Date when built since 1920 (in days) rubidium@7186: case 0xB3: return industry->construction_type; // Construction type rubidium@7186: case 0xB4: return clamp(0, industry->last_cargo_accepted_at - DAYS_TILL_ORIGINAL_BASE_YEAR, 65535); // Date last cargo accepted since 1920 (in days) belugas@6835: } belugas@6835: belugas@6835: DEBUG(grf, 1, "Unhandled industry property 0x%X", variable); belugas@6835: belugas@6835: *available = false; belugas@6835: return (uint32)-1; belugas@6835: } belugas@6835: belugas@6835: static const SpriteGroup *IndustryResolveReal(const ResolverObject *object, const SpriteGroup *group) belugas@6835: { belugas@6835: /* IndustryTile do not have 'real' groups */ belugas@6835: return NULL; belugas@6835: } belugas@6835: belugas@6884: static void NewIndustryResolver(ResolverObject *res, TileIndex tile, Industry *indus) belugas@6835: { belugas@6884: res->GetRandomBits = IndustryTileGetRandomBits; belugas@6884: res->GetTriggers = IndustryTileGetTriggers; belugas@6884: res->SetTriggers = IndustryTileSetTriggers; belugas@6835: res->GetVariable = IndustryGetVariable; belugas@6835: res->ResolveReal = IndustryResolveReal; belugas@6835: belugas@6835: res->u.industry.tile = tile; belugas@6835: res->u.industry.ind = indus; belugas@6884: res->u.industry.gfx = INVALID_INDUSTRYTILE; belugas@6835: belugas@6835: res->callback = 0; belugas@6835: res->callback_param1 = 0; belugas@6835: res->callback_param2 = 0; belugas@6835: res->last_value = 0; belugas@6835: res->trigger = 0; belugas@6835: res->reseed = 0; belugas@6835: } belugas@6835: belugas@7102: uint16 GetIndustryCallback(uint16 callback, uint32 param1, uint32 param2, Industry *industry, IndustryType type, TileIndex tile) belugas@6835: { belugas@6835: ResolverObject object; belugas@6835: const SpriteGroup *group; belugas@6835: belugas@6884: NewIndustryResolver(&object, tile, industry); belugas@6835: object.callback = callback; belugas@6835: object.callback_param1 = param1; belugas@6835: object.callback_param2 = param2; belugas@6835: belugas@7102: group = Resolve(GetIndustrySpec(type)->grf_prop.spritegroup, &object); belugas@6835: if (group == NULL || group->type != SGT_CALLBACK) return CALLBACK_FAILED; belugas@6835: belugas@6835: return group->g.callback.result; belugas@6835: } rubidium@7168: rubidium@7207: uint32 IndustryLocationGetVariable(const ResolverObject *object, byte variable, byte parameter, bool *available) rubidium@7207: { rubidium@7207: TileIndex tile = object->u.industry_location.tile; rubidium@7207: rubidium@7207: if (object->scope == VSG_SCOPE_PARENT) { rubidium@7207: return TownGetVariable(variable, parameter, available, ClosestTownFromTile(tile, (uint)-1)); rubidium@7207: } rubidium@7207: rubidium@7207: switch (variable) { rubidium@7234: /* Land info of nearby tiles */ rubidium@7234: case 0x62: return GetNearbyIndustryTileInformation(parameter, tile, INVALID_INDUSTRY); rubidium@7234: rubidium@7234: /* Distance of nearest industry of given type */ rubidium@7234: case 0x64: return GetClosestIndustry(tile, MapNewGRFIndustryType(parameter, object->u.industry_location.spec->grf_prop.grffile->grfid), NULL); rubidium@7207: rubidium@7207: /* Location where to build the industry */ rubidium@7207: case 0x80: return tile; rubidium@7207: case 0x81: return GB(tile, 8, 8); rubidium@7234: rubidium@7207: /* Pointer to the town the industry is associated with */ rubidium@7207: case 0x82: return ClosestTownFromTile(tile, (uint)-1)->index; rubidium@7207: case 0x83: rubidium@7207: case 0x84: rubidium@7207: case 0x85: DEBUG(grf, 0, "NewGRFs shouldn't be doing pointer magic"); break; // not supported rubidium@7207: rubidium@7207: /* Number of the layout */ rubidium@7207: case 0x86: return object->u.industry_location.itspec_index; rubidium@7207: rubidium@7207: /* Ground type */ rubidium@7207: case 0x87: return GetTerrainType(tile); rubidium@7207: rubidium@7207: /* Town zone */ rubidium@7207: case 0x88: return GetTownRadiusGroup(ClosestTownFromTile(tile, (uint)-1), tile); rubidium@7207: rubidium@7207: /* Manhattan distance of the closest town */ rubidium@7207: case 0x89: return min(DistanceManhattan(ClosestTownFromTile(tile, (uint)-1)->xy, tile), 255); rubidium@7207: rubidium@7207: /* Lowest height of the tile */ rubidium@7207: case 0x8A: return GetTileZ(tile); rubidium@7207: rubidium@7207: /* Distance to the nearest water/land tile */ rubidium@7207: case 0x8B: return GetClosestWaterDistance(tile, (object->u.industry_location.spec->behaviour & INDUSTRYBEH_BUILT_ONWATER) == 0); rubidium@7207: rubidium@7207: /* Square of Euclidian distance from town */ rubidium@7207: case 0x8D: return min(DistanceSquare(ClosestTownFromTile(tile, (uint)-1)->xy, tile), 65535); rubidium@7207: } rubidium@7207: rubidium@7233: DEBUG(grf, 1, "Unhandled location industry property 0x%X", variable); rubidium@7207: rubidium@7207: *available = false; rubidium@7207: return (uint32)-1; rubidium@7207: } rubidium@7207: rubidium@7207: bool CheckIfCallBackAllowsCreation(TileIndex tile, IndustryType type, uint itspec_index) rubidium@7207: { rubidium@7207: const IndustrySpec *indspec = GetIndustrySpec(type); rubidium@7207: rubidium@7207: ResolverObject object; rubidium@7207: const SpriteGroup *group; rubidium@7207: rubidium@7207: NewIndustryResolver(&object, tile, NULL); rubidium@7207: object.GetVariable = IndustryLocationGetVariable; rubidium@7207: object.callback = CBID_INDUSTRY_LOCATION; rubidium@7207: object.u.industry_location.tile = tile; rubidium@7207: object.u.industry_location.spec = indspec; rubidium@7207: object.u.industry_location.itspec_index = itspec_index; rubidium@7207: rubidium@7207: group = Resolve(GetIndustrySpec(type)->grf_prop.spritegroup, &object); rubidium@7207: rubidium@7207: if (group == NULL || group->type != SGT_CALLBACK) return false; rubidium@7207: rubidium@7207: switch (group->g.callback.result) { rubidium@7207: case 0x400: return true; rubidium@7209: case 0x401: _error_message = STR_0239_SITE_UNSUITABLE; break; rubidium@7209: case 0x402: _error_message = STR_0317_CAN_ONLY_BE_BUILT_IN_RAINFOREST; break; rubidium@7209: case 0x403: _error_message = STR_0318_CAN_ONLY_BE_BUILT_IN_DESERT; break; rubidium@7209: default: _error_message = GetGRFStringID(indspec->grf_prop.grffile->grfid, 0xD000 + group->g.callback.result); break; rubidium@7207: } rubidium@7207: rubidium@7207: return false; rubidium@7207: } rubidium@7207: belugas@7260: bool CheckIfCallBackAllowsAvailability(IndustryType type, IndustryAvailabilityCallType creation_type) belugas@7260: { belugas@7260: const IndustrySpec *indspec = GetIndustrySpec(type); belugas@7260: belugas@7260: if (HASBIT(indspec->callback_flags, CBM_IND_AVAILABLE)) { belugas@7260: uint16 res = GetIndustryCallback(CBID_INDUSTRY_AVAILABLE, 0, creation_type, NULL, type, INVALID_TILE); belugas@7260: if (res != CALLBACK_FAILED) { belugas@7260: return (res == 0); belugas@7260: } belugas@7260: } belugas@7260: return true; belugas@7260: } belugas@7260: rubidium@7168: static int32 DerefIndProd(uint field, bool use_register) rubidium@7168: { rubidium@7168: return use_register ? (int32)GetRegister(field) : field; rubidium@7168: } rubidium@7168: rubidium@7168: /** rubidium@7168: * Get the industry production callback and apply it to the industry. rubidium@7168: * @param ind the industry this callback has to be called for rubidium@7168: * @param reason the reason it is called (0 = incoming cargo, 1 = periodic tick callback) rubidium@7168: */ rubidium@7168: void IndustryProductionCallback(Industry *ind, int reason) rubidium@7168: { rubidium@7168: ResolverObject object; rubidium@7237: NewIndustryResolver(&object, ind->xy, ind); rubidium@7168: object.callback_param2 = reason; rubidium@7168: rubidium@7168: for (uint loop = 0;; loop++) { rubidium@7168: SB(object.callback_param2, 8, 16, loop); rubidium@7168: const SpriteGroup *group = Resolve(GetIndustrySpec(ind->type)->grf_prop.spritegroup, &object); rubidium@7168: if (group == NULL || group->type != SGT_INDUSTRY_PRODUCTION) break; rubidium@7168: rubidium@7168: bool deref = (group->g.indprod.version == 1); rubidium@7168: rubidium@7168: for (uint i = 0; i < 3; i++) { rubidium@7168: ind->incoming_cargo_waiting[i] = clamp(ind->incoming_cargo_waiting[i] - DerefIndProd(group->g.indprod.substract_input[i], deref), 0, 0xFFFF); rubidium@7168: } rubidium@7168: for (uint i = 0; i < 2; i++) { rubidium@7168: ind->produced_cargo_waiting[i] = clamp(ind->produced_cargo_waiting[i] + DerefIndProd(group->g.indprod.add_output[i], deref), 0, 0xFFFF); rubidium@7168: } rubidium@7168: rubidium@7168: int32 again = DerefIndProd(group->g.indprod.again, deref); rubidium@7168: if (again == 0) break; rubidium@7168: rubidium@7168: SB(object.callback_param2, 24, 8, again); rubidium@7168: } rubidium@7195: rubidium@7195: InvalidateWindow(WC_INDUSTRY_VIEW, ind->index); rubidium@7168: }