industrytype.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 INDUSTRYTYPE_H
#define INDUSTRYTYPE_H
 
#include "map_type.h"
#include "slope_type.h"
#include "industry_type.h"
#include "landscape_type.h"
#include "cargo_type.h"
#include "newgrf_animation_type.h"
#include "newgrf_commons.h"
 
enum IndustryLifeType {
  INDUSTRYLIFE_BLACK_HOLE =      0, 
  INDUSTRYLIFE_EXTRACTIVE = 1 << 0, 
  INDUSTRYLIFE_ORGANIC    = 1 << 1, 
  INDUSTRYLIFE_PROCESSING = 1 << 2, 
};
 
enum CheckProc {
  CHECK_NOTHING,    
  CHECK_FOREST,     
  CHECK_REFINERY,   
  CHECK_FARM,       
  CHECK_PLANTATION, 
  CHECK_WATER,      
  CHECK_LUMBERMILL, 
  CHECK_BUBBLEGEN,  
  CHECK_OIL_RIG,    
  CHECK_END,        
};
 
enum IndustryConstructionType {
  ICT_UNKNOWN,          
  ICT_NORMAL_GAMEPLAY,  
  ICT_MAP_GENERATION,   
  ICT_SCENARIO_EDITOR,  
};
 
enum IndustryBehaviour {
  INDUSTRYBEH_NONE                  =      0,
  INDUSTRYBEH_PLANT_FIELDS          = 1 << 0,  
  INDUSTRYBEH_CUT_TREES             = 1 << 1,  
  INDUSTRYBEH_BUILT_ONWATER         = 1 << 2,  
  INDUSTRYBEH_TOWN1200_MORE         = 1 << 3,  
  INDUSTRYBEH_ONLY_INTOWN           = 1 << 4,  
  INDUSTRYBEH_ONLY_NEARTOWN         = 1 << 5,  
  INDUSTRYBEH_PLANT_ON_BUILT        = 1 << 6,  
  INDUSTRYBEH_DONT_INCR_PROD        = 1 << 7,  
  INDUSTRYBEH_BEFORE_1950           = 1 << 8,  
  INDUSTRYBEH_AFTER_1960            = 1 << 9,  
  INDUSTRYBEH_AI_AIRSHIP_ROUTES     = 1 << 10, 
  INDUSTRYBEH_AIRPLANE_ATTACKS      = 1 << 11, 
  INDUSTRYBEH_CHOPPER_ATTACKS       = 1 << 12, 
  INDUSTRYBEH_CAN_SUBSIDENCE        = 1 << 13, 
  /* The following flags are only used for newindustries and do no represent any normal behaviour */
  INDUSTRYBEH_PROD_MULTI_HNDLING    = 1 << 14, 
  INDUSTRYBEH_PRODCALLBACK_RANDOM   = 1 << 15, 
  INDUSTRYBEH_NOBUILT_MAPCREATION   = 1 << 16, 
  INDUSTRYBEH_CANCLOSE_LASTINSTANCE = 1 << 17, 
  INDUSTRYBEH_CARGOTYPES_UNLIMITED  = 1 << 18, 
  INDUSTRYBEH_NO_PAX_PROD_CLAMP     = 1 << 19, 
};
DECLARE_ENUM_AS_BIT_SET(IndustryBehaviour)
 
 
enum IndustryTileSpecialFlags {
  INDTILE_SPECIAL_NONE                  = 0,
  INDTILE_SPECIAL_NEXTFRAME_RANDOMBITS  = 1 << 0, 
  INDTILE_SPECIAL_ACCEPTS_ALL_CARGO     = 1 << 1, 
};
DECLARE_ENUM_AS_BIT_SET(IndustryTileSpecialFlags)
 
 
struct IndustryTileLayoutTile {
  TileIndexDiffC ti;
  IndustryGfx gfx;
};
 
using IndustryTileLayout = std::vector<IndustryTileLayoutTile>;
 
