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 *_GenerateWorld(void *arg)

    88

{

    89

	_generating_world = true;

    90

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

    91

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

    92

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

    93

	_random.SetSeed(_patches.generation_seed);

    94

	SetGeneratingWorldProgress(GWP_MAP_INIT, 2);

    95

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

    96

    97

	IncreaseGeneratingWorldProgress(GWP_MAP_INIT);

    98

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

    99

	StartupEconomy();

   100

   101

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

   102

	if (_gw.mode == GW_EMPTY) {

   103

		SetGeneratingWorldProgress(GWP_UNMOVABLE, 1);

   104

   105

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

   106

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

   107

   108

		ConvertGroundTilesIntoWaterTiles();

   109

		IncreaseGeneratingWorldProgress(GWP_UNMOVABLE);

   110

	} else {

   111

		GenerateLandscape(_gw.mode);

   112

		GenerateClearTile();

   113

   114

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

   115

		if (_game_mode != GM_EDITOR) {

   116

			GenerateTowns();

   117

			GenerateIndustries();

   118

			GenerateUnmovables();

   119

			GenerateTrees();

   120

		}

   121

	}

   122

   123

	ClearStorageChanges(true);

   124

   125

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

   126

	SetGeneratingWorldProgress(GWP_GAME_INIT, 3);

   127

	StartupPlayers();

   128

	IncreaseGeneratingWorldProgress(GWP_GAME_INIT);

   129

	StartupEngines();

   130

	IncreaseGeneratingWorldProgress(GWP_GAME_INIT);

   131

	StartupDisasters();

   132

	_generating_world = false;

   133

   134

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

   135

	if (_gw.mode != GW_EMPTY) {

   136

		uint i;

   137

   138

		SetGeneratingWorldProgress(GWP_RUNTILELOOP, 0x500);

   139

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

   140

			RunTileLoop();

   141

			IncreaseGeneratingWorldProgress(GWP_RUNTILELOOP);

   142

		}

   143

	}

   144

   145

	ResetObjectToPlace();

   146

	SetLocalPlayer(_gw.lp);

   147

   148

	SetGeneratingWorldProgress(GWP_GAME_START, 1);

   149

	/* Call any callback */

   150

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

   151

	IncreaseGeneratingWorldProgress(GWP_GAME_START);

   152

   153

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

   154

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

   155

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

   156

	_gw.active   = false;

   157

	_gw.thread   = NULL;

   158

	_gw.proc     = NULL;

   159

	_gw.threaded = false;

   160

   161

	DeleteWindowById(WC_GENERATE_PROGRESS_WINDOW, 0);

   162

	MarkWholeScreenDirty();

   163

   164

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

   165

   166

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

   167

   168

	return NULL;

   169

}

   170

   171

/**

   172

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

   173

 *  generation is done.

   174

 */

   175

void GenerateWorldSetCallback(gw_done_proc *proc)

   176

{

   177

	_gw.proc = proc;

   178

}

   179

   180

/**

   181

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

   182

 *  generation is aborted.

   183

 */

   184

void GenerateWorldSetAbortCallback(gw_abort_proc *proc)

   185

{

   186

	_gw.abortp = proc;

   187

}

   188

   189

/**

   190

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

   191

 *  till the work is done.

   192

 */

   193

void WaitTillGeneratedWorld()

   194

{

   195

	if (_gw.thread == NULL) return;

   196

	_gw.quit_thread = true;

   197

	OTTDJoinThread((OTTDThread*)_gw.thread);

   198

	_gw.thread   = NULL;

   199

	_gw.threaded = false;

   200

}

   201

   202

/**

   203

 * Initializes the abortion process

   204

 */

   205

void AbortGeneratingWorld()

   206

{

   207

	_gw.abort = true;

   208

}

   209

   210

/**

   211

 * Is the generation being aborted?

   212

 */

   213

bool IsGeneratingWorldAborted()

   214

{

   215

	return _gw.abort;

   216

}

   217

   218

/**

   219

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

   220

 */

   221

void HandleGeneratingWorldAbortion()

   222

{

   223

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

   224

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

   225

   226

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

   227

   228

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

   229

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

   230

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

   231

	_gw.active   = false;

   232

	_gw.thread   = NULL;

   233

	_gw.proc     = NULL;

   234

	_gw.abortp   = NULL;

   235

	_gw.threaded = false;

   236

   237

	DeleteWindowById(WC_GENERATE_PROGRESS_WINDOW, 0);

   238

	MarkWholeScreenDirty();

   239

   240

	OTTDExitThread();

   241

}

   242

   243

/**

   244

 * Generate a world.

   245

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

   246

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

   247

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

   248

 */

   249

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

   250

{

   251

	if (_gw.active) return;

   252

	_gw.mode   = mode;

   253

	_gw.size_x = size_x;

   254

	_gw.size_y = size_y;

   255

	_gw.active = true;

   256

	_gw.abort  = false;

   257

	_gw.abortp = NULL;

   258

	_gw.lp     = _local_player;

   259

	_gw.wait_for_draw = false;

   260

	_gw.quit_thread   = false;

   261

	_gw.threaded      = true;

   262

   263

	/* This disables some commands and stuff */

   264

	SetLocalPlayer(PLAYER_SPECTATOR);

   265

	/* Make sure everything is done via OWNER_NONE */

   266

	_current_player = OWNER_NONE;

   267

   268

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

   269

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

   270

   271

	/* Load the right landscape stuff */

   272

	GfxLoadSprites();

   273

	LoadStringWidthTable();

   274

   275

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

   276

	PrepareGenerateWorldProgress();

   277

   278

	/* Re-init the windowing system */

   279

	ResetWindowSystem();

   280

   281

	/* Create toolbars */

   282

	SetupColorsAndInitialWindow();

   283

   284

	if (_network_dedicated ||

   285

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

   286

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

   287

		_gw.threaded = false;

   288

		_GenerateWorld(NULL);

   289

		return;

   290

	}

   291

   292

	/* Remove any open window */

   293

	DeleteAllNonVitalWindows();

   294

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

   295

	HideVitalWindows();

   296

   297

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

   298

	ShowGenerateWorldProgress();

   299

   300

	/* Centre the view on the map */

   301

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

   302

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

   303

	}

   304

}