1

/* $Id$ */

     2

/** @file openttd.h */

     3

     4

#ifndef OPENTTD_H

     5

#define OPENTTD_H

     6

     7

#ifndef VARDEF

     8

#define VARDEF extern

     9

#endif

    10

    11

#include "core/enum_type.hpp"

    12

#include "strings_type.h"

    13

    14

// Forward declarations of structs.

    15

struct Depot;

    16

struct Waypoint;

    17

struct Station;

    18

struct ViewPort;

    19

struct Town;

    20

struct NewsItem;

    21

struct Industry;

    22

struct DrawPixelInfo;

    23

struct Group;

    24

typedef byte VehicleOrderID;  ///< The index of an order within its current vehicle (not pool related)

    25

typedef byte LandscapeID;

    26

typedef uint16 EngineID;

    27

typedef uint16 UnitID;

    28

    29

typedef EngineID *EngineList; ///< engine list type placeholder acceptable for C code (see helpers.cpp)

    30

    31

/* IDs used in Pools */

    32

typedef uint16 StationID;

    33

static const StationID INVALID_STATION = 0xFFFF;

    34

typedef uint16 RoadStopID;

    35

typedef uint16 TownID;

    36

typedef uint16 IndustryID;

    37

typedef uint16 DepotID;

    38

typedef uint16 WaypointID;

    39

typedef uint16 OrderID;

    40

typedef uint16 SignID;

    41

typedef uint16 GroupID;

    42

typedef uint16 EngineRenewID;

    43

typedef uint16 DestinationID;

    44

    45

/* DestinationID must be at least as large as every these below, because it can

    46

 * be any of them

    47

 */

    48

assert_compile(sizeof(DestinationID) == sizeof(DepotID));

    49

assert_compile(sizeof(DestinationID) == sizeof(WaypointID));

    50

assert_compile(sizeof(DestinationID) == sizeof(StationID));

    51

    52

typedef uint32 PlayerFace; ///< player face bits, info see in player_face.h

    53

    54

enum GameModes {

    55

	GM_MENU,

    56

	GM_NORMAL,

    57

	GM_EDITOR

    58

};

    59

    60

enum SwitchModes {

    61

	SM_NONE            =  0,

    62

	SM_NEWGAME         =  1,

    63

	SM_EDITOR          =  2,

    64

	SM_LOAD            =  3,

    65

	SM_MENU            =  4,

    66

	SM_SAVE            =  5,

    67

	SM_GENRANDLAND     =  6,

    68

	SM_LOAD_SCENARIO   =  9,

    69

	SM_START_SCENARIO  = 10,

    70

	SM_START_HEIGHTMAP = 11,

    71

	SM_LOAD_HEIGHTMAP  = 12,

    72

};

    73

    74

    75

/* Modes for GenerateWorld */

    76

enum GenerateWorldModes {

    77

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

    78

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

    79

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

    80

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

    81

};

    82

    83

/* Modes for InitializeGame, those are _bits_! */

    84

enum InitializeGameModes {

    85

	IG_NONE       = 0,  /* Don't do anything special */

    86

	IG_DATE_RESET = 1,  /* Reset the date when initializing a game */

    87

};

    88

    89

enum Owner {

    90

	PLAYER_INACTIVE_CLIENT = 253,

    91

	PLAYER_NEW_COMPANY = 254,

    92

	PLAYER_SPECTATOR = 255,

    93

	OWNER_BEGIN     = 0x00,

    94

	PLAYER_FIRST    = 0x00,

    95

	MAX_PLAYERS     = 8,

    96

	OWNER_TOWN      = 0x0F, // a town owns the tile

    97

	OWNER_NONE      = 0x10, // nobody owns the tile

    98

	OWNER_WATER     = 0x11, // "water" owns the tile

    99

	OWNER_END       = 0x12,

   100

	INVALID_OWNER   = 0xFF,

   101

	INVALID_PLAYER  = 0xFF,

   102

	/* Player identifiers All players below MAX_PLAYERS are playable

   103

	* players, above, they are special, computer controlled players */

   104

};

   105

   106

typedef Owner PlayerID;

   107

   108

DECLARE_POSTFIX_INCREMENT(Owner);

   109

   110

/** Define basic enum properties */

   111

template <> struct EnumPropsT<Owner> : MakeEnumPropsT<Owner, byte, OWNER_BEGIN, OWNER_END, INVALID_OWNER> {};

   112

typedef TinyEnumT<Owner> OwnerByte;

   113

typedef OwnerByte PlayerByte;

   114

   115

   116

enum TransportType {

   117

	/* These constants are for now linked to the representation of bridges

   118

	 * and tunnels, so they can be used by GetTileTrackStatus_TunnelBridge.

   119

	 * In an ideal world, these constants would be used everywhere when

   120

	 * accessing tunnels and bridges. For now, you should just not change

   121

	 * the values for road and rail.

   122

	 */

   123

	TRANSPORT_BEGIN = 0,

   124

	TRANSPORT_RAIL = 0,

   125