struct IndustrySpec {
  std::vector<IndustryTileLayout> layouts;    
  uint8_t cost_multiplier;                      
  uint32_t removal_cost_multiplier;             
  uint32_t prospecting_chance;                  
  IndustryType conflicting[3];                
  uint8_t check_proc;                            
  std::array<CargoID, INDUSTRY_NUM_OUTPUTS> produced_cargo;
  std::variant<CargoLabel, MixedCargoType> produced_cargo_label[INDUSTRY_NUM_OUTPUTS];
  uint8_t production_rate[INDUSTRY_NUM_OUTPUTS];
  uint8_t minimal_cargo;
  std::array<CargoID, INDUSTRY_NUM_INPUTS> accepts_cargo; 
  std::variant<CargoLabel, MixedCargoType> accepts_cargo_label[INDUSTRY_NUM_INPUTS];
  uint16_t input_cargo_multiplier[INDUSTRY_NUM_INPUTS][INDUSTRY_NUM_OUTPUTS]; 
  IndustryLifeType life_type;                 
  uint8_t climate_availability;                  
  IndustryBehaviour behaviour;                
  uint8_t map_colour;                            
  StringID name;                              
  StringID new_industry_text;                 
  StringID closure_text;                      
  StringID production_up_text;                
  StringID production_down_text;              
  StringID station_name;                      
  uint8_t appear_ingame[NUM_LANDSCAPE];          
  uint8_t appear_creation[NUM_LANDSCAPE];        
  /* Newgrf data */
  uint16_t callback_mask;                       
  bool enabled;                               
  GRFFileProps grf_prop;                      
  std::vector<uint8_t> random_sounds; 
 
  bool IsRawIndustry() const;
  bool IsProcessingIndustry() const;
  Money GetConstructionCost() const;
  Money GetRemovalCost() const;
  bool UsesOriginalEconomy() const;
};
 
struct IndustryTileSpec {
  std::array<CargoID, INDUSTRY_NUM_INPUTS> accepts_cargo; 
  std::array<std::variant<CargoLabel, MixedCargoType>, INDUSTRY_NUM_INPUTS> accepts_cargo_label;
  std::array<int8_t, INDUSTRY_NUM_INPUTS> acceptance; 
  Slope slopes_refused;                 
  uint8_t anim_production;                 
  uint8_t anim_next;                       
 
  bool anim_state;
  /* Newgrf data */
  uint8_t callback_mask;                  
  AnimationInfo animation;              
  IndustryTileSpecialFlags special_flags; 
  bool enabled;                         
  GRFFileProps grf_prop;                
};
 
/* industry_cmd.cpp*/
const IndustrySpec *GetIndustrySpec(IndustryType thistype);    
const IndustryTileSpec *GetIndustryTileSpec(IndustryGfx gfx);  
void ResetIndustries();
 
/* writable arrays of specs */
extern IndustrySpec _industry_specs[NUM_INDUSTRYTYPES];
extern IndustryTileSpec _industry_tile_specs[NUM_INDUSTRYTILES];
 
/* industry_gui.cpp */
void SortIndustryTypes();
/* Industry types sorted alphabetically by name. */
extern std::array<IndustryType, NUM_INDUSTRYTYPES> _sorted_industry_types;
 
inline IndustryGfx GetTranslatedIndustryTileID(IndustryGfx gfx)
{
  /* the 0xFF should be GFX_WATERTILE_SPECIALCHECK but for reasons of include mess,
   * we'll simplify the writing.
   * Basically, the first test is required since the GFX_WATERTILE_SPECIALCHECK value
   * will never be assigned as a tile index and is only required in order to do some
   * tests while building the industry (as in WATER REQUIRED */
  if (gfx != 0xFF) {
    assert(gfx < INVALID_INDUSTRYTILE);
    const IndustryTileSpec *it = &_industry_tile_specs[gfx];
    return it->grf_prop.override == INVALID_INDUSTRYTILE ? gfx : it->grf_prop.override;
  } else {
    return gfx;
  }
}
 
static const uint8_t IT_INVALID = 255;
 
#endif /* INDUSTRYTYPE_H */