newgrf_industries.h

Go to the documentation of this file.

/*
 * This file is part of OpenTTD.
 * 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.
 * 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.
 * 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/>.
 */
 
#ifndef NEWGRF_INDUSTRIES_H
#define NEWGRF_INDUSTRIES_H
 
#include "newgrf_town.h"
 
struct IndustriesScopeResolver : public ScopeResolver {
  TileIndex tile;     
  Industry *industry; 
  IndustryType type;  
  uint32_t random_bits; 
 
  IndustriesScopeResolver(ResolverObject &ro, TileIndex tile, Industry *industry, IndustryType type, uint32_t random_bits = 0)
    : ScopeResolver(ro), tile(tile), industry(industry), type(type), random_bits(random_bits)
  {
  }
 
  uint32_t GetRandomBits() const override;
  uint32_t GetVariable(uint8_t variable, [[maybe_unused]] uint32_t parameter, bool &available) const override;
  uint32_t GetTriggers() const override;
  void StorePSA(uint pos, int32_t value) override;
};
 
struct IndustriesResolverObject : public ResolverObject {
  IndustriesScopeResolver industries_scope; 
  std::optional<TownScopeResolver> town_scope = std::nullopt; 
 
  IndustriesResolverObject(TileIndex tile, Industry *indus, IndustryType type, uint32_t random_bits = 0,
      CallbackID callback = CBID_NO_CALLBACK, uint32_t callback_param1 = 0, uint32_t callback_param2 = 0);
 
  TownScopeResolver *GetTown();
 
  ScopeResolver *GetScope(VarSpriteGroupScope scope = VSG_SCOPE_SELF, uint8_t relative = 0) override
  {
    switch (scope) {
      case VSG_SCOPE_SELF: return &industries_scope;
      case VSG_SCOPE_PARENT: {
        TownScopeResolver *tsr = this->GetTown();
        if (tsr != nullptr) return tsr;
      }
      [[fallthrough]];
 
      default:
        return ResolverObject::GetScope(scope, relative);
    }
  }
 
  GrfSpecFeature GetFeature() const override;
  uint32_t GetDebugID() const override;
};
 
enum IndustryTrigger {
  INDUSTRY_TRIGGER_TILELOOP_PROCESS = 1,
  INDUSTRY_TRIGGER_256_TICKS        = 2,
  INDUSTRY_TRIGGER_CARGO_DELIVERY   = 4,
};
 
enum IndustryAvailabilityCallType {
  IACT_MAPGENERATION,    
  IACT_RANDOMCREATION,   
  IACT_USERCREATION,     
  IACT_PROSPECTCREATION, 
};
 
/* in newgrf_industry.cpp */
uint16_t GetIndustryCallback(CallbackID callback, uint32_t param1, uint32_t param2, Industry *industry, IndustryType type, TileIndex tile);
uint32_t GetIndustryIDAtOffset(TileIndex new_tile, const Industry *i, uint32_t cur_grfid);
void IndustryProductionCallback(Industry *ind, int reason);
CommandCost CheckIfCallBackAllowsCreation(TileIndex tile, IndustryType type, size_t layout, uint32_t seed, uint16_t initial_random_bits, Owner founder, IndustryAvailabilityCallType creation_type);
uint32_t GetIndustryProbabilityCallback(IndustryType type, IndustryAvailabilityCallType creation_type, uint32_t default_prob);
bool IndustryTemporarilyRefusesCargo(Industry *ind, CargoID cargo_type);
 
IndustryType MapNewGRFIndustryType(IndustryType grf_type, uint32_t grf_id);
 
/* in newgrf_industrytiles.cpp*/
uint32_t GetNearbyIndustryTileInformation(uint8_t parameter, TileIndex tile, IndustryID index, bool signed_offsets, bool grf_version8);
 
#endif /* NEWGRF_INDUSTRIES_H */