1

/* $Id$ */

     2

     3

#ifndef VARIABLES_H

     4

#define VARIABLES_H

     5

     6

// ********* START OF SAVE REGION

     7

#if !defined(MAX_PATH)

     8

# define MAX_PATH 260

     9

#endif

    10

    11

// Prices and also the fractional part.

    12

VARDEF Prices _price;

    13

VARDEF uint16 _price_frac[NUM_PRICES];

    14

    15

VARDEF uint32 _cargo_payment_rates[NUM_CARGO];

    16

VARDEF uint16 _cargo_payment_rates_frac[NUM_CARGO];

    17

    18

typedef struct {

    19

	GameDifficulty diff;

    20

	byte diff_level;

    21

	byte currency;

    22

	bool kilometers;

    23

	byte town_name;

    24

	byte landscape;

    25

	byte snow_line;

    26

	byte autosave;

    27

	byte road_side;

    28

} GameOptions;

    29

    30

/* These are the options for the current game

    31

 * either ingame, or loaded. Also used for networking games */

    32

VARDEF GameOptions _opt;

    33

    34

/* These are the default options for a new game */

    35

VARDEF GameOptions _opt_newgame;

    36

    37

// Pointer to one of the two _opt OR _opt_newgame structs

    38

VARDEF GameOptions *_opt_ptr;

    39

    40

// Current date

    41

VARDEF uint16 _date;

    42

VARDEF uint16 _date_fract;

    43

    44

// Amount of game ticks

    45

VARDEF uint16 _tick_counter;

    46

    47

// This one is not used anymore.

    48

VARDEF VehicleID _vehicle_id_ctr_day;

    49

    50

// Skip aging of cargo?

    51

VARDEF byte _age_cargo_skip_counter;

    52

    53

// Available aircraft types

    54

VARDEF byte _avail_aircraft;

    55

    56

// Position in tile loop

    57

VARDEF TileIndex _cur_tileloop_tile;

    58

    59

// Also save scrollpos_x, scrollpos_y and zoom

    60

VARDEF uint16 _disaster_delay;

    61

    62

// Determines what station to operate on in the

    63

//  tick handler.

    64

VARDEF uint16 _station_tick_ctr;

    65

    66

VARDEF uint32 _random_seeds[2][2];

    67

    68

// Iterator through all towns in OnTick_Town

    69

VARDEF uint32 _cur_town_ctr;

    70

// Frequency iterator at the same place

    71

VARDEF uint32 _cur_town_iter;

    72

    73

VARDEF uint _cur_player_tick_index;

    74

VARDEF uint _next_competitor_start;

    75

    76

// Determines how often to run the tree loop

    77

VARDEF byte _trees_tick_ctr;

    78

    79

// Keep track of current game position

    80

VARDEF int _saved_scrollpos_x;

    81

VARDEF int _saved_scrollpos_y;

    82

VARDEF byte _saved_scrollpos_zoom;

    83

    84

// ********* END OF SAVE REGION

    85

    86

