1

/* $Id$ */

     2

     3

#include "stdafx.h"

     4

#include "openttd.h"

     5

#include "functions.h"

     6

#include "player.h"

     7

#include "table/sprites.h"

     8

#include "variables.h"

     9

#include "thread.h"

    10

#include "genworld.h"

    11

#include "gfx.h"

    12

#include "gfxinit.h"

    13

#include "gui.h"

    14

#include "network.h"

    15

#include "debug.h"

    16

#include "settings.h"

    17

#include "heightmap.h"

    18

#include "date.h"

    19

    20

void GenerateLandscape(byte mode);

    21

void GenerateClearTile(void);

    22

void GenerateIndustries(void);

    23

void GenerateUnmovables(void);

    24

bool GenerateTowns(void);

    25

void GenerateTrees(void);

    26

    27

void StartupEconomy(void);

    28

void StartupPlayers(void);

    29

void StartupDisasters(void);

    30

    31

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

    32

    33

void ConvertGroundTilesIntoWaterTiles(void);

    34

    35

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

    36

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

    37

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

    38

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

    39

gw_info _gw;

    40

    41

/**

    42

 * Set the status of the Paint flag.

    43

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

    44

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

    45

 *  SetGeneratingWorldProgress(), so calling that function will stall

    46

 *  from time to time.

    47

 */

    48

void SetGeneratingWorldPaintStatus(bool status)

    49

{

    50

	_gw.wait_for_draw = status;

    51

}

    52

    53

/**

    54

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

    55

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

    56

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

    57

 *  same tile at the same time).

    58

 */

    59

bool IsGeneratingWorldReadyForPaint(void)

    60

{

    61

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

    62

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

    63

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

    64

    65

	return _gw.wait_for_draw;

    66

}

    67

    68

/**

    69

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

    70

 */

    71

bool IsGenerateWorldThreaded(void)

    72

{

    73

	return _gw.threaded && !_gw.quit_thread;

    74

}

    75

    76

/**

    77

 * The internal, real, generate function.

    78

 */

    79

static void *_GenerateWorld(void *arg)

    80

{

    81

	_generating_world = true;

    82

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

    83

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

    84

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

    85

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

    86

	SetGeneratingWorldProgress(GWP_MAP_INIT, 2);

    87

	SetObjectToPlace(SPR_CURSOR_ZZZ, 0, 0, 0);

    88

    89

	IncreaseGeneratingWorldProgress(GWP_MAP_INIT);

    90

	// Must start economy early because of the costs.

    91

	StartupEconomy();

    92

    93

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

    94

	if (_gw.mode == GW_EMPTY) {

    95

		SetGeneratingWorldProgress(GWP_UNMOVABLE, 1);

    96

    97

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

    98

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

    99

   100

		ConvertGroundTilesIntoWaterTiles();

   101

		IncreaseGeneratingWorldProgress(GWP_UNMOVABLE);

   102

	} else {

   103

		GenerateLandscape(_gw.mode);

   104

		GenerateClearTile();

   105

   106

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

   107

		if (_game_mode != GM_EDITOR) {

   108

			GenerateTowns();

   109

			GenerateIndustries();

   110

			GenerateUnmovables();

   111

			GenerateTrees();

   112

		}

   113

	}

   114

   115

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

   116

	SetGeneratingWorldProgress(GWP_GAME_INIT, 3);

   117

	StartupPlayers();

   118

	IncreaseGeneratingWorldProgress(GWP_GAME_INIT);

   119

	StartupEngines();

   120

	IncreaseGeneratingWorldProgress(GWP_GAME_INIT);

   121

	StartupDisasters();

   122

	_generating_world = false;

   123

   124

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

   125

	if (_gw.mode != GW_EMPTY) {

   126

		uint i;

   127

   128

		SetGeneratingWorldProgress(GWP_RUNTILELOOP, 0x500);

   129

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

   130

			RunTileLoop();

   131

			IncreaseGeneratingWorldProgress(GWP_RUNTILELOOP);

   132

		}

   133

	}

   134

   135

	ResetObjectToPlace();

   136

	SetLocalPlayer(_gw.lp);

   137

   138

	SetGeneratingWorldProgress(GWP_GAME_START, 1);

   139

	/* Call any callback */

   140

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

   141

	IncreaseGeneratingWorldProgress(GWP_GAME_START);

   142

   143

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

   144

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

   145

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

   146

	_gw.active   = false;

   147

	_gw.thread   = NULL;

   148

	_gw.proc     = NULL;

   149

	_gw.threaded = false;

   150

   151

	DeleteWindowById(WC_GENERATE_PROGRESS_WINDOW, 0);

   152

	MarkWholeScreenDirty();

   153

   154

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

   155

   156

	return NULL;

   157

}

   158

   159

