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.h"

    25

#include "settings_type.h"

    27

    28

#include "table/sprites.h"

    29

    30

void GenerateClearTile();

    31

void GenerateIndustries();

    32

void GenerateUnmovables();

    33

bool GenerateTowns();

    34

void GenerateTrees();

    35

    36

void StartupEconomy();

    37

void StartupPlayers();

    38

void StartupDisasters();

    39

    40

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

    41

    42

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

    43

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

    44

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

    45

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

    46

gw_info _gw;

    47

    48

/**

    49

 * Set the status of the Paint flag.

    50

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

    51

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

    52

 *  SetGeneratingWorldProgress(), so calling that function will stall

    53

 *  from time to time.

    54

 */

    55

void SetGeneratingWorldPaintStatus(bool status)

    56

{

    57

	_gw.wait_for_draw = status;

    58

}

    59

    60

/**

    61

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

    62

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

    63

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

    64

 *  same tile at the same time).

    65

 */

    66

bool IsGeneratingWorldReadyForPaint()

    67

{

    68

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

    69

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

    70

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

    71

    72

	return _gw.wait_for_draw;

    73

}

    74

    75

/**

    76

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

    77

 */

    78

bool IsGenerateWorldThreaded()

    79

{

    80

	return _gw.threaded && !_gw.quit_thread;

    81

}

    82

    83

/**

    84

 * The internal, real, generate function.

    85

 */

    86

static void *_GenerateWorld(void *arg)

    87

{

    88

	_generating_world = true;

    89

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

    90

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

    91

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

    92

	_random_seeds[0][0] = _random_seeds[0][1] = _patches.generation_seed;

    93

	SetGeneratingWorldProgress(GWP_MAP_INIT, 2);

    94

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

    95

    96

	IncreaseGeneratingWorldProgress(GWP_MAP_INIT);

    97

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

    98

	StartupEconomy();

    99

   100

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

   101

	if (_gw.mode == GW_EMPTY) {

   102

		SetGeneratingWorldProgress(GWP_UNMOVABLE, 1);

   103

   104

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

   105

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

   106

   107

		ConvertGroundTilesIntoWaterTiles();

   108

		IncreaseGeneratingWorldProgress(GWP_UNMOVABLE);

   109

	} else {

   110

		GenerateLandscape(_gw.mode);

   111

		GenerateClearTile();

   112

   113

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

   114

		if (_game_mode != GM_EDITOR) {

   115

			GenerateTowns();

   116

			GenerateIndustries();

   117

			GenerateUnmovables();

   118

			GenerateTrees();

   119

		}

   120

	}

   121

   124

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

   125

	SetGeneratingWorldProgress(GWP_GAME_INIT, 3);

   126

	StartupPlayers();

   127

	IncreaseGeneratingWorldProgress(GWP_GAME_INIT);

   128

	StartupEngines();

   129

	IncreaseGeneratingWorldProgress(GWP_GAME_INIT);

   130

	StartupDisasters();

   131

	_generating_world = false;

   132

   133

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

   134

	if (_gw.mode != GW_EMPTY) {

   135

		uint i;

   136

   137

		SetGeneratingWorldProgress(GWP_RUNTILELOOP, 0x500);

   138

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

   139

			RunTileLoop();

   140

			IncreaseGeneratingWorldProgress(GWP_RUNTILELOOP);

   141

		}

   142

	}

   143

   144

	ResetObjectToPlace();

   145

	SetLocalPlayer(_gw.lp);

   146

   147

	SetGeneratingWorldProgress(GWP_GAME_START, 1);

   148

	/* Call any callback */

   149

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

   150

	IncreaseGeneratingWorldProgress(GWP_GAME_START);

   151

   152

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

   153

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

   154

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

   155

	_gw.active   = false;

   156

	_gw.thread   = NULL;

   157

	_gw.proc     = NULL;

   158

	_gw.threaded = false;

   159

   160

	DeleteWindowById(WC_GENERATE_PROGRESS_WINDOW, 0);

   161

	MarkWholeScreenDirty();

   162

   163

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

   164

   165

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

   166

   167

	return NULL;

   168

}

   169

   170

