1

/* $Id$ */

     2

     3

/** @file genworld.cpp Functions to generate a map. */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "landscape.h"

     8

#include "player_func.h"

     9

#include "variables.h"

    10

#include "thread.h"

    11

#include "command_func.h"

    12

#include "genworld.h"

    13

#include "gfxinit.h"

    14

#include "window_func.h"

    15

#include "network/network.h"

    16

#include "debug.h"

    17

#include "settings_func.h"

    18

#include "heightmap.h"

    19

#include "viewport_func.h"

    20

#include "gfx_func.h"

    21

#include "map_func.h"

    22

#include "date_func.h"

    23

#include "core/random_func.hpp"

    24

#include "engine_func.h"

    25

#include "settings_type.h"

    26

#include "newgrf_storage.h"

    27

#include "water.h"

    28

#include "tilehighlight_func.h"

    29

    30

#include "table/sprites.h"

    31

    32

void GenerateClearTile();

    33

void GenerateIndustries();

    34

void GenerateUnmovables();

    35

bool GenerateTowns();

    36

void GenerateTrees();

    37

    38

void StartupEconomy();

    39

void StartupPlayers();

    40

void StartupDisasters();

    41

    42

void InitializeGame(uint size_x, uint size_y, bool reset_date);

    43

    44

/* Please only use this variable in genworld.h and genworld.c and

    45

 *  nowhere else. For speed improvements we need it to be global, but

    46

 *  in no way the meaning of it is to use it anywhere else besides

    47

 *  in the genworld.h and genworld.c! -- TrueLight */

    48

gw_info _gw;

    49

    50

/**

    51

 * Set the status of the Paint flag.

    52

 *  If it is true, the thread will hold with any futher generating till

    53

 *  the drawing of the screen is done. This is handled by

    54

 *  SetGeneratingWorldProgress(), so calling that function will stall

    55

 *  from time to time.

    56

 */

    57

void SetGeneratingWorldPaintStatus(bool status)

    58

{

    59

	_gw.wait_for_draw = status;

    60

}

    61

    62

/**

    63

 * Returns true if the thread wants the main program to do a (full) paint.

    64

 *  If this returns false, please do not update the screen. Because we are

    65

 *  writing in a thread, it can cause damaged data (reading and writing the

    66

 *  same tile at the same time).

    67

 */

    68

bool IsGeneratingWorldReadyForPaint()

    69

{

    70

	/* If we are in quit_thread mode, ignore this and always return false. This

    71

	 *  forces the screen to not be drawn, and the GUI not to wait for a draw. */

    72

	if (!_gw.active || _gw.quit_thread || !_gw.threaded) return false;

    73

    74

	return _gw.wait_for_draw;

    75

}

    76

    77

/**

    78

 * Tells if the world generation is done in a thread or not.

    79

 */

    80

bool IsGenerateWorldThreaded()

    81

{

    82

	return _gw.threaded && !_gw.quit_thread;

    83

}

    84

    85

/**

    86

 * The internal, real, generate function.

    87

 */

    88

static void _GenerateWorld(void *arg)

    89

