1

/* $Id$ */

     2

     3

/** @file genworld.h */

     4

     5

#ifndef GENWORLD_H

     6

#define GENWORLD_H

     7

     8

#include "player_type.h"

     9

    10

/*

    11

 * Order of these enums has to be the same as in lang/english.txt

    12

 * Otherwise you will get inconsistent behaviour.

    13

 */

    14

enum {

    15

	LG_ORIGINAL     = 0,  ///< The original landscape generator

    16

	LG_TERRAGENESIS = 1,  ///< TerraGenesis Perlin landscape generator

    17

    18

	GENERATE_NEW_SEED = (uint)-1, ///< Create a new random seed

    19

};

    20

    21

typedef void gw_done_proc();

    22

typedef void gw_abort_proc();

    23

    24

struct gw_info {

    25

	bool active;           ///< Is generating world active

    26

	bool abort;            ///< Whether to abort the thread ASAP

    27

	bool wait_for_draw;    ///< Are we waiting on a draw event

    28

	bool quit_thread;      ///< Do we want to quit the active thread

    29

	bool threaded;         ///< Whether we run _GenerateWorld threaded

    30

	int mode;              ///< What mode are we making a world in

    31

	PlayerID lp;           ///< The local_player before generating

    32

	uint size_x;           ///< X-size of the map

    33

	uint size_y;           ///< Y-size of the map

    34

	gw_done_proc *proc;    ///< Proc that is called when done (can be NULL)

    35

	gw_abort_proc *abortp; ///< Proc that is called when aborting (can be NULL)

    36

	class ThreadObject *thread; ///< The thread we are in (can be NULL)

    37

};

    38

    39

enum gwp_class {

    40

	GWP_MAP_INIT,    ///< Initialize/allocate the map, start economy

    41

	GWP_LANDSCAPE,   ///< Create the landscape

    42

	GWP_ROUGH_ROCKY, ///< Make rough and rocky areas

    43

	GWP_TOWN,        ///< Generate towns

    44

	GWP_INDUSTRY,    ///< Generate industries

    45

	GWP_UNMOVABLE,   ///< Generate unmovables (radio tower, light houses)

    46

	GWP_TREE,        ///< Generate trees

    47

	GWP_GAME_INIT,   ///< Initialize the game

    48

	GWP_RUNTILELOOP, ///< Runs the tile loop 1280 times to make snow etc

    49

	GWP_GAME_START,  ///< Really prepare to start the game

    50

	GWP_CLASS_COUNT

    51

};

    52

    53

/**

    54

 * Check if we are currently in the process of generating a world.

    55

 */

    56

static inline bool IsGeneratingWorld()

    57

{

    58

	extern gw_info _gw;

    59

    60

	return _gw.active;

    61

}

    62

    63

/* genworld.cpp */

    64

void SetGeneratingWorldPaintStatus(bool status);

    65

bool IsGeneratingWorldReadyForPaint();

    66

bool IsGenerateWorldThreaded();

    67

void GenerateWorldSetCallback(gw_done_proc *proc);

    68

void GenerateWorldSetAbortCallback(gw_abort_proc *proc);

    69

void WaitTillGeneratedWorld();

    70

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

    71

void AbortGeneratingWorld();

    72

bool IsGeneratingWorldAborted();

    73

void HandleGeneratingWorldAbortion();

    74

    75

/* genworld_gui.cpp */

    76

void SetGeneratingWorldProgress(gwp_class cls, uint total);

    77

void IncreaseGeneratingWorldProgress(gwp_class cls);

    78

void PrepareGenerateWorldProgress();

    79

void ShowGenerateWorldProgress();

    80

void StartNewGameWithoutGUI(uint seed);

    81

void ShowCreateScenario();

    82

void StartScenarioEditor();

    83

    84

#endif /* GENWORLD_H */