1

/* $Id$ */

     2

     3

/** @file genworld.cpp */

     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

    29

#include "table/sprites.h"

    30

    31

void GenerateClearTile();

    32

void GenerateIndustries();

    33

void GenerateUnmovables();

    34

bool GenerateTowns();

    35

void GenerateTrees();

    36

    37

void StartupEconomy();

    38

void StartupPlayers();

    39

void StartupDisasters();

    40

    41

void InitializeGame(int mode, uint size_x, uint size_y);

    42

    43

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

    44

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

    45

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

    46

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

    47

gw_info _gw;

    48

    49

/**

    50

 * Set the status of the Paint flag.

    51

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

    52

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

    53

 *  SetGeneratingWorldProgress(), so calling that function will stall

    54

 *  from time to time.

    55

 */

    56

void SetGeneratingWorldPaintStatus(bool status)

    57

{

    58

	_gw.wait_for_draw = status;

    59

}

    60

    61

/**

    62

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

    63

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

    64

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

    65

 *  same tile at the same time).

    66

 */

    67

bool IsGeneratingWorldReadyForPaint()

    68

{

    69

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

    70

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

    71

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

    72

    73

	return _gw.wait_for_draw;

    74

}

    75

    76

/**

    77

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

    78

 */

    79

bool IsGenerateWorldThreaded()

    80

{

    81

	return _gw.threaded && !_gw.quit_thread;

    82

}

    83

    84

/**

    85

 * The internal, real, generate function.

    86

 */

    87

static void * CDECL _GenerateWorld(void *arg)

    88

{

    89

	try {

    90

		_generating_world = true;

    91

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

    92

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

    93

		if (_patches.generation_seed == GENERATE_NEW_SEED) _patches.generation_seed = _patches_newgame.generation_seed = InteractiveRandom();

    94

		_random.SetSeed(_patches.generation_seed);

    95

		SetGeneratingWorldProgress(GWP_MAP_INIT, 2);

    96

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

    97

    98

		IncreaseGeneratingWorldProgress(GWP_MAP_INIT);

    99

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

   100

		StartupEconomy();

   101

   102

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

   103

		if (_gw.mode == GW_EMPTY) {

   104

			SetGeneratingWorldProgress(GWP_UNMOVABLE, 1);

   105

   106

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

   107

			if (_game_mode != GM_MENU) FlatEmptyWorld(_patches.se_flat_world_height);

   108

   109

			ConvertGroundTilesIntoWaterTiles();

   110

			IncreaseGeneratingWorldProgress(GWP_UNMOVABLE);

   111

		} else {

   112

			GenerateLandscape(_gw.mode);

   113

			GenerateClearTile();

   114

   115

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

   116

			if (_game_mode != GM_EDITOR) {

   117

				GenerateTowns();

   118

				GenerateIndustries();

   119

				GenerateUnmovables();

   120

				GenerateTrees();

   121

			}

   122

		}

   123

   124

		ClearStorageChanges(true);

   125

   126

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

   127

		SetGeneratingWorldProgress(GWP_GAME_INIT, 3);

   128

		StartupPlayers();

   129

		IncreaseGeneratingWorldProgress(GWP_GAME_INIT);

   130

		StartupEngines();

   131

		IncreaseGeneratingWorldProgress(GWP_GAME_INIT);

   132

		StartupDisasters();

   133

		_generating_world = false;

   134

   135

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

   136

		if (_gw.mode != GW_EMPTY) {

   137

			uint i;

   138

   139

			SetGeneratingWorldProgress(GWP_RUNTILELOOP, 0x500);

   140

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

   141

				RunTileLoop();

   142

				IncreaseGeneratingWorldProgress(GWP_RUNTILELOOP);

   143

			}

   144

		}

   145

   146

		ResetObjectToPlace();

   147

		SetLocalPlayer(_gw.lp);

   148

   149

		SetGeneratingWorldProgress(GWP_GAME_START, 1);

   150

		/* Call any callback */

   151

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

   152

		IncreaseGeneratingWorldProgress(GWP_GAME_START);

   153

   154

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

   155

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

   156

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

   157

		_gw.active   = false;

   158

		_gw.thread   = NULL;

   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 (_patches.pause_on_newgame && _game_mode == GM_NORMAL) DoCommandP(0, 1, 0, NULL, CMD_PAUSE);

   168

	} catch (...) {

   169

		_generating_world = false;

   170

		throw;

   171

	}

   172

	return NULL;

   173

}

   174

   175

/**

   176

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

   177

 *  generation is done.

   178

 */

   179

void GenerateWorldSetCallback(gw_done_proc *proc)

   180

{

   181

	_gw.proc = proc;

   182

}

   183

   184

/**

   185

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

   186

 *  generation is aborted.

   187

 */

   188

void GenerateWorldSetAbortCallback(gw_abort_proc *proc)

   189

{

   190

	_gw.abortp = proc;

   191

}

   192

   193

/**

   194

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

   195

 *  till the work is done.

   196

 */

   197

void WaitTillGeneratedWorld()

   198

{

   199

	if (_gw.thread == NULL) return;

   200

	_gw.quit_thread = true;

   201

	_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

	ThreadObject *thread = _gw.thread;

   237

	_gw.active   = false;

   238

	_gw.thread   = NULL;

   239

	_gw.proc     = NULL;

   240

	_gw.abortp   = NULL;

   241

	_gw.threaded = false;

   242

   243

	DeleteWindowById(WC_GENERATE_PROGRESS_WINDOW, 0);

   244

	MarkWholeScreenDirty();

   245

   246

	thread->Exit();

   247

}

   248

   249

/**

   250

 * Generate a world.

   251

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

   252

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

   253

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

   254

 */

   255

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

   256

{

   257

	if (_gw.active) return;

   258

	_gw.mode   = mode;

   259

	_gw.size_x = size_x;

   260

	_gw.size_y = size_y;

   261

	_gw.active = true;

   262

	_gw.abort  = false;

   263

	_gw.abortp = NULL;

   264

	_gw.lp     = _local_player;

   265

	_gw.wait_for_draw = false;

   266

	_gw.quit_thread   = false;

   267

	_gw.threaded      = true;

   268

   269

	/* This disables some commands and stuff */

   270

	SetLocalPlayer(PLAYER_SPECTATOR);

   271

	/* Make sure everything is done via OWNER_NONE */

   272

	_current_player = OWNER_NONE;

   273

   274

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

   275

	SetDate(ConvertYMDToDate(_patches.starting_year, 0, 1));

   276

   277

	/* Load the right landscape stuff */

   278

	GfxLoadSprites();

   279

	LoadStringWidthTable();

   280

   281

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

   282

	PrepareGenerateWorldProgress();

   283

   284

	/* Re-init the windowing system */

   285

	ResetWindowSystem();

   286

   287

	/* Create toolbars */

   288

	SetupColorsAndInitialWindow();

   289

   290

	if (_network_dedicated ||

   291

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

   292

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

   293

		_gw.threaded = false;

   294

		_GenerateWorld(NULL);

   295

		return;

   296

	}

   297

   298

	/* Remove any open window */

   299

	DeleteAllNonVitalWindows();

   300

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

   301

	HideVitalWindows();

   302

   303

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

   304

	ShowGenerateWorldProgress();

   305

   306

	/* Centre the view on the map */

   307

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

   308

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

   309

	}

   310

}