typedef struct Patches {

    87

	bool modified_catchment;	//different-size catchment areas

    88

	bool vehicle_speed;			// show vehicle speed

    89

	bool build_on_slopes;		// allow building on slopes

    90

	bool mammoth_trains;		// allow very long trains

    91

	bool join_stations;			// allow joining of train stations

    92

	bool full_load_any;			// new full load calculation, any cargo must be full

    93

	bool improved_load;			// improved loading algorithm

    94

	byte station_spread;		// amount a station may spread

    95

	bool inflation;					// disable inflation

    96

	bool selectgoods;       // only send the goods to station if a train has been there

    97

	bool longbridges;				// allow 100 tile long bridges

    98

	bool gotodepot;					// allow goto depot in orders

    99

	bool build_rawmaterial_ind;	 // allow building raw material industries

   100

	bool multiple_industry_per_town;	// allow many industries of the same type per town

   101

	bool same_industry_close;	// allow same type industries to be built close to each other

   102

	uint16 lost_train_days;	// if a train doesn't switch order in this amount of days, a train is lost warning is shown

   103

	uint8 order_review_system;

   104

	bool train_income_warn; // if train is generating little income, show a warning

   105

	bool status_long_date;		// always show long date in status bar

   106

	bool signal_side;				// show signals on right side

   107

	bool show_finances;			// show finances at end of year

   108

	bool new_nonstop;				// ttdpatch compatible nonstop handling

   109

	bool roadveh_queue;			// buggy road vehicle queueing

   110

	bool autoscroll;				// scroll when moving mouse to the edge.

   111

	byte errmsg_duration;		// duration of error message

   112

	byte snow_line_height;	// a number 0-15 that configured snow line height

   113

	bool bribe;							// enable bribing the local authority

   114

	bool nonuniform_stations;// allow nonuniform train stations

   115

	bool always_small_airport; // always allow small airports

   116

	bool realistic_acceleration; // realistic acceleration for trains

   117

	bool wagon_speed_limits; // enable wagon speed limits

   118

	bool forbid_90_deg; // forbid trains to make 90 deg turns

   119

	bool invisible_trees; // don't show trees when buildings are transparent

   120

	bool no_servicing_if_no_breakdowns; // dont send vehicles to depot when breakdowns are disabled

   121

	bool link_terraform_toolbar; // display terraform toolbar when displaying rail, road, water and airport toolbars

   122

	bool reverse_scroll; // Right-Click-Scrolling scrolls in the opposite direction

   123

   124

	uint8 toolbar_pos;			// position of toolbars, 0=left, 1=center, 2=right

   125

	uint8 window_snap_radius; // Windows snap at each other if closer than this

   126

   127

	UnitID max_trains;				//max trains in game per player (these are 16bit because the unitnumber field can't hold more)

   128

	UnitID max_roadveh;				//max trucks in game per player

   129

	UnitID max_aircraft;			//max planes in game per player

   130

	UnitID max_ships;					//max ships in game per player

   131

   132

	bool servint_ispercent;	// service intervals are in percents

   133

	uint16 servint_trains;	// service interval for trains

   134

	uint16 servint_roadveh;	// service interval for road vehicles

   135

	uint16 servint_aircraft;// service interval for aircraft

   136

	uint16 servint_ships;		// service interval for ships

   137

   138

	bool autorenew;

   139

	int16 autorenew_months;

   140

	int32 autorenew_money;

   141

   142

	byte pf_maxdepth;				// maximum recursion depth when searching for a train route for new pathfinder

   143

	uint16 pf_maxlength;		// maximum length when searching for a train route for new pathfinder

   144

   145

   146

	bool bridge_pillars;		// show bridge pillars for high bridges

   147

   148

	bool ai_disable_veh_train;		// disable types for AI

   149

	bool ai_disable_veh_roadveh;		// disable types for AI

   150

	bool ai_disable_veh_aircraft;		// disable types for AI

   151

	bool ai_disable_veh_ship;		// disable types for AI

   152

	uint32 starting_date;		// starting date

   153

	uint32 ending_date;		// end of the game (just show highscore)

   154

	uint32 colored_news_date; // when does newspaper become colored?

   155

   156

	bool keep_all_autosave;		// name the autosave in a different way.

   157

	bool autosave_on_exit;		// save an autosave when you quit the game, but do not ask "Do you really want to quit?"

   158

	byte max_num_autosaves;		// controls how many autosavegames are made before the game starts to overwrite (names them 0 to max_num_autosaves - 1)

   159

	bool extra_dynamite;			// extra dynamite

   160

   161

	bool never_expire_vehicles; // never expire vehicles

   162

	byte extend_vehicle_life;	// extend vehicle life by this many years

   163

   164

	bool auto_euro;						// automatically switch to euro in 2002

   165

	bool serviceathelipad;	// service helicopters at helipads automatically (no need to send to depot)

   166

	bool smooth_economy;		// smooth economy

   167

	bool allow_shares;			// allow the buying/selling of shares

   168

	byte dist_local_authority;		// distance for town local authority, default 20

   169

   170

	byte wait_oneway_signal;	//waitingtime in days before a oneway signal

   171

	byte wait_twoway_signal;	//waitingtime in days before a twoway signal

   172

   173

	uint map_x; // Size of map

   174

	uint map_y;

   175

   176

	byte drag_signals_density; // many signals density

   177

	bool ainew_active;  // Is the new AI active?

   178

	bool ai_in_multiplayer; // Do we allow AIs in multiplayer

   179

   180

	/*

   181

	 * New Path Finding

   182

	 */

   183

	bool new_pathfinding_all; /* Use the newest pathfinding algorithm for all */

   184

   185

	/**

   186

	 * The maximum amount of search nodes a single NPF run should take. This

   187

	 * limit should make sure performance stays at acceptable levels at the cost

   188

	 * of not being perfect anymore. This will probably be fixed in a more

   189

	 * sophisticated way sometime soon

   190

	 */

   191

	uint32 npf_max_search_nodes;

   192

   193

	uint32 npf_rail_firstred_penalty; /* The penalty for when the first signal is red (and it is not an exit or combo signal) */

   194

	uint32 npf_rail_firstred_exit_penalty; /* The penalty for when the first signal is red (and it is an exit or combo signal) */

   195

	uint32 npf_rail_lastred_penalty; /* The penalty for when the last signal is red */

   196

	uint32 npf_rail_station_penalty; /* The penalty for station tiles */

   197

	uint32 npf_rail_slope_penalty; /* The penalty for sloping upwards */

   198

	uint32 npf_rail_curve_penalty; /* The penalty for curves */

   199

	uint32 npf_rail_depot_reverse_penalty; /* The penalty for reversing in depots */

   200

	uint32 npf_buoy_penalty; /* The penalty for going over (through) a buoy */

   201

	uint32 npf_water_curve_penalty; /* The penalty for curves */

   202

	uint32 npf_road_curve_penalty; /* The penalty for curves */

   203

 	uint32 npf_crossing_penalty; /* The penalty for level crossings */

   204

   205

	bool population_in_label; // Show the population of a town in his label?

   206

} Patches;

   207

   208

