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"

    18

#include "network/network.h"

    19

#include "debug.h"

    20

#include "settings.h"

    21

#include "heightmap.h"

    22

#include "date.h"

    23

#include "viewport.h"

    24

    25

void GenerateClearTile();

    26

void GenerateIndustries();

    27

void GenerateUnmovables();

    28

bool GenerateTowns();

    29

void GenerateTrees();

    30

    31

void StartupEconomy();

    32

void StartupPlayers();

    33

void StartupDisasters();

    34

    35

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

    36

    37

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

    38

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

    39

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

    40

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

    41

gw_info _gw;

    42

    43

/**

    44

 * Set the status of the Paint flag.

    45

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

    46

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

    47

 *  SetGeneratingWorldProgress(), so calling that function will stall

    48

 *  from time to time.

    49

 */

    50

void SetGeneratingWorldPaintStatus(bool status)

    51

{

    52

	_gw.wait_for_draw = status;

    53

}

    54

    55

/**

    56

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

    57

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

    58

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

    59

 *  same tile at the same time).

    60

 */

    61

bool IsGeneratingWorldReadyForPaint()

    62

{

    63

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

    64

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

    65

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

    66

    67

	return _gw.wait_for_draw;

    68

}

    69

    70

/**

    71

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

    72

 */

    73

bool IsGenerateWorldThreaded()

    74

{

    75

	return _gw.threaded && !_gw.quit_thread;

    76

}

    77

    78

/**

    79

 * The internal, real, generate function.

    80

 */

    81

static void *_GenerateWorld(void *arg)

    82

{

    83

	_generating_world = true;

    84

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

    85

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

    86

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

    87

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

    88

	SetGeneratingWorldProgress(GWP_MAP_INIT, 2);

    89

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

    90

    91

	IncreaseGeneratingWorldProgress(GWP_MAP_INIT);

    92

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

    93

	StartupEconomy();

    94

    95

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

    96

	if (_gw.mode == GW_EMPTY) {

    97

		SetGeneratingWorldProgress(GWP_UNMOVABLE, 1);

    98

    99

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

   100

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

   101

   102

		ConvertGroundTilesIntoWaterTiles();

   103

		IncreaseGeneratingWorldProgress(GWP_UNMOVABLE);

   104

	} else {

   105

		GenerateLandscape(_gw.mode);

   106

		GenerateClearTile();

   107

   108

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

   109

		if (_game_mode != GM_EDITOR) {

   110

			GenerateTowns();

   111

			GenerateIndustries();

   112

			GenerateUnmovables();

   113

			GenerateTrees();

   114

		}

   115

	}

   116

   117

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

   118

	SetGeneratingWorldProgress(GWP_GAME_INIT, 3);

   119

	StartupPlayers();

   120

	IncreaseGeneratingWorldProgress(GWP_GAME_INIT);

   121

	StartupEngines();

   122

	IncreaseGeneratingWorldProgress(GWP_GAME_INIT);

   123

	StartupDisasters();

   124

	_generating_world = false;

   125

   126

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

   127

	if (_gw.mode != GW_EMPTY) {

   128

		uint i;

   129

   130

		SetGeneratingWorldProgress(GWP_RUNTILELOOP, 0x500);

   131

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

   132

			RunTileLoop();

   133

			IncreaseGeneratingWorldProgress(GWP_RUNTILELOOP);

   134

		}

   135

	}

   136

   137

	ResetObjectToPlace();

   138

	SetLocalPlayer(_gw.lp);

   139

   140

	SetGeneratingWorldProgress(GWP_GAME_START, 1);

   141

	/* Call any callback */

   142

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

   143

	IncreaseGeneratingWorldProgress(GWP_GAME_START);

   144

   145

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

   146

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

   147

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

   148

	_gw.active   = false;

   149

	_gw.thread   = NULL;

   150

	_gw.proc     = NULL;

   151

	_gw.threaded = false;

   152

   153

	DeleteWindowById(WC_GENERATE_PROGRESS_WINDOW, 0);

   154

	MarkWholeScreenDirty();

   155

   156

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

   157

   158

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

   159

   160

	return NULL;

   161

}

   162

   163

/**

   164

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

   165

 *  generation is done.

   166

 */

   167

void GenerateWorldSetCallback(gw_done_proc *proc)

   168

{

   169

	_gw.proc = proc;

   170

}

   171

   172

/**

   173

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

   174

 *  generation is aborted.

   175

 */

   176

void GenerateWorldSetAbortCallback(gw_abort_proc *proc)

   177

{

   178

	_gw.abortp = proc;

   179

}

   180

   181

/**

   182

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

   183

 *  till the work is done.

   184

 */

   185

void WaitTillGeneratedWorld()

   186

{

   187

	if (_gw.thread == NULL) return;

   188

	_gw.quit_thread = true;

   189

	OTTDJoinThread((OTTDThread*)_gw.thread);

   190

	_gw.thread   = NULL;

   191

	_gw.threaded = false;

   192

}

   193

   194

/**

   195

 * Initializes the abortion process

   196

 */

   197

void AbortGeneratingWorld()

   198

{

   199

	_gw.abort = true;

   200

}

   201

   202

/**

   203

 * Is the generation being aborted?

   204

 */

   205

bool IsGeneratingWorldAborted()

   206

{

   207

	return _gw.abort;

   208

}

   209

   210

/**

   211

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

   212

 */

   213

void HandleGeneratingWorldAbortion()

   214

{

   215

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

   216

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

   217

   218

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

   219

   220

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

   221

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

   222

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

   223

	_gw.active   = false;

   224

	_gw.thread   = NULL;

   225

	_gw.proc     = NULL;

   226

	_gw.abortp   = NULL;

   227

	_gw.threaded = false;

   228

   229

	DeleteWindowById(WC_GENERATE_PROGRESS_WINDOW, 0);

   230

	MarkWholeScreenDirty();

   231

   232

	OTTDExitThread();

   233

}

   234

   235

/**

   236

 * Generate a world.

   237

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

   238

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

   239

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

   240

 */

   241

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

   242

{

   243

	if (_gw.active) return;

   244

	_gw.mode   = mode;

   245

	_gw.size_x = size_x;

   246

	_gw.size_y = size_y;

   247

	_gw.active = true;

   248

	_gw.abort  = false;

   249

	_gw.abortp = NULL;

   250

	_gw.lp     = _local_player;

   251

	_gw.wait_for_draw = false;

   252

	_gw.quit_thread   = false;

   253

	_gw.threaded      = true;

   254

   255

	/* This disables some commands and stuff */

   256

	SetLocalPlayer(PLAYER_SPECTATOR);

   257

	/* Make sure everything is done via OWNER_NONE */

   258

	_current_player = OWNER_NONE;

   259

   260

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

   261

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

   262

   263

	/* Load the right landscape stuff */

   264

	GfxLoadSprites();

   265

	LoadStringWidthTable();

   266

   267

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

   268

	PrepareGenerateWorldProgress();

   269

   270

	/* Re-init the windowing system */

   271

	ResetWindowSystem();

   272

   273

	/* Create toolbars */

   274

	SetupColorsAndInitialWindow();

   275

   276

	if (_network_dedicated ||

   277

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

   278

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

   279

		_gw.threaded = false;

   280

		_GenerateWorld(NULL);

   281

		return;

   282

	}

   283

   284

	/* Remove any open window */

   285

	DeleteAllNonVitalWindows();

   286

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

   287

	HideVitalWindows();

   288

   289

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

   290

	ShowGenerateWorldProgress();

   291

   292

	/* Centre the view on the map */

   293

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

   294

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

   295

	}

   296

}