src/newgrf_industries.h

   1 /*
   2  * This file is part of OpenTTD.
   3  * 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.
   4  * 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.
   5  * 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/>.
   6  */
   7
   8 /** @file newgrf_industries.h Functions for NewGRF industries. */
   9
  10 #ifndef NEWGRF_INDUSTRIES_H
  11 #define NEWGRF_INDUSTRIES_H
  12
  13 #include "newgrf_town.h"
  14
  15 /** Resolver for industry scopes. */
  16 struct IndustriesScopeResolver : public ScopeResolver {
  17         TileIndex tile;     ///< Tile owned by the industry.
  18         Industry *industry; ///< %Industry being resolved.
  19         IndustryType type;  ///< Type of the industry.
  20         uint32_t random_bits; ///< Random bits of the new industry.
  21
  22         /**
  23          * Scope resolver for industries.
  24          * @param ro Surrounding resolver.
  25          * @param tile %Tile owned by the industry.
  26          * @param industry %Industry being resolved.
  27          * @param type Type of the industry.
  28          * @param random_bits Random bits of the new industry.
  29          */
  30         IndustriesScopeResolver(ResolverObject &ro, TileIndex tile, Industry *industry, IndustryType type, uint32_t random_bits = 0)
  31                 : ScopeResolver(ro), tile(tile), industry(industry), type(type), random_bits(random_bits)
  32         {
  33         }
  34
  35         uint32_t GetRandomBits() const override;
  36         uint32_t GetVariable(uint8_t variable, [[maybe_unused]] uint32_t parameter, bool &available) const override;
  37         uint32_t GetTriggers() const override;
  38         void StorePSA(uint pos, int32_t value) override;
  39 };
  40
  41 /** Resolver for industries. */
  42 struct IndustriesResolverObject : public ResolverObject {
  43         IndustriesScopeResolver industries_scope; ///< Scope resolver for the industry.
  44         std::optional<TownScopeResolver> town_scope = std::nullopt; ///< Scope resolver for the associated town (if needed and available, else \c std::nullopt).
  45
  46         IndustriesResolverObject(TileIndex tile, Industry *indus, IndustryType type, uint32_t random_bits = 0,
  47                         CallbackID callback = CBID_NO_CALLBACK, uint32_t callback_param1 = 0, uint32_t callback_param2 = 0);
  48
  49         TownScopeResolver *GetTown();
  50
  51         ScopeResolver *GetScope(VarSpriteGroupScope scope = VSG_SCOPE_SELF, uint8_t relative = 0) override
  52         {
  53                 switch (scope) {
  54                         case VSG_SCOPE_SELF: return &industries_scope;
  55                         case VSG_SCOPE_PARENT: {
  56                                 TownScopeResolver *tsr = this->GetTown();
  57                                 if (tsr != nullptr) return tsr;
  58                         }
  59                         [[fallthrough]];
  60
  61                         default:
  62                                 return ResolverObject::GetScope(scope, relative);
  63                 }
  64         }
  65
  66         GrfSpecFeature GetFeature() const override;
  67         uint32_t GetDebugID() const override;
  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_t GetIndustryCallback(CallbackID callback, uint32_t param1, uint32_t param2, Industry *industry, IndustryType type, TileIndex tile);
  90 uint32_t GetIndustryIDAtOffset(TileIndex new_tile, const Industry *i, uint32_t cur_grfid);
  91 void IndustryProductionCallback(Industry *ind, int reason);
  92 CommandCost CheckIfCallBackAllowsCreation(TileIndex tile, IndustryType type, size_t layout, uint32_t seed, uint16_t initial_random_bits, Owner founder, IndustryAvailabilityCallType creation_type);
  93 uint32_t GetIndustryProbabilityCallback(IndustryType type, IndustryAvailabilityCallType creation_type, uint32_t default_prob);
  94 bool IndustryTemporarilyRefusesCargo(Industry *ind, CargoID cargo_type);
  95
  96 IndustryType MapNewGRFIndustryType(IndustryType grf_type, uint32_t grf_id);
  97
  98 /* in newgrf_industrytiles.cpp*/
  99 uint32_t GetNearbyIndustryTileInformation(uint8_t parameter, TileIndex tile, IndustryID index, bool signed_offsets, bool grf_version8);
 100
 101 #endif /* NEWGRF_INDUSTRIES_H */