1

/* $Id$ */

     2

     3

/** @file genworld.cpp */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "functions.h"

     8

#include "landscape.h"

     9

#include "player.h"

    10

#include "table/sprites.h"

    11

#include "variables.h"

    12

#include "thread.h"

    13

#include "command.h"

    14

#include "genworld.h"

    15

#include "gfx.h"

    16

#include "gfxinit.h"

    17

#include "gui.h"

    18

#include "network/network.h"

    19

#include "debug.h"

    20

#include "settings.h"

    21

#include "heightmap.h"

    22

#include "date.h"

    23

    24

void GenerateClearTile();

    25

void GenerateIndustries();

    26

void GenerateUnmovables();

    27

bool GenerateTowns();

    28

void GenerateTrees();

    29

    30

void StartupEconomy();

    31

void StartupPlayers();

    32

void StartupDisasters();

    33

    34

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

    35

    36

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

    37

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

    38

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

    39

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

    40

gw_info _gw;

    41

    42

/**

    43

 * Set the status of the Paint flag.

    44

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

    45

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

    46

 *  SetGeneratingWorldProgress(), so calling that function will stall

    47

 *  from time to time.

    48

 */

    49

void SetGeneratingWorldPaintStatus(bool status)

    50

{

    51

	_gw.wait_for_draw = status;

    52

}

    53

    54

/**

    55

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

    56

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

    57

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

    58

 *  same tile at the same time).

    59

 */

    60

bool IsGeneratingWorldReadyForPaint()

    61

{

    62

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

    63

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

    64

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

    65

    66

	return _gw.wait_for_draw;

    67

}

    68

    69

/**

    70

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

    71

 */

    72

bool IsGenerateWorldThreaded()

    73

{

    74

	return _gw.threaded && !_gw.quit_thread;

    75

}

    76

    77

/**

    78

 * The internal, real, generate function.

    79

 */

    80

static void *_GenerateWorld(void *arg)

    81

{

    82

	_generating_world = true;

    83

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

    84

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

    85

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

    86

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

    87

	SetGeneratingWorldProgress(GWP_MAP_INIT, 2);

    88

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

    89

    90

	IncreaseGeneratingWorldProgress(GWP_MAP_INIT);

    91

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

    92

	StartupEconomy();

    93

    94

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

    95

	if (_gw.mode == GW_EMPTY) {

    96

		SetGeneratingWorldProgress(GWP_UNMOVABLE, 1);

    97

    98

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

    99

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

   100

   101

		ConvertGroundTilesIntoWaterTiles();

   102

		IncreaseGeneratingWorldProgress(GWP_UNMOVABLE);

   103

	} else {

   104

		GenerateLandscape(_gw.mode);

   105

		GenerateClearTile();

   106

   107

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

   108

		if (_game_mode != GM_EDITOR) {

   109

			GenerateTowns();

   110

			GenerateIndustries();

   111

			GenerateUnmovables();

   112

			GenerateTrees();

   113

		}

   114

	}

   115

   116

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

   117

	SetGeneratingWorldProgress(GWP_GAME_INIT, 3);

   118

	StartupPlayers();

   119

	IncreaseGeneratingWorldProgress(GWP_GAME_INIT);

   120

	StartupEngines();

   121

	IncreaseGeneratingWorldProgress(GWP_GAME_INIT);

   122

	StartupDisasters();

   123

	_generating_world = false;

   124

   125

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

   126

	if (_gw.mode != GW_EMPTY) {

   127

		uint i;

   128

   129

		SetGeneratingWorldProgress(GWP_RUNTILELOOP, 0x500);

   130

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

   131

			RunTileLoop();

   132

			IncreaseGeneratingWorldProgress(GWP_RUNTILELOOP);

   133

		}

   134

	}

   135

   136

	ResetObjectToPlace();

   137

	SetLocalPlayer(_gw.lp);

   138

   139

	SetGeneratingWorldProgress(GWP_GAME_START, 1);

   140

	/* Call any callback */

   141

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

   142

	IncreaseGeneratingWorldProgress(GWP_GAME_START);

   143

   144

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

   145

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

   146

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

   147

	_gw.active   = false;

   148

	_gw.thread   = NULL;

   149

	_gw.proc     = NULL;

   150

	_gw.threaded = false;

   151

   152

	DeleteWindowById(WC_GENERATE_PROGRESS_WINDOW, 0);

   153

	MarkWholeScreenDirty();

   154

   155

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

   156

   157

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

   158

   159

	return NULL;

   160

}

   161

   162

