genworld.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 GENWORLD_H
#define GENWORLD_H
 
#include "company_type.h"
#include "landscape_type.h"
#include <thread>
 
enum LandscapeGenerator : uint8_t {
  /* Order of these enums has to be the same as in lang/english.txt
   * Otherwise you will get inconsistent behaviour. */
  LG_ORIGINAL     = 0,  
  LG_TERRAGENESIS = 1,  
};
 
static const uint32_t GENERATE_NEW_SEED = UINT32_MAX; 
 
enum GenWorldMode : uint8_t {
  GWM_NEWGAME   = 0, 
  GWM_EMPTY     = 1, 
  GWM_RANDOM    = 2, 
  GWM_HEIGHTMAP = 3, 
};
 
enum TgenSmoothness : uint8_t {
  TGEN_SMOOTHNESS_BEGIN,      
  TGEN_SMOOTHNESS_VERY_SMOOTH = TGEN_SMOOTHNESS_BEGIN, 
  TGEN_SMOOTHNESS_SMOOTH,     
  TGEN_SMOOTHNESS_ROUGH,      
  TGEN_SMOOTHNESS_VERY_ROUGH, 
 
  TGEN_SMOOTHNESS_END,        
};
 
static const uint CUSTOM_TERRAIN_TYPE_NUMBER_DIFFICULTY = 5; 
 
static const uint CUSTOM_SEA_LEVEL_NUMBER_DIFFICULTY = 4; 
static const uint CUSTOM_SEA_LEVEL_MIN_PERCENTAGE = 1;    
static const uint CUSTOM_SEA_LEVEL_MAX_PERCENTAGE = 90;   
 
static constexpr uint MAP_HEIGHT_LIMIT_ORIGINAL = 15; 
 
static const uint MAP_HEIGHT_LIMIT_AUTO_MINIMUM = 30; 
static const uint MAP_HEIGHT_LIMIT_AUTO_CEILING_ROOM = 15; 
 
typedef void GWDoneProc();  
typedef void GWAbortProc(); 
 
struct GenWorldInfo {
  bool abort;            
  GenWorldMode mode;     
  CompanyID lc;          
  uint size_x;           
  uint size_y;           
  GWDoneProc *proc;      
  GWAbortProc *abortp;   
};
 
enum GenWorldProgress : uint8_t {
  GWP_MAP_INIT,    
  GWP_LANDSCAPE,   
  GWP_RIVER,       
  GWP_ROUGH_ROCKY, 
  GWP_TOWN,        
  GWP_INDUSTRY,    
  GWP_OBJECT,      
  GWP_TREE,        
  GWP_GAME_INIT,   
  GWP_RUNTILELOOP, 
  GWP_RUNSCRIPT,   
  GWP_GAME_START,  
  GWP_CLASS_COUNT
};
 
/* genworld.cpp */
void GenerateWorldSetCallback(GWDoneProc *proc);
void GenerateWorldSetAbortCallback(GWAbortProc *proc);
void GenerateWorld(GenWorldMode mode, uint size_x, uint size_y, bool reset_settings = true);
void AbortGeneratingWorld();
bool IsGeneratingWorldAborted();
void HandleGeneratingWorldAbortion();
void LoadTownData();
 
/* genworld_gui.cpp */
void SetNewLandscapeType(LandscapeType landscape);
void SetGeneratingWorldProgress(GenWorldProgress cls, uint total);
void IncreaseGeneratingWorldProgress(GenWorldProgress cls);
void PrepareGenerateWorldProgress();
void ShowGenerateWorldProgress();
void StartNewGameWithoutGUI(uint32_t seed);
void ShowCreateScenario();
void StartScenarioEditor();
 
extern bool _generating_world;
 
#endif /* GENWORLD_H */