VARDEF Patches _patches;

   209

   210

   211

typedef struct Cheat {

   212

	bool been_used;	// has this cheat been used before?

   213

	byte value;			// active?

   214

} Cheat;

   215

   216

   217

// WARNING! Do _not_ remove entries in Cheats struct or change the order

   218

// of the existing ones! Would break downward compatibility.

   219

// Only add new entries at the end of the struct!

   220

   221

typedef struct Cheats {

   222

	Cheat magic_bulldozer;		// dynamite industries, unmovables

   223

	Cheat switch_player;			// change to another player

   224

	Cheat money;							// get rich

   225

	Cheat crossing_tunnels;		// allow tunnels that cross each other

   226

	Cheat build_in_pause;			// build while in pause mode

   227

	Cheat no_jetcrash;				// no jet will crash on small airports anymore

   228

	Cheat switch_climate;

   229

	Cheat change_date;				//changes date ingame

   230

	Cheat setup_prod;				//setup raw-material production in game

   231

} Cheats;

   232

   233

VARDEF Cheats _cheats;

   234

   235

typedef struct Paths {

   236

	char *personal_dir;  // includes cfg file and save folder

   237

	char *game_data_dir; // includes data, gm, lang

   238

	char *data_dir;

   239

	char *gm_dir;

   240

	char *lang_dir;

   241

	char *save_dir;

   242

	char *autosave_dir;

   243

	char *scenario_dir;

   244

	char *second_data_dir;

   245

} Paths;

   246

   247