{

    90

	try {

    91

		_generating_world = true;

    92

		if (_network_dedicated) DEBUG(net, 0, "Generating map, please wait...");

    93

		/* Set the Random() seed to generation_seed so we produce the same map with the same seed */

    94

		if (_settings_game.game_creation.generation_seed == GENERATE_NEW_SEED) _settings_game.game_creation.generation_seed = _settings_newgame.game_creation.generation_seed = InteractiveRandom();

    95

		_random.SetSeed(_settings_game.game_creation.generation_seed);

    96

		SetGeneratingWorldProgress(GWP_MAP_INIT, 2);

    97

		SetObjectToPlace(SPR_CURSOR_ZZZ, PAL_NONE, VHM_NONE, WC_MAIN_WINDOW, 0);

    98

    99

		IncreaseGeneratingWorldProgress(GWP_MAP_INIT);

   100

		/* Must start economy early because of the costs. */

   101

		StartupEconomy();

   102

   103

		/* Don't generate landscape items when in the scenario editor. */

   104

		if (_gw.mode == GW_EMPTY) {

   105

			SetGeneratingWorldProgress(GWP_UNMOVABLE, 1);

   106

   107

			/* Make the map the height of the patch setting */

   108

			if (_game_mode != GM_MENU) FlatEmptyWorld(_settings_game.game_creation.se_flat_world_height);

   109

   110

			ConvertGroundTilesIntoWaterTiles();

   111

			IncreaseGeneratingWorldProgress(GWP_UNMOVABLE);

   112

		} else {

   113

			GenerateLandscape(_gw.mode);

   114

			GenerateClearTile();

   115

   116

			/* only generate towns, tree and industries in newgame mode. */

   117

			if (_game_mode != GM_EDITOR) {

   118

				GenerateTowns();

   119

				GenerateIndustries();

   120

				GenerateUnmovables();

   121

				GenerateTrees();

   122

			}

   123

		}

   124

   125

		ClearStorageChanges(true);

   126

   127

		/* These are probably pointless when inside the scenario editor. */

   128

		SetGeneratingWorldProgress(GWP_GAME_INIT, 3);

   129

		StartupPlayers();

   130

		IncreaseGeneratingWorldProgress(GWP_GAME_INIT);

   131

		StartupEngines();

   132

		IncreaseGeneratingWorldProgress(GWP_GAME_INIT);

   133

		StartupDisasters();

   134

		_generating_world = false;

   135

   136

		/* No need to run the tile loop in the scenario editor. */

   137

		if (_gw.mode != GW_EMPTY) {

   138

			uint i;

   139

   140

			SetGeneratingWorldProgress(GWP_RUNTILELOOP, 0x500);

   141

			for (i = 0; i < 0x500; i++) {

   142

				RunTileLoop();

   143

				IncreaseGeneratingWorldProgress(GWP_RUNTILELOOP);

   144

			}

   145

		}

   146

   147

		ResetObjectToPlace();

   148

		SetLocalPlayer(_gw.lp);

   149

   150

		SetGeneratingWorldProgress(GWP_GAME_START, 1);

   151

		/* Call any callback */

   152

		if (_gw.proc != NULL) _gw.proc();

   153

		IncreaseGeneratingWorldProgress(GWP_GAME_START);

   154

   155

		if (_cursor.sprite == SPR_CURSOR_ZZZ) SetMouseCursor(SPR_CURSOR_MOUSE, PAL_NONE);

   156

		/* Show all vital windows again, because we have hidden them */

   157

		if (_gw.threaded && _game_mode != GM_MENU) ShowVitalWindows();

   158

		_gw.active   = false;

   159

		_gw.proc     = NULL;

   160

		_gw.threaded = false;

   161

   162

		DeleteWindowById(WC_GENERATE_PROGRESS_WINDOW, 0);

   163

		MarkWholeScreenDirty();

   164

   165

		if (_network_dedicated) DEBUG(net, 0, "Map generated, starting game");

   166

   167

		if (_settings_client.gui.pause_on_newgame && _game_mode == GM_NORMAL) DoCommandP(0, 1, 0, NULL, CMD_PAUSE);

   168

	} catch (...) {

   169

		_generating_world = false;

   170

		throw;

   171

	}

   172

}

   173

   174

/**

   175

 * Set here the function, if any, that you want to be called when landscape

   176

 *  generation is done.

   177

 */

   178

void GenerateWorldSetCallback(gw_done_proc *proc)

   179

{

   180

	_gw.proc = proc;

   181

}

   182

   183

/**

   184

 * Set here the function, if any, that you want to be called when landscape

   185

 *  generation is aborted.

   186

 */

   187

void GenerateWorldSetAbortCallback(gw_abort_proc *proc)

   188

{

   189

	_gw.abortp = proc;

   190

}

   191

   192

/**

   193

 * This will wait for the thread to finish up his work. It will not continue

   194

 *  till the work is done.

   195

 */

   196

void WaitTillGeneratedWorld()

   197

{

   198

	if (_gw.thread == NULL) return;

   199

	_gw.quit_thread = true;

   200

	_gw.thread->Join();

   202

	_gw.thread   = NULL;

   203

	_gw.threaded = false;

   204

}

   205

   206