/**

   163

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

   164

 *  generation is done.

   165

 */

   166

void GenerateWorldSetCallback(gw_done_proc *proc)

   167

{

   168

	_gw.proc = proc;

   169

}

   170

   171

/**

   172

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

   173

 *  generation is aborted.

   174

 */

   175

void GenerateWorldSetAbortCallback(gw_abort_proc *proc)

   176

{

   177

	_gw.abortp = proc;

   178

}

   179

   180

/**

   181

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

   182

 *  till the work is done.

   183

 */

   184

void WaitTillGeneratedWorld()

   185

{

   186

	if (_gw.thread == NULL) return;

   187

	_gw.quit_thread = true;

   188

	OTTDJoinThread((OTTDThread*)_gw.thread);

   189

	_gw.thread   = NULL;

   190

	_gw.threaded = false;

   191

}

   192

   193

/**

   194

 * Initializes the abortion process

   195

 */

   196

void AbortGeneratingWorld()

   197

{

   198

	_gw.abort = true;

   199

}

   200

   201

/**

   202

 * Is the generation being aborted?

   203

 */

   204

bool IsGeneratingWorldAborted()

   205

{

   206

	return _gw.abort;

   207

}

   208

   209

/**

   210

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

   211

 */

   212

void HandleGeneratingWorldAbortion()

   213

{

   214

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

   215

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

   216

   217

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

   218

   219

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

   220

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

   221

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

   222

	_gw.active   = false;

   223

	_gw.thread   = NULL;

   224

	_gw.proc     = NULL;

   225

	_gw.abortp   = NULL;

   226

	_gw.threaded = false;

   227

   228

	DeleteWindowById(WC_GENERATE_PROGRESS_WINDOW, 0);

   229

	MarkWholeScreenDirty();

   230

   231

	OTTDExitThread();

   232

}

   233

   234

/**

   235

 * Generate a world.

   236

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

   237

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

   238

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

   239

 */

   240

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

   241

{

   242

	if (_gw.active) return;

   243

	_gw.mode   = mode;

   244

	_gw.size_x = size_x;

   245

	_gw.size_y = size_y;

   246

	_gw.active = true;

   247

	_gw.abort  = false;

   248

	_gw.abortp = NULL;

   249

	_gw.lp     = _local_player;

   250

	_gw.wait_for_draw = false;

   251

	_gw.quit_thread   = false;

   252

	_gw.threaded      = true;

   253

   254

	/* This disables some commands and stuff */

   255

	SetLocalPlayer(PLAYER_SPECTATOR);

   256

	/* Make sure everything is done via OWNER_NONE */

   257

	_current_player = OWNER_NONE;

   258

   259

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

   260

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

   261

   262

	/* Load the right landscape stuff */

   263

	GfxLoadSprites();

   264

	LoadStringWidthTable();

   265

   266

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

   267

	PrepareGenerateWorldProgress();

   268

   269

	/* Re-init the windowing system */

   270

	ResetWindowSystem();

   271

   272

	/* Create toolbars */

   273

	SetupColorsAndInitialWindow();

   274

   275

	if (_network_dedicated ||

   276

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

   277

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

   278

		_gw.threaded = false;

   279

		_GenerateWorld(NULL);

   280

		return;

   281

	}

   282

   283

	/* Remove any open window */

   284

	DeleteAllNonVitalWindows();

   285

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

   286

	HideVitalWindows();

   287

   288

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

   289

	ShowGenerateWorldProgress();

   290

   291

	/* Centre the view on the map */

   292

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

   293

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

   294

	}

   295

}