VARDEF Paths _path;

   248

   249

// NOSAVE: Used in palette animations only, not really important.

   250

VARDEF int _timer_counter;

   251

   252

   253

// NOSAVE: can be determined from _date

   254

VARDEF byte _cur_year;

   255

VARDEF byte _cur_month;

   256

   257

VARDEF uint32 _frame_counter;

   258

   259

VARDEF bool _is_old_ai_player; // current player is an oldAI player? (enables a lot of cheats..)

   260

   261

VARDEF bool _do_autosave;

   262

VARDEF int _autosave_ctr;

   263

   264

VARDEF byte _display_opt;

   265

VARDEF byte _pause;

   266

VARDEF int _caret_timer;

   267

VARDEF uint32 _news_display_opt;

   268

VARDEF bool _news_ticker_sound;

   269

VARDEF byte _game_mode;

   270

   271

VARDEF StringID _error_message;

   272

VARDEF StringID _error_message_2;

   273

VARDEF int32 _additional_cash_required;

   274

   275

VARDEF uint32 _decode_parameters[20];

   276

   277

VARDEF uint32 _pressed_key; // Low 8 bits = ASCII, High 16 bits = keycode

   278

VARDEF bool _ctrl_pressed;  // Is Ctrl pressed?

   279

VARDEF bool _shift_pressed;  // Is Alt pressed?

   280

VARDEF byte _dirkeys;				// 1=left, 2=up, 4=right, 8=down

   281

   282

VARDEF bool _fullscreen;

   283

VARDEF bool _double_size;

   284

VARDEF uint _display_hz;

   285

VARDEF bool _force_full_redraw;

   286

VARDEF uint _fullscreen_bpp;

   287

VARDEF bool _fast_forward;

   288

VARDEF bool _rightclick_emulate;

   289

   290

// IN/OUT parameters to commands

   291

VARDEF byte _yearly_expenses_type;

   292

VARDEF TileIndex _terraform_err_tile;

   293

VARDEF TileIndex _build_tunnel_endtile;

   294

VARDEF bool _generating_world;

   295

VARDEF int _new_town_size;

   296

VARDEF uint _returned_refit_amount;

   297

   298

// Deals with the type of the savegame, independent of extension

   299

typedef struct {

   300

	int mode;             // savegame/scenario type (old, new)

   301

	char name[MAX_PATH];  // name

   302

	char title[255];      // internal name of the game

   303

} SmallFiosItem;

   304

   305

// Used when switching from the intro menu.

   306

VARDEF byte _switch_mode;

   307

VARDEF StringID _switch_mode_errorstr;

   308

VARDEF bool _exit_game;

   309

VARDEF SmallFiosItem _file_to_saveload;

   310

VARDEF byte _make_screenshot;

   311

   312

VARDEF byte _get_z_hint; // used as a hint to getslopez to return the right height at a bridge.

   313

   314

VARDEF char *_newgrf_files[32];

   315

   316

   317

VARDEF Vehicle *_place_clicked_vehicle;

   318

   319

VARDEF char _ini_videodriver[16], _ini_musicdriver[16], _ini_sounddriver[16];

   320

   321

// debug features

   322

VARDEF char _savedump_path[64];

   323

VARDEF uint _savedump_first, _savedump_freq, _savedump_last;

   324

// end of debug features

   325

   326

// Used for dynamic language support

   327

typedef struct {

   328

	int num; // number of languages

   329

	int curr; // currently selected language index

   330

	char curr_file[32]; // currently selected language file

   331

	StringID dropdown[32 + 1]; // used in settings dialog

   332

	struct {

   333

		char *name;

   334

		char *file;

   335

	} ent[32];

   336

} DynamicLanguages;

   337

   338

VARDEF DynamicLanguages _dynlang;

   339

   340

VARDEF int _num_resolutions;

   341

VARDEF uint16 _resolutions[32][2];

   342