	TRANSPORT_ROAD = 1,

   126

	TRANSPORT_WATER, // = 2

   127

	TRANSPORT_END,

   128

	INVALID_TRANSPORT = 0xff,

   129

};

   130

   131

/** Define basic enum properties */

   132

template <> struct EnumPropsT<TransportType> : MakeEnumPropsT<TransportType, byte, TRANSPORT_BEGIN, TRANSPORT_END, INVALID_TRANSPORT> {};

   133

typedef TinyEnumT<TransportType> TransportTypeByte;

   134

   135

   136

/* Display Options */

   137

enum {

   138

	DO_SHOW_TOWN_NAMES    = 0,

   139

	DO_SHOW_STATION_NAMES = 1,

   140

	DO_SHOW_SIGNS         = 2,

   141

	DO_FULL_ANIMATION     = 3,

   142

	DO_FULL_DETAIL        = 5,

   143

	DO_WAYPOINTS          = 6,

   144

};

   145

   146

/* Landscape types */

   147

enum {

   148

	LT_TEMPERATE  = 0,

   149

	LT_ARCTIC     = 1,

   150

	LT_TROPIC     = 2,

   151

	LT_TOYLAND    = 3,

   152

   153

	NUM_LANDSCAPE = 4,

   154

};

   155

   156

/**

   157

 * Town Layouts

   158

 */

   159

enum TownLayout {

   160

	TL_NO_ROADS     = 0, ///< Build no more roads, but still build houses

   161

	TL_ORIGINAL,         ///< Original algorithm (min. 1 distance between roads)

   162

	TL_BETTER_ROADS,     ///< Extended original algorithm (min. 2 distance between roads)

   163

	TL_2X2_GRID,         ///< Geometric 2x2 grid algorithm

   164

	TL_3X3_GRID,         ///< Geometric 3x3 grid algorithm

   165

   166

	NUM_TLS,             ///< Number of town layouts

   167

};

   168

   169

/* It needs to be 8bits, because we save and load it as such */

   170

/** Define basic enum properties */

   171

template <> struct EnumPropsT<TownLayout> : MakeEnumPropsT<TownLayout, byte, TL_NO_ROADS, NUM_TLS, NUM_TLS> {};

   172

typedef TinyEnumT<TownLayout> TownLayoutByte; //typedefing-enumification of TownLayout

   173

   174

#define GAME_DIFFICULTY_NUM 18

   175

   176

/** Specific type for Game Difficulty to ease changing the type */

   177

typedef uint16 GDType;

   178

struct GameDifficulty {

   179

	GDType max_no_competitors;

   180

	GDType competitor_start_time;

   181

	GDType number_towns;

   182

	GDType number_industries;

   183

	GDType max_loan;

   184

	GDType initial_interest;

   185

	GDType vehicle_costs;

   186

	GDType competitor_speed;

   187

	GDType competitor_intelligence; // no longer in use

   188

	GDType vehicle_breakdowns;

   189

	GDType subsidy_multiplier;

   190

	GDType construction_cost;

   191

	GDType terrain_type;

   192

	GDType quantity_sea_lakes;

   193

	GDType economy;

   194

	GDType line_reverse_mode;

   195

	GDType disasters;

   196

	GDType town_council_tolerance; // minimum required town ratings to be allowed to demolish stuff

   197

};

   198

   199

struct ViewportSign {

   200

	int32 left;

   201

	int32 top;

   202

	byte width_1, width_2;

   203

};

   204

   205

enum {

   206

	SORT_ASCENDING  = 0,

   207

	SORT_DESCENDING = 1,

   208

	SORT_BY_DATE    = 0,

   209

	SORT_BY_NAME    = 2

   210

};

   211

   212

VARDEF byte _savegame_sort_order;

   213

   214

enum {

   215

	MAX_SCREEN_WIDTH  = 2048,

   216

	MAX_SCREEN_HEIGHT = 1200,

   217

};

   218

   219

/* In certain windows you navigate with the arrow keys. Do not scroll the

   220

 * gameview when here. Bitencoded variable that only allows scrolling if all

   221

 * elements are zero */

   222

enum {

   223

	SCROLL_CON  = 0,

   224

	SCROLL_EDIT = 1,

   225

	SCROLL_SAVE = 2,

   226

	SCROLL_CHAT = 4,

   227

};

   228

VARDEF byte _no_scroll;

   229

   230

/** To have a concurrently running thread interface with the main program, use

   231

 * the OTTD_SendThreadMessage() function. Actions to perform upon the message are handled

   232

 * in the ProcessSentMessage() function */

   233

enum ThreadMsg {

   234

	MSG_OTTD_NO_MESSAGE,

   235

	MSG_OTTD_SAVETHREAD_DONE,

   236

	MSG_OTTD_SAVETHREAD_ERROR,

   237

};

   238

   239

void OTTD_SendThreadMessage(ThreadMsg msg);

   240

   241

extern byte _game_mode;

   242

extern bool _exit_game;

   243

extern byte _pause_game;

   244

   245

#endif /* OPENTTD_H */