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