# industrytype.h

Go to the documentation of this file.

    00001 /* $Id$ */
    00002
    00003 /*
    00004  * This file is part of OpenTTD.
    00005  * 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.
    00006  * 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.
    00007  * 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/>.
    00008  */
    00009
    00012 #ifndef INDUSTRYTYPE_H
    00013 #define INDUSTRYTYPE_H
    00014
    00015 #include "map_type.h"
    00016 #include "slope_type.h"
    00017 #include "industry_type.h"
    00018 #include "landscape_type.h"
    00019 #include "cargo_type.h"
    00020 #include "newgrf_animation_type.h"
    00021 #include "newgrf_commons.h"
    00022
    00023 enum IndustryCleanupType {
    00024   CLEAN_RANDOMSOUNDS,
    00025   CLEAN_TILELAYOUT,
    00026 };
    00027
    00029 enum IndustryLifeType {
    00030   INDUSTRYLIFE_BLACK_HOLE =      0,
    00031   INDUSTRYLIFE_EXTRACTIVE = 1 << 0,
    00032   INDUSTRYLIFE_ORGANIC    = 1 << 1,
    00033   INDUSTRYLIFE_PROCESSING = 1 << 2,
    00034 };
    00035
    00040 enum CheckProc {
    00041   CHECK_NOTHING,
    00042   CHECK_FOREST,
    00043   CHECK_REFINERY,
    00044   CHECK_FARM,
    00045   CHECK_PLANTATION,
    00046   CHECK_WATER,
    00047   CHECK_LUMBERMILL,
    00048   CHECK_BUBBLEGEN,
    00049   CHECK_OIL_RIG,
    00050   CHECK_END,
    00051 };
    00052
    00054 enum IndustryConstructionType {
    00055   ICT_UNKNOWN,
    00056   ICT_NORMAL_GAMEPLAY,
    00057   ICT_MAP_GENERATION,
    00058   ICT_SCENARIO_EDITOR,
    00059 };
    00060
    00062 enum IndustryBehaviour {
    00063   INDUSTRYBEH_NONE                  =      0,
    00064   INDUSTRYBEH_PLANT_FIELDS          = 1 << 0,
    00065   INDUSTRYBEH_CUT_TREES             = 1 << 1,
    00066   INDUSTRYBEH_BUILT_ONWATER         = 1 << 2,
    00067   INDUSTRYBEH_TOWN1200_MORE         = 1 << 3,
    00068   INDUSTRYBEH_ONLY_INTOWN           = 1 << 4,
    00069   INDUSTRYBEH_ONLY_NEARTOWN         = 1 << 5,
    00070   INDUSTRYBEH_PLANT_ON_BUILT        = 1 << 6,
    00071   INDUSTRYBEH_DONT_INCR_PROD        = 1 << 7,
    00072   INDUSTRYBEH_BEFORE_1950           = 1 << 8,
    00073   INDUSTRYBEH_AFTER_1960            = 1 << 9,
    00074   INDUSTRYBEH_AI_AIRSHIP_ROUTES     = 1 << 10,
    00075   INDUSTRYBEH_AIRPLANE_ATTACKS      = 1 << 11,
    00076   INDUSTRYBEH_CHOPPER_ATTACKS       = 1 << 12,
    00077   INDUSTRYBEH_CAN_SUBSIDENCE        = 1 << 13,
    00078   /* The following flags are only used for newindustries and do no represent any normal behaviour */
    00079   INDUSTRYBEH_PROD_MULTI_HNDLING    = 1 << 14,
    00080   INDUSTRYBEH_PRODCALLBACK_RANDOM   = 1 << 15,
    00081   INDUSTRYBEH_NOBUILT_MAPCREATION   = 1 << 16,
    00082   INDUSTRYBEH_CANCLOSE_LASTINSTANCE = 1 << 17,
    00083 };
    00084 DECLARE_ENUM_AS_BIT_SET(IndustryBehaviour)
    00085
    00086
    00087 enum IndustryTileSpecialFlags {
    00088   INDTILE_SPECIAL_NONE                  = 0,
    00089   INDTILE_SPECIAL_NEXTFRAME_RANDOMBITS  = 1 << 0,
    00090 };
    00091 DECLARE_ENUM_AS_BIT_SET(IndustryTileSpecialFlags)
    00092
    00093 struct IndustryTileTable {
    00094   TileIndexDiffC ti;
    00095   IndustryGfx gfx;
    00096 };
    00097
    00101 struct IndustrySpec {
    00102   const IndustryTileTable * const *table;
    00103   byte num_table;
    00104   uint8 cost_multiplier;
    00105   uint32 removal_cost_multiplier;
    00106   uint32 prospecting_chance;
    00107   IndustryType conflicting[3];
    00108   byte check_proc;
    00109   CargoID produced_cargo[2];
    00110   byte production_rate[2];
    00115   byte minimal_cargo;
    00116   CargoID accepts_cargo[3];
    00117   uint16 input_cargo_multiplier[3][2];
    00118   IndustryLifeType life_type;
    00119   byte climate_availability;
    00120   IndustryBehaviour behaviour;
    00121   byte map_colour;
    00122   StringID name;
    00123   StringID new_industry_text;
    00124   StringID closure_text;
    00125   StringID production_up_text;
    00126   StringID production_down_text;
    00127   StringID station_name;
    00128   byte appear_ingame[NUM_LANDSCAPE];
    00129   byte appear_creation[NUM_LANDSCAPE];
    00130   uint8 number_of_sounds;
    00131   const uint8 *random_sounds;
    00132   /* Newgrf data */
    00133   uint16 callback_mask;
    00134   uint8 cleanup_flag;
    00135   bool enabled;
    00136   GRFFileProps grf_prop;
    00137
    00138   bool IsRawIndustry() const;
    00139   Money GetConstructionCost() const;
    00140   Money GetRemovalCost() const;
    00141   bool UsesSmoothEconomy() const;
    00142 };
    00143
    00147 struct IndustryTileSpec {
    00148   CargoID accepts_cargo[3];
    00149   uint8 acceptance[3];
    00150   Slope slopes_refused;
    00151   byte anim_production;
    00152   byte anim_next;
    00153
    00157   bool anim_state;
    00158   /* Newgrf data */
    00159   uint8 callback_mask;
    00160   AnimationInfo animation;
    00161   IndustryTileSpecialFlags special_flags;
    00162   bool enabled;
    00163   GRFFileProps grf_prop;
    00164 };
    00165
    00166 /* industry_cmd.cpp*/
    00167 const IndustrySpec *GetIndustrySpec(IndustryType thistype);
    00168 const IndustryTileSpec *GetIndustryTileSpec(IndustryGfx gfx);
    00169 void ResetIndustries();
    00170
    00171 /* writable arrays of specs */
    00172 extern IndustrySpec _industry_specs[NUM_INDUSTRYTYPES];
    00173 extern IndustryTileSpec _industry_tile_specs[NUM_INDUSTRYTILES];
    00174
    00175 /* industry_gui.cpp */
    00176 void SortIndustryTypes();
    00177 /* Industry types sorted alphabetically by name. */
    00178 extern IndustryType _sorted_industry_types[NUM_INDUSTRYTYPES];
    00179
    00185 static inline IndustryGfx GetTranslatedIndustryTileID(IndustryGfx gfx)
    00186 {
    00187   /* the 0xFF should be GFX_WATERTILE_SPECIALCHECK but for reasons of include mess,
    00188    * we'll simplify the writing.
    00189    * Basically, the first test is required since the GFX_WATERTILE_SPECIALCHECK value
    00190    * will never be assigned as a tile index and is only required in order to do some
    00191    * tests while building the industry (as in WATER REQUIRED */
    00192   if (gfx != 0xFF) {
    00193     assert(gfx < INVALID_INDUSTRYTILE);
    00194     const IndustryTileSpec *it = &_industry_tile_specs[gfx];
    00195     return it->grf_prop.override == INVALID_INDUSTRYTILE ? gfx : it->grf_prop.override;
    00196   } else {
    00197     return gfx;
    00198   }
    00199 }
    00200
    00201 static const uint8 IT_INVALID = 255;
    00202
    00203 #endif /* INDUSTRYTYPE_H */