/**

   160

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

   161

 *  generation is done.

   162

 */

   163

void GenerateWorldSetCallback(gw_done_proc *proc)

   164

{

   165

	_gw.proc = proc;

   166

}

   167

   168

/**

   169

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

   170

 *  generation is aborted.

   171

 */

   172

void GenerateWorldSetAbortCallback(gw_abort_proc *proc)

   173

{

   174

	_gw.abortp = proc;

   175

}

   176

   177

/**

   178

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

   179

 *  till the work is done.

   180

 */

   181

void WaitTillGeneratedWorld(void)

   182

{

   183

	if (_gw.thread == NULL) return;

   184

	_gw.quit_thread = true;

   185

	OTTDJoinThread(_gw.thread);

   186

	_gw.thread   = NULL;

   187

	_gw.threaded = false;

   188

}

   189

   190

/**

   191

 * Initializes the abortion process

   192

 */

   193

void AbortGeneratingWorld(void)

   194

{

   195

	_gw.abort = true;

   196

}

   197

   198

/**

   199

 * Is the generation being aborted?

   200

 */

   201

bool IsGeneratingWorldAborted(void)

   202

{

   203

	return _gw.abort;

   204

}

   205

   206

/**

   207

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

   208

 */

   209

void HandleGeneratingWorldAbortion(void)

   210

{

   211

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

   212

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

   213

   214

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

   215

   216

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

   217

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

   218

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

   219

	_gw.active   = false;

   220

	_gw.thread   = NULL;

   221

	_gw.proc     = NULL;

   222

	_gw.abortp   = NULL;

   223

	_gw.threaded = false;

   224

   225

	DeleteWindowById(WC_GENERATE_PROGRESS_WINDOW, 0);

   226

	MarkWholeScreenDirty();

   227

   228

	OTTDExitThread();

   229

}

   230

   231

/**

   232

 * Generate a world.

   233

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

   234

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

   235

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

   236

 */

   237

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

   238

{

   239

	if (_gw.active) return;

   240

	_gw.mode   = mode;

   241

	_gw.size_x = size_x;

   242

	_gw.size_y = size_y;

   243

	_gw.active = true;

   244

	_gw.abort  = false;

   245

	_gw.abortp = NULL;

   246

	_gw.lp     = _local_player;

   247

	_gw.wait_for_draw = false;

   248

	_gw.quit_thread   = false;

   249

	_gw.threaded      = true;

   250

   251

	/* This disables some commands and stuff */

   252

	SetLocalPlayer(PLAYER_SPECTATOR);

   253

	/* Make sure everything is done via OWNER_NONE */

   254

	_current_player = OWNER_NONE;

   255

   256

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

   257

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

   258

   259

	/* Load the right landscape stuff */

   260

	GfxLoadSprites();

   261

	LoadStringWidthTable();

   262

   263

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

   264

	PrepareGenerateWorldProgress();

   265

   266

	/* Re-init the windowing system */

   267

	ResetWindowSystem();

   268

   269

	/* Create toolbars */

   270

	SetupColorsAndInitialWindow();

   271

   272

	if (_network_dedicated ||

   273

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

   274

		DEBUG(misc, 1) ("[Sl] Cannot create savegame thread, reverting to single-threaded mode...");

   275

		_gw.threaded = false;

   276

		_GenerateWorld(NULL);

   277

		return;

   278

	}

   279

   280

	/* Remove any open window */

   281

	DeleteAllNonVitalWindows();

   282

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

   283

	HideVitalWindows();

   284

   285

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

   286

	ShowGenerateWorldProgress();

   287

   288

	/* Centre the view on the map */

   289

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

   290

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

   291

	}

   292

}