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

    19

void GenerateLandscape(byte mode);

    20

void GenerateClearTile(void);

    21

void GenerateIndustries(void);

    22

void GenerateUnmovables(void);

    23

bool GenerateTowns(void);

    24

void GenerateTrees(void);

    25

    26

void StartupEconomy(void);

    27

void StartupPlayers(void);

    28

void StartupDisasters(void);

    29

    30

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

    31

    32

void ConvertGroundTilesIntoWaterTiles(void);

    33

    34

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

    35

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

    36

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

    37

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

    38

gw_info _gw;

    39

    40

/**

    41

 * Set the status of the Paint flag.

    42

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

    43

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

    44

 *  SetGeneratingWorldProgress(), so calling that function will stall

    45

 *  from time to time.

    46

 */

    47

void SetGeneratingWorldPaintStatus(bool status)

    48

{

    49

	_gw.wait_for_draw = status;

    50

}

    51

    52

/**

    53

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

    54

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

    55

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

    56

 *  same tile at the same time).

    57

 */

    58

bool IsGeneratingWorldReadyForPaint(void)

    59

{

    60

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

    61

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

    62

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

    63

    64

	return _gw.wait_for_draw;

    65

}

    66

    67

/**

    68

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

    69

 */

    70

bool IsGenerateWorldThreaded(void)

    71

{

    72

	return _gw.threaded && !_gw.quit_thread;

    73

}

    74

    75

/**

    76

 * The internal, real, generate function.

    77

 */

    78

static void *_GenerateWorld(void *arg)

    79

{

    80

	_generating_world = true;

    81

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

    82

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

    83

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

    84

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

    85

	SetGeneratingWorldProgress(GWP_MAP_INIT, 2);

    86

	SetObjectToPlace(SPR_CURSOR_ZZZ, 0, 0, 0);

    87

    88

	IncreaseGeneratingWorldProgress(GWP_MAP_INIT);

    89

	// Must start economy early because of the costs.

    90

	StartupEconomy();

    91

    92

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

    93

	if (_gw.mode == GW_EMPTY) {

    94

		SetGeneratingWorldProgress(GWP_UNMOVABLE, 1);

    95

    96

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

    97

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

    98

    99

		ConvertGroundTilesIntoWaterTiles();

   100

		IncreaseGeneratingWorldProgress(GWP_UNMOVABLE);

   101

	} else {

   102

		GenerateLandscape(_gw.mode);

   103

		GenerateClearTile();

   104

   105

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

   106

		if (_game_mode != GM_EDITOR) {

   107

			GenerateTowns();

   108

			GenerateIndustries();

   109

			GenerateUnmovables();

   110

			GenerateTrees();

   111

		}

   112

	}

   113

   114

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

   115

	SetGeneratingWorldProgress(GWP_GAME_INIT, 3);

   116

	StartupPlayers();

   117

	IncreaseGeneratingWorldProgress(GWP_GAME_INIT);

   118

	StartupEngines();

   119

	IncreaseGeneratingWorldProgress(GWP_GAME_INIT);

   120

	StartupDisasters();

   121

	_generating_world = false;

   122

   123

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

   124

	if (_gw.mode != GW_EMPTY) {

   125

		uint i;

   126

   127

		SetGeneratingWorldProgress(GWP_RUNTILELOOP, 0x500);

   128

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

   129

			RunTileLoop();

   130

			IncreaseGeneratingWorldProgress(GWP_RUNTILELOOP);

   131

		}

   132

	}

   133

   134

	ResetObjectToPlace();

   135

	_local_player = _gw.lp;

   136

   137

	SetGeneratingWorldProgress(GWP_GAME_START, 1);

   138

	/* Call any callback */

   139

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

   140

	IncreaseGeneratingWorldProgress(GWP_GAME_START);

   141

   142

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

   143

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

   144

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

   145

	_gw.active   = false;

   146

	_gw.thread   = NULL;

   147

	_gw.proc     = NULL;

   148

	_gw.threaded = false;

   149

   150

	DeleteWindowById(WC_GENERATE_PROGRESS_WINDOW, 0);

   151

	MarkWholeScreenDirty();

   152

   153

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

   154

   155

	return NULL;

   156

}

   157

   158

/**

   159

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

   160

 *  generation is done.

   161

 */

   162

void GenerateWorldSetCallback(gw_done_proc *proc)

   163

{

   164

	_gw.proc = proc;

   165

}

   166

   167

/**

   177

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

   178

 *  till the work is done.

   179

 */

   180

void WaitTillGeneratedWorld(void)

   181

{

   182

	if (_gw.thread == NULL) return;

   183

	_gw.quit_thread = true;

   184

	OTTDJoinThread(_gw.thread);

   185

	_gw.thread   = NULL;

   186

	_gw.threaded = false;

   187

}

   188

   189

/**

   190

 * Initializes the abortion process

   191

 */

   192

void AbortGeneratingWorld(void)

   193

{

   194

	_gw.abort = true;

   195

}

   196

   197

/**

   198

 * Is the generation being aborted?

   199

 */

   200

bool IsGeneratingWorldAborted(void)

   201

{

   202

	return _gw.abort;

   203

}

   204

   205

/**

   206

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

   207

 */

   208

void HandleGeneratingWorldAbortion(void)

   209

{

   210

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

   211

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

   212

   215

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

   216

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

   217

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

   218

	_gw.active   = false;

   219

	_gw.thread   = NULL;

   220

	_gw.proc     = NULL;

   222

	_gw.threaded = false;

   223

   224

	DeleteWindowById(WC_GENERATE_PROGRESS_WINDOW, 0);

   225

	MarkWholeScreenDirty();

   226

   227

	OTTDExitThread();

   228

}

   229

   230

/**

   231

 * Generate a world.

   232

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

   233

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

   234

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

   235

 */

   236

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

   237

{

   238

	if (_gw.active) return;

   239

	_gw.mode   = mode;

   240

	_gw.size_x = size_x;

   241

	_gw.size_y = size_y;

   242

	_gw.active = true;

   243

	_gw.abort  = false;

   245

	_gw.lp     = _local_player;

   246

	_gw.wait_for_draw = false;

   247

	_gw.quit_thread   = false;

   248

	_gw.threaded      = true;

   249

   250

	/* This disables some commands and stuff */

   251

	_local_player   = PLAYER_SPECTATOR;

   252

	/* Make sure everything is done via OWNER_NONE */

   253

	_current_player = OWNER_NONE;

   254

   255

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

   256

	PrepareGenerateWorldProgress();

   257

   258

	/* Re-init the windowing system */

   259

	ResetWindowSystem();

   260

	LoadStringWidthTable();

   261

   262

	/* Create toolbars */

   263

	SetupColorsAndInitialWindow();

   264

   265

	/* Load the right landscape stuff */

   266

	GfxLoadSprites();

   267

	if (_network_dedicated ||

   268

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

   269

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

   270

		_gw.threaded = false;

   271

		_GenerateWorld(NULL);

   272

		return;

   273

	}

   274

   275

	/* Remove any open window */

   276

	DeleteAllNonVitalWindows();

   277

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

   278

	HideVitalWindows();

   279

   280

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

   281

	ShowGenerateWorldProgress();

   282

   283

	/* Centre the view on the map */

   284

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

   285

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

   286

	}

   287

}