src/newgrf_industries.h

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