1

/* $Id$ */

     2

     3

/** @file genworld.h Functions related to world/map generation. */

     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

/* Modes for GenerateWorld */

    22

enum GenerateWorldMode {

    23

	GW_NEWGAME   = 0,    /* Generate a map for a new game */

    24

	GW_EMPTY     = 1,    /* Generate an empty map (sea-level) */

    25

	GW_RANDOM    = 2,    /* Generate a random map for SE */

    26

	GW_HEIGHTMAP = 3,    /* Generate a newgame from a heightmap */

    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

	GenerateWorldMode 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

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

    45

};

    46

    47

enum gwp_class {

    48

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

    49

	GWP_LANDSCAPE,   ///< Create the landscape

    50

	GWP_ROUGH_ROCKY, ///< Make rough and rocky areas

    51

	GWP_TOWN,        ///< Generate towns

    52

	GWP_INDUSTRY,    ///< Generate industries

    53

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

    54

	GWP_TREE,        ///< Generate trees

    55

	GWP_GAME_INIT,   ///< Initialize the game

    56

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

    57

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

    58

	GWP_CLASS_COUNT

    59

};

    60

    61

/**

    62

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

    63

 */

    64

static inline bool IsGeneratingWorld()

    65

{

    66

	extern gw_info _gw;

    67

    68

	return _gw.active;

    69

}

    70

    71

/* genworld.cpp */

    72

void SetGeneratingWorldPaintStatus(bool status);

    73

bool IsGeneratingWorldReadyForPaint();

    74

bool IsGenerateWorldThreaded();

    75

void GenerateWorldSetCallback(gw_done_proc *proc);

    76

void GenerateWorldSetAbortCallback(gw_abort_proc *proc);

    77

void WaitTillGeneratedWorld();

    78

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

    79

void AbortGeneratingWorld();

    80

bool IsGeneratingWorldAborted();

    81

void HandleGeneratingWorldAbortion();

    82

    83

/* genworld_gui.cpp */

    84

void SetGeneratingWorldProgress(gwp_class cls, uint total);

    85

void IncreaseGeneratingWorldProgress(gwp_class cls);

    86

void PrepareGenerateWorldProgress();

    87

void ShowGenerateWorldProgress();

    88

void StartNewGameWithoutGUI(uint seed);

    89

void ShowCreateScenario();

    90

void StartScenarioEditor();

    91

    92

#endif /* GENWORLD_H */