/**

   207

 * Initializes the abortion process

   208

 */

   209

void AbortGeneratingWorld()

   210

{

   211

	_gw.abort = true;

   212

}

   213

   214

/**

   215

 * Is the generation being aborted?

   216

 */

   217

bool IsGeneratingWorldAborted()

   218

{

   219

	return _gw.abort;

   220

}

   221

   222

/**

   223

 * Really handle the abortion, i.e. clean up some of the mess

   224

 */

   225

void HandleGeneratingWorldAbortion()

   226

{

   227

	/* Clean up - in SE create an empty map, otherwise, go to intro menu */

   228

	_switch_mode = (_game_mode == GM_EDITOR) ? SM_EDITOR : SM_MENU;

   229

   230

	if (_gw.abortp != NULL) _gw.abortp();

   231

   232

	if (_cursor.sprite == SPR_CURSOR_ZZZ) SetMouseCursor(SPR_CURSOR_MOUSE, PAL_NONE);

   233

	/* Show all vital windows again, because we have hidden them */

   234

	if (_gw.threaded && _game_mode != GM_MENU) ShowVitalWindows();

   235

   236

	_gw.active   = false;

   237

	_gw.proc     = NULL;

   238

	_gw.abortp   = NULL;

   239

	_gw.threaded = false;

   240

   241

	DeleteWindowById(WC_GENERATE_PROGRESS_WINDOW, 0);

   242

	MarkWholeScreenDirty();

   243

   245

}

   246

   247

/**

   248

 * Generate a world.

   249

 * @param mode The mode of world generation (see GenerateWorldModes).

   250

 * @param size_x The X-size of the map.

   251

 * @param size_y The Y-size of the map.

   252

 */

   253

void GenerateWorld(GenerateWorldMode mode, uint size_x, uint size_y)

   254

{

   255

	if (_gw.active) return;

   256

	_gw.mode   = mode;

   257

	_gw.size_x = size_x;

   258

	_gw.size_y = size_y;

   259

	_gw.active = true;

   260

	_gw.abort  = false;

   261

	_gw.abortp = NULL;

   262

	_gw.lp     = _local_player;

   263

	_gw.wait_for_draw = false;

   264

	_gw.quit_thread   = false;

   265

	_gw.threaded      = true;

   266

   267

	/* This disables some commands and stuff */

   268

	SetLocalPlayer(PLAYER_SPECTATOR);

   269

	/* Make sure everything is done via OWNER_NONE */

   270

	_current_player = OWNER_NONE;

   271

   272

	/* Set the date before loading sprites as some newgrfs check it */

   273

	SetDate(ConvertYMDToDate(_settings_game.game_creation.starting_year, 0, 1));

   274

   275

	/* Load the right landscape stuff */

   276

	GfxLoadSprites();

   277

	LoadStringWidthTable();

   278

   279

	InitializeGame(_gw.size_x, _gw.size_y, false);

   280

	PrepareGenerateWorldProgress();

   281

   282

	/* Re-init the windowing system */

   283

	ResetWindowSystem();

   284

   285

	/* Create toolbars */

   286

	SetupColorsAndInitialWindow();

   287

   294

	if (_network_dedicated ||

   295

	    (_gw.thread = ThreadObject::New(&_GenerateWorld, NULL)) == NULL) {

   296

		DEBUG(misc, 1, "Cannot create genworld thread, reverting to single-threaded mode");

   297

		_gw.threaded = false;

   298

		_GenerateWorld(NULL);

   299

		return;

   300

	}

   301

   302

	/* Remove any open window */

   303

	DeleteAllNonVitalWindows();

   304

	/* Hide vital windows, because we don't allow to use them */

   305

	HideVitalWindows();

   306

   307

	/* Don't show the dialog if we don't have a thread */

   308

	ShowGenerateWorldProgress();

   309

   310

	/* Centre the view on the map */

   311

	if (FindWindowById(WC_MAIN_WINDOW, 0) != NULL) {

   312

		ScrollMainWindowToTile(TileXY(MapSizeX() / 2, MapSizeY() / 2), true);

   313

	}

   314

}