/**

   171

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

   172

 *  generation is done.

   173

 */

   174

void GenerateWorldSetCallback(gw_done_proc *proc)

   175

{

   176

	_gw.proc = proc;

   177

}

   178

   179

/**

   180

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

   181

 *  generation is aborted.

   182

 */

   183

void GenerateWorldSetAbortCallback(gw_abort_proc *proc)

   184

{

   185

	_gw.abortp = proc;

   186

}

   187

   188

/**

   189

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

   190

 *  till the work is done.

   191

 */

   192

void WaitTillGeneratedWorld()

   193

{

   194

	if (_gw.thread == NULL) return;

   195

	_gw.quit_thread = true;

   196

	OTTDJoinThread((OTTDThread*)_gw.thread);

   197

	_gw.thread   = NULL;

   198

	_gw.threaded = false;

   199

}

   200

   201

/**

   202

 * Initializes the abortion process

   203

 */

   204

void AbortGeneratingWorld()

   205

{

   206

	_gw.abort = true;

   207

}

   208

   209

/**

   210

 * Is the generation being aborted?

   211

 */

   212

bool IsGeneratingWorldAborted()

   213

{

   214

	return _gw.abort;

   215

}

   216

   217

/**

   218

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

   219

 */

   220

void HandleGeneratingWorldAbortion()

   221

{

   222

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

   223

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

   224

   225

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

   226

   227

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

   228

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

   229

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

   230

	_gw.active   = false;

   231

	_gw.thread   = NULL;

   232

	_gw.proc     = NULL;

   233

	_gw.abortp   = NULL;

   234

	_gw.threaded = false;

   235

   236

	DeleteWindowById(WC_GENERATE_PROGRESS_WINDOW, 0);

   237

	MarkWholeScreenDirty();

   238

   239

	OTTDExitThread();

   240

}

   241

   242

/**

   243

 * Generate a world.

   244

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

   245

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

   246

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

   247

 */

   248

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

   249

{

   250

	if (_gw.active) return;

   251

	_gw.mode   = mode;

   252

	_gw.size_x = size_x;

   253

	_gw.size_y = size_y;

   254

	_gw.active = true;

   255

	_gw.abort  = false;

   256

	_gw.abortp = NULL;

   257

	_gw.lp     = _local_player;

   258

	_gw.wait_for_draw = false;

   259

	_gw.quit_thread   = false;

   260

	_gw.threaded      = true;

   261

   262

	/* This disables some commands and stuff */

   263

	SetLocalPlayer(PLAYER_SPECTATOR);

   264

	/* Make sure everything is done via OWNER_NONE */

   265

	_current_player = OWNER_NONE;

   266

   267

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

   268

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

   269

   270

	/* Load the right landscape stuff */

   271

	GfxLoadSprites();

   272

	LoadStringWidthTable();

   273

   274

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

   275

	PrepareGenerateWorldProgress();

   276

   277

	/* Re-init the windowing system */

   278

	ResetWindowSystem();

   279

   280

	/* Create toolbars */

   281

	SetupColorsAndInitialWindow();

   282

   283

	if (_network_dedicated ||

   284

	    (_gw.thread = OTTDCreateThread(&_GenerateWorld, NULL)) == NULL) {

   285

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

   286

		_gw.threaded = false;

   287

		_GenerateWorld(NULL);

   288

		return;

   289

	}

   290

   291

	/* Remove any open window */

   292

	DeleteAllNonVitalWindows();

   293

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

   294

	HideVitalWindows();

   295

   296

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

   297

	ShowGenerateWorldProgress();

   298

   299

	/* Centre the view on the map */

   300

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

   301

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

   302

	}

   303

}