1

/* $Id$ */

     2

     3

/** @file genworld.h */

     4

     5

#ifndef GENWORLD_H

     6

#define GENWORLD_H

     7

     8

/* If OTTDThread isn't defined, define it to a void, but make sure to undefine

     9

 *  it after this include. This makes including genworld.h easier, as you

    10

 *  don't need to include thread.h before it, while it stays possible to

    11

 *  include it after it, and still work.

    12

 */

    13

#ifndef OTTDThread

    14

#define TEMPORARY_OTTDTHREAD_DEFINITION

    15

#define OTTDThread void

    16

#endif

    17

    18

/*

    19

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

    20

 * Otherwise you will get inconsistent behaviour.

    21

 */

    22

enum {

    23

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

    24

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

    25

    26

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

    27

};

    28

    29

typedef void gw_done_proc();

    30

typedef void gw_abort_proc();

    31

    32

struct gw_info {

    33

	bool active;           ///< Is generating world active

    34

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

    35

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

    36

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

    37

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

    38

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

    39

	PlayerID lp;           ///< The local_player before generating

    40

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

    41

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

    42

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

    43

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

    44

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

    45

};

    46

    47

#ifdef TEMPORARY_OTTDTHREAD_DEFINITION

    48

#undef OTTDThread

    49

#undef TEMPORARY_OTTDTHREAD_DEFINITION

    50

#endif

    51

    52

enum gwp_class {

    53

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

    54

	GWP_LANDSCAPE,   ///< Create the landscape

    55

	GWP_ROUGH_ROCKY, ///< Make rough and rocky areas

    56

	GWP_TOWN,        ///< Generate towns

    57

	GWP_INDUSTRY,    ///< Generate industries

    58

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

    59

	GWP_TREE,        ///< Generate trees

    60

	GWP_GAME_INIT,   ///< Initialize the game

    61

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

    62

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

    63

	GWP_CLASS_COUNT

    64

};

    65

    66

/**

    67

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

    68

 */

    69

static inline bool IsGeneratingWorld()

    70

{

    71

	extern gw_info _gw;

    72

    73

	return _gw.active;

    74

}

    75

    76

/* genworld.cpp */

    77

void SetGeneratingWorldPaintStatus(bool status);

    78

bool IsGeneratingWorldReadyForPaint();

    79

bool IsGenerateWorldThreaded();

    80

void GenerateWorldSetCallback(gw_done_proc *proc);

    81

void GenerateWorldSetAbortCallback(gw_abort_proc *proc);

    82

void WaitTillGeneratedWorld();

    83

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

    84

void AbortGeneratingWorld();

    85

bool IsGeneratingWorldAborted();

    86

void HandleGeneratingWorldAbortion();

    87

    88

/* genworld_gui.cpp */

    89

void SetGeneratingWorldProgress(gwp_class cls, uint total);

    90

void IncreaseGeneratingWorldProgress(gwp_class cls);

    91

void PrepareGenerateWorldProgress();

    92

void ShowGenerateWorldProgress();

    93

void StartNewGameWithoutGUI(uint seed);

    94

void ShowCreateScenario();

    95

void StartScenarioEditor();

    96

    97

#endif /* GENWORLD_H */