tron@2186: /* $Id$ */
celestar@2536: /** @file openttd.h */
tron@2186: 
Darkvater@2075: #ifndef OPENTTD_H
Darkvater@2075: #define OPENTTD_H
truelight@0: 
truelight@0: #ifndef VARDEF
truelight@0: #define VARDEF extern
truelight@0: #endif
truelight@0: 
truelight@0: // Forward declarations of structs.
truelight@4401: typedef byte LandscapeID;
truelight@4401: typedef uint16 UnitID;
rubidium@7446: 
rubidium@8617: enum GameModes {
rubidium@8617: 	GM_MENU,
rubidium@8617: 	GM_NORMAL,
rubidium@8617: 	GM_EDITOR
rubidium@8617: };
rubidium@8617: 
truelight@0: enum SwitchModes {
rubidium@4344: 	SM_NONE            =  0,
rubidium@4344: 	SM_NEWGAME         =  1,
rubidium@4344: 	SM_EDITOR          =  2,
rubidium@4344: 	SM_LOAD            =  3,
rubidium@4344: 	SM_MENU            =  4,
rubidium@4344: 	SM_SAVE            =  5,
rubidium@4344: 	SM_GENRANDLAND     =  6,
rubidium@4344: 	SM_LOAD_SCENARIO   =  9,
rubidium@4344: 	SM_START_SCENARIO  = 10,
truelight@4300: 	SM_START_HEIGHTMAP = 11,
rubidium@4344: 	SM_LOAD_HEIGHTMAP  = 12,
truelight@0: };
truelight@0: 
truelight@2828: 
truelight@2828: /* Modes for GenerateWorld */
truelight@2828: enum GenerateWorldModes {
truelight@4300: 	GW_NEWGAME   = 0,    /* Generate a map for a new game */
truelight@4300: 	GW_EMPTY     = 1,    /* Generate an empty map (sea-level) */
truelight@4300: 	GW_RANDOM    = 2,    /* Generate a random map for SE */
truelight@4300: 	GW_HEIGHTMAP = 3,    /* Generate a newgame from a heightmap */
truelight@2828: };
truelight@2828: 
truelight@2828: /* Modes for InitializeGame, those are _bits_! */
truelight@2828: enum InitializeGameModes {
truelight@2828: 	IG_NONE       = 0,  /* Don't do anything special */
truelight@2828: 	IG_DATE_RESET = 1,  /* Reset the date when initializing a game */
truelight@2828: };
truelight@2828: 
rubidium@6574: enum TransportType {
truelight@159: 	/* These constants are for now linked to the representation of bridges
tron@3333: 	 * and tunnels, so they can be used by GetTileTrackStatus_TunnelBridge.
tron@3333: 	 * In an ideal world, these constants would be used everywhere when
tron@3333: 	 * accessing tunnels and bridges. For now, you should just not change
tron@3333: 	 * the values for road and rail.
truelight@159: 	 */
rubidium@5838: 	TRANSPORT_BEGIN = 0,
tron@3017: 	TRANSPORT_RAIL = 0,
truelight@159: 	TRANSPORT_ROAD = 1,
rubidium@4434: 	TRANSPORT_WATER, // = 2
matthijs@1967: 	TRANSPORT_END,
matthijs@1967: 	INVALID_TRANSPORT = 0xff,
rubidium@6574: };
truelight@159: 
truelight@0: /* Display Options */
truelight@0: enum {
peter1138@7087: 	DO_SHOW_TOWN_NAMES    = 0,
peter1138@7087: 	DO_SHOW_STATION_NAMES = 1,
peter1138@7087: 	DO_SHOW_SIGNS         = 2,
peter1138@7087: 	DO_FULL_ANIMATION     = 3,
peter1138@7087: 	DO_FULL_DETAIL        = 5,
peter1138@7087: 	DO_WAYPOINTS          = 6,
peter1138@6923: };
peter1138@6923: 
truelight@0: /* Landscape types */
truelight@0: enum {
belugas@6683: 	LT_TEMPERATE  = 0,
belugas@6683: 	LT_ARCTIC     = 1,
belugas@6683: 	LT_TROPIC     = 2,
belugas@6683: 	LT_TOYLAND    = 3,
truelight@0: 
truelight@0: 	NUM_LANDSCAPE = 4,
truelight@0: };
truelight@0: 
rubidium@6574: struct ViewportSign {
tron@849: 	int32 left;
tron@849: 	int32 top;
truelight@0: 	byte width_1, width_2;
rubidium@6574: };
truelight@0: 
tron@2526: enum {
tron@2526: 	SORT_ASCENDING  = 0,
tron@2526: 	SORT_DESCENDING = 1,
tron@2526: 	SORT_BY_DATE    = 0,
tron@2526: 	SORT_BY_NAME    = 2
tron@2526: };
tron@2526: 
rubidium@8764: extern byte _savegame_sort_order;
truelight@0: 
truelight@0: enum {
rubidium@4344: 	MAX_SCREEN_WIDTH  = 2048,
truelight@0: 	MAX_SCREEN_HEIGHT = 1200,
truelight@0: };
truelight@0: 
Darkvater@1397: /* In certain windows you navigate with the arrow keys. Do not scroll the
Darkvater@1397:  * gameview when here. Bitencoded variable that only allows scrolling if all
Darkvater@1397:  * elements are zero */
Darkvater@1397: enum {
rubidium@4344: 	SCROLL_CON  = 0,
Darkvater@1397: 	SCROLL_EDIT = 1,
Darkvater@1397: 	SCROLL_SAVE = 2,
Darkvater@1843: 	SCROLL_CHAT = 4,
Darkvater@1397: };
rubidium@8764: extern byte _no_scroll;
Darkvater@1397: 
Darkvater@2380: /** To have a concurrently running thread interface with the main program, use
Darkvater@2380:  * the OTTD_SendThreadMessage() function. Actions to perform upon the message are handled
Darkvater@2380:  * in the ProcessSentMessage() function */
rubidium@6574: enum ThreadMsg {
truelight@4323: 	MSG_OTTD_NO_MESSAGE,
truelight@4323: 	MSG_OTTD_SAVETHREAD_DONE,
truelight@4323: 	MSG_OTTD_SAVETHREAD_ERROR,
rubidium@6574: };
Darkvater@2380: 
Darkvater@2380: void OTTD_SendThreadMessage(ThreadMsg msg);
Darkvater@2380: 
rubidium@8617: extern byte _game_mode;
rubidium@8617: extern bool _exit_game;
peter1138@9166: extern int8 _pause_game;
rubidium@8617: 
Darkvater@2075: #endif /* OPENTTD_H */