1

/* $Id$ */

     2

     3

/** @file genworld.cpp */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "functions.h"

     8

#include "player.h"

     9

#include "table/sprites.h"

    10

#include "variables.h"

    11

#include "thread.h"

    12

#include "genworld.h"

    13

#include "gfx.h"

    14

#include "gfxinit.h"

    15

#include "gui.h"

    16

#include "network/network.h"

    17

#include "debug.h"

    18

#include "settings.h"

    19

#include "heightmap.h"

    20

#include "date.h"

    21

    22

void GenerateLandscape(byte mode);

    23

void GenerateClearTile(void);

    24

void GenerateIndustries(void);

    25

void GenerateUnmovables(void);

    26

bool GenerateTowns(void);

    27

void GenerateTrees(void);

    28

    29

void StartupEconomy(void);

    30

void StartupPlayers(void);

    31

void StartupDisasters(void);

    32

    33

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

    34

    35

void ConvertGroundTilesIntoWaterTiles(void);

    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(void)

    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(void)

    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, 0, 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

	return NULL;

   159

}

   160

   161

/**

   162

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

   163

 *  generation is done.

   164

 */

   165

void GenerateWorldSetCallback(gw_done_proc *proc)

   166

{

   167

	_gw.proc = proc;

   168

}

   169

   170

/**

   171

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

   172

 *  generation is aborted.

   173

 */

   174

void GenerateWorldSetAbortCallback(gw_abort_proc *proc)

   175

{

   176

	_gw.abortp = proc;

   177

}

   178

   179

/**

   180

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

   181

 *  till the work is done.

   182

 */

   183

void WaitTillGeneratedWorld(void)

   184

{

   185

	if (_gw.thread == NULL) return;

   186

	_gw.quit_thread = true;

   187

	OTTDJoinThread((OTTDThread*)_gw.thread);

   188

	_gw.thread   = NULL;

   189

	_gw.threaded = false;

   190

}

   191

   192

/**

   193

 * Initializes the abortion process

   194

 */

   195

void AbortGeneratingWorld(void)

   196

{

   197

	_gw.abort = true;

   198

}

   199

   200

/**

   201

 * Is the generation being aborted?

   202

 */

   203

bool IsGeneratingWorldAborted(void)

   204

{

   205

	return _gw.abort;

   206

}

   207

   208

/**

   209

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

   210

 */

   211

void HandleGeneratingWorldAbortion(void)

   212

{

   213

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

   214

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

   215

   216

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

   217

   218

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

   219

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

   220

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

   221

	_gw.active   = false;

   222

	_gw.thread   = NULL;

   223

	_gw.proc     = NULL;

   224

	_gw.abortp   = NULL;

   225

	_gw.threaded = false;

   226

   227

	DeleteWindowById(WC_GENERATE_PROGRESS_WINDOW, 0);

   228

	MarkWholeScreenDirty();

   229

   230

	OTTDExitThread();

   231

}

   232

   233

/**

   234

 * Generate a world.

   235

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

   236

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

   237

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

   238

 */

   239

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

   240

{

   241

	if (_gw.active) return;

   242

	_gw.mode   = mode;

   243

	_gw.size_x = size_x;

   244

	_gw.size_y = size_y;

   245

	_gw.active = true;

   246

	_gw.abort  = false;

   247

	_gw.abortp = NULL;

   248

	_gw.lp     = _local_player;

   249

	_gw.wait_for_draw = false;

   250

	_gw.quit_thread   = false;

   251

	_gw.threaded      = true;

   252

   253

	/* This disables some commands and stuff */

   254

	SetLocalPlayer(PLAYER_SPECTATOR);

   255

	/* Make sure everything is done via OWNER_NONE */

   256

	_current_player = OWNER_NONE;

   257

   258

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

   259

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

   260

   261

	/* Load the right landscape stuff */

   262

	GfxLoadSprites();

   263

	LoadStringWidthTable();

   264

   265

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

   266

	PrepareGenerateWorldProgress();

   267

   268

	/* Re-init the windowing system */

   269

	ResetWindowSystem();

   270

   271

	/* Create toolbars */

   272

	SetupColorsAndInitialWindow();

   273

   274

	if (_network_dedicated ||

   275

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

   276

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

   277

		_gw.threaded = false;

   278

		_GenerateWorld(NULL);

   279

		return;

   280

	}

   281

   282

	/* Remove any open window */

   283

	DeleteAllNonVitalWindows();

   284

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

   285

	HideVitalWindows();

   286

   287

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

   288

	ShowGenerateWorldProgress();

   289

   290

	/* Centre the view on the map */

   291

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

   292

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

   293

	}

   294

}