src/newgrf_industries.h

   1 /* $Id$ */
   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
  10 /** @file newgrf_industries.h Functions for NewGRF industries. */
  11
  12 #ifndef NEWGRF_INDUSTRIES_H
  13 #define NEWGRF_INDUSTRIES_H
  14
  15 #include "newgrf_town.h"
  16
  17 /** Resolver for industry scopes. */
  18 struct IndustriesScopeResolver : public ScopeResolver {
  19         TileIndex tile;     ///< Tile owned by the industry.
  20         Industry *industry; ///< %Industry being resolved.
  21         IndustryType type;  ///< Type of the industry.
  22         uint32 random_bits; ///< Random bits of the new industry.
  23
  24         IndustriesScopeResolver(ResolverObject &ro, TileIndex tile, Industry *industry, IndustryType type, uint32 random_bits = 0);
  25
  26         /* virtual */ uint32 GetRandomBits() const;
  27         /* virtual */ uint32 GetVariable(byte variable, uint32 parameter, bool *available) const;
  28         /* virtual */ uint32 GetTriggers() const;
  29         /* virtual */ void StorePSA(uint pos, int32 value);
  30 };
  31
  32 /** Resolver for industries. */
  33 struct IndustriesResolverObject : public ResolverObject {
  34         IndustriesScopeResolver industries_scope; ///< Scope resolver for the industry.
  35         TownScopeResolver *town_scope;            ///< Scope resolver for the associated town (if needed and available, else \c NULL).
  36
  37         IndustriesResolverObject(TileIndex tile, Industry *indus, IndustryType type, uint32 random_bits = 0,
  38                         CallbackID callback = CBID_NO_CALLBACK, uint32 callback_param1 = 0, uint32 callback_param2 = 0);
  39         ~IndustriesResolverObject();
  40
  41         TownScopeResolver *GetTown();
  42
  43         /* virtual */ ScopeResolver *GetScope(VarSpriteGroupScope scope = VSG_SCOPE_SELF, byte relative = 0)
  44         {
  45                 switch (scope) {
  46                         case VSG_SCOPE_SELF: return &industries_scope;
  47                         case VSG_SCOPE_PARENT: {
  48                                 TownScopeResolver *tsr = this->GetTown();
  49                                 if (tsr != NULL) return tsr;
  50                         }
  51                         FALLTHROUGH;
  52
  53                         default:
  54                                 return ResolverObject::GetScope(scope, relative);
  55                 }
  56         }
  57 };
  58
  59 /** When should the industry(tile) be triggered for random bits? */
  60 enum IndustryTrigger {
  61         /** Triggered each tile loop */
  62         INDUSTRY_TRIGGER_TILELOOP_PROCESS = 1,
  63         /** Triggered (whole industry) each 256 ticks */
  64         INDUSTRY_TRIGGER_256_TICKS        = 2,
  65         /** Triggered on cargo delivery */
  66         INDUSTRY_TRIGGER_CARGO_DELIVERY   = 4,
  67 };
  68
  69 /** From where has callback #CBID_INDUSTRY_PROBABILITY been called */
  70 enum IndustryAvailabilityCallType {
  71         IACT_MAPGENERATION,    ///< during random map generation
  72         IACT_RANDOMCREATION,   ///< during creation of random ingame industry
  73         IACT_USERCREATION,     ///< from the Fund/build window
  74         IACT_PROSPECTCREATION, ///< from the Fund/build using prospecting
  75 };
  76
  77 /* in newgrf_industry.cpp */
  78 uint16 GetIndustryCallback(CallbackID callback, uint32 param1, uint32 param2, Industry *industry, IndustryType type, TileIndex tile);
  79 uint32 GetIndustryIDAtOffset(TileIndex new_tile, const Industry *i, uint32 cur_grfid);
  80 void IndustryProductionCallback(Industry *ind, int reason);
  81 CommandCost CheckIfCallBackAllowsCreation(TileIndex tile, IndustryType type, uint layout, uint32 seed, uint16 initial_random_bits, Owner founder, IndustryAvailabilityCallType creation_type);
  82 uint32 GetIndustryProbabilityCallback(IndustryType type, IndustryAvailabilityCallType creation_type, uint32 default_prob);
  83 bool IndustryTemporarilyRefusesCargo(Industry *ind, CargoID cargo_type);
  84
  85 IndustryType MapNewGRFIndustryType(IndustryType grf_type, uint32 grf_id);
  86
  87 /* in newgrf_industrytiles.cpp*/
  88 uint32 GetNearbyIndustryTileInformation(byte parameter, TileIndex tile, IndustryID index, bool signed_offsets, bool grf_version8);
  89
  90 #endif /* NEWGRF_INDUSTRIES_H */