src/genworld.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 genworld.h Functions related to world/map generation. */
  11
  12 #ifndef GENWORLD_H
  13 #define GENWORLD_H
  14
  15 #include "company_type.h"
  16
  17 /** Constants related to world generation */
  18 enum LandscapeGenerator {
  19         /* Order of these enums has to be the same as in lang/english.txt
  20          * Otherwise you will get inconsistent behaviour. */
  21         LG_ORIGINAL     = 0,  ///< The original landscape generator
  22         LG_TERRAGENESIS = 1,  ///< TerraGenesis Perlin landscape generator
  23 };
  24
  25 static const uint GENERATE_NEW_SEED = UINT_MAX; ///< Create a new random seed
  26
  27 /** Modes for GenerateWorld */
  28 enum GenWorldMode {
  29         GWM_NEWGAME   = 0, ///< Generate a map for a new game
  30         GWM_EMPTY     = 1, ///< Generate an empty map (sea-level)
  31         GWM_RANDOM    = 2, ///< Generate a random map for SE
  32         GWM_HEIGHTMAP = 3, ///< Generate a newgame from a heightmap
  33 };
  34
  35 static const uint CUSTOM_SEA_LEVEL_NUMBER_DIFFICULTY = 4; ///< Value for custom sea level in difficulty settings.
  36 static const uint CUSTOM_SEA_LEVEL_MIN_PERCENTAGE = 1;    ///< Minimum percentage a user can specify for custom sea level.
  37 static const uint CUSTOM_SEA_LEVEL_MAX_PERCENTAGE = 90;   ///< Maximum percentage a user can specify for custom sea level.
  38
  39 typedef void GWDoneProc();  ///< Procedure called when the genworld process finishes
  40 typedef void GWAbortProc(); ///< Called when genworld is aborted
  41
  42 /** Properties of current genworld process */
  43 struct GenWorldInfo {
  44         bool abort;            ///< Whether to abort the thread ASAP
  45         bool quit_thread;      ///< Do we want to quit the active thread
  46         bool threaded;         ///< Whether we run _GenerateWorld threaded
  47         GenWorldMode mode;     ///< What mode are we making a world in
  48         CompanyID lc;          ///< The local_company before generating
  49         uint size_x;           ///< X-size of the map
  50         uint size_y;           ///< Y-size of the map
  51         GWDoneProc *proc;      ///< Proc that is called when done (can be NULL)
  52         GWAbortProc *abortp;   ///< Proc that is called when aborting (can be NULL)
  53         class ThreadObject *thread; ///< The thread we are in (can be NULL)
  54 };
  55
  56 /** Current stage of world generation process */
  57 enum GenWorldProgress {
  58         GWP_MAP_INIT,    ///< Initialize/allocate the map, start economy
  59         GWP_LANDSCAPE,   ///< Create the landscape
  60         GWP_RIVER,       ///< Create the rivers
  61         GWP_ROUGH_ROCKY, ///< Make rough and rocky areas
  62         GWP_TOWN,        ///< Generate towns
  63         GWP_INDUSTRY,    ///< Generate industries
  64         GWP_OBJECT,      ///< Generate objects (radio tower, light houses)
  65         GWP_TREE,        ///< Generate trees
  66         GWP_GAME_INIT,   ///< Initialize the game
  67         GWP_RUNTILELOOP, ///< Runs the tile loop 1280 times to make snow etc
  68         GWP_RUNSCRIPT,   ///< Runs the game script at most 2500 times, or when ever the script sleeps
  69         GWP_GAME_START,  ///< Really prepare to start the game
  70         GWP_CLASS_COUNT
  71 };
  72
  73 /* genworld.cpp */
  74 bool IsGenerateWorldThreaded();
  75 void GenerateWorldSetCallback(GWDoneProc *proc);
  76 void GenerateWorldSetAbortCallback(GWAbortProc *proc);
  77 void WaitTillGeneratedWorld();
  78 void GenerateWorld(GenWorldMode mode, uint size_x, uint size_y, bool reset_settings = true);
  79 void AbortGeneratingWorld();
  80 bool IsGeneratingWorldAborted();
  81 void HandleGeneratingWorldAbortion();
  82
  83 /* genworld_gui.cpp */
  84 void SetNewLandscapeType(byte landscape);
  85 void SetGeneratingWorldProgress(GenWorldProgress cls, uint total);
  86 void IncreaseGeneratingWorldProgress(GenWorldProgress cls);
  87 void PrepareGenerateWorldProgress();
  88 void ShowGenerateWorldProgress();
  89 void StartNewGameWithoutGUI(uint seed);
  90 void ShowCreateScenario();
  91 void StartScenarioEditor();
  92
  93 extern bool _generating_world;
  94
  95 #endif /* GENWORLD_H */