VARDEF uint16 _cur_resolution[2];

   343

   344

VARDEF char _savegame_format[8];

   345

   346

VARDEF char *_config_file;

   347

VARDEF char *_highscore_file;

   348

VARDEF char *_log_file;

   349

   350

// NOSAVE: These can be recalculated from InitializeLandscapeVariables

   351

typedef struct {

   352

	StringID names_s[NUM_CARGO];

   353

	StringID names_long[NUM_CARGO];

   354

	StringID names_short[NUM_CARGO];

   355

	byte weights[NUM_CARGO];

   356

	SpriteID sprites[NUM_CARGO];

   357

	byte transit_days_1[NUM_CARGO];

   358

	byte transit_days_2[NUM_CARGO];

   359

	byte ai_railwagon[3][NUM_CARGO];

   360

	byte ai_roadveh_start[NUM_CARGO];

   361

	byte ai_roadveh_count[NUM_CARGO];

   362

} CargoConst;

   363

   364

VARDEF CargoConst _cargoc;

   365

   366

   367

static inline void SetDParamX(uint32 *s, uint n, uint32 v)

   368

{

   369

	s[n] = v;

   370

}

   371

   372

static inline uint32 GetDParamX(const uint32 *s, uint n)

   373

{

   374

	return s[n];

   375

}

   376

   377

static inline void SetDParam(uint n, uint32 v)

   378

{

   379

	assert(n < lengthof(_decode_parameters));

   380

	_decode_parameters[n] = v;

   381

}

   382

   383

static inline void SetDParam64(uint n, uint64 v)

   384

{

   385

	assert(n + 1 < lengthof(_decode_parameters));

   386

	_decode_parameters[n + 0] = v & 0xffffffff;

   387

	_decode_parameters[n + 1] = v >> 32;

   388

}

   389

   390

static inline uint32 GetDParam(uint n)

   391

{

   392

	assert(n < lengthof(_decode_parameters));

   393

	return _decode_parameters[n];

   394

}

   395

   396

// Used to bind a C string name to a dparam number.

   397

// NOTE: This has a short lifetime. You can't

   398

//       use this string much later or it will be gone.

   399

void SetDParamStr(uint n, const char *str);

   400

   401

// This function takes a C-string and allocates a temporary string ID.

   402

// The duration of the bound string is valid only until the next acll to GetString,

   403

// so be careful.

   404

StringID BindCString(const char *str);

   405

   406

   407

#define COPY_IN_DPARAM(offs,src,num) memcpy(_decode_parameters + offs, src, sizeof(uint32) * (num))

   408

#define COPY_OUT_DPARAM(dst,offs,num) memcpy(dst,_decode_parameters + offs, sizeof(uint32) * (num))

   409

   410

   411

#define SET_EXPENSES_TYPE(x) _yearly_expenses_type = x;

   412

   413

/* landscape.c */

   414

extern const byte _tileh_to_sprite[32];

   415

extern const byte _inclined_tileh[8];

   416

   417

extern const TileTypeProcs * const _tile_type_procs[16];

   418

   419

/* station_cmd.c */

   420

// there are 5 types of airport (Country (3x4) , City(6x6), Metropolitan(6x6), International(7x7), Heliport(1x1)

   421

// will become obsolete once airports are loaded from seperate file

   422

extern const byte _airport_size_x[];

   423

extern const byte _airport_size_y[];

   424

   425

/* misc */

   426

VARDEF char _screenshot_name[128];

   427

VARDEF byte _vehicle_design_names;

   428

   429

/* tunnelbridge */

   430

#define MAX_BRIDGES 13

   431

   432

/* For new pathfinding. Define here so it is globally available without having

   433

 * to include npf.h */

   434

#define NPF_TILE_LENGTH 100

   435

   436

/* Forking stuff */

   437

VARDEF bool _dedicated_forks;

   438

   439

#endif /* VARIABLES_H */