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 auto_pbs_placement;// automatic pbs signal placement

    91

	bool mammoth_trains;		// allow very long trains

    92

	bool join_stations;			// allow joining of train stations

    93

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

    94

	bool improved_load;			// improved loading algorithm

    95

	byte station_spread;		// amount a station may spread

    96

	bool inflation;					// disable inflation

    97

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

    98

	bool longbridges;				// allow 100 tile long bridges

    99

	bool gotodepot;					// allow goto depot in orders

   100

	bool build_rawmaterial_ind;	 // allow building raw material industries

   101

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

   102

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

   103

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

   104

	uint8 order_review_system;

   105

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

   106

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

   107

	bool signal_side;				// show signals on right side

   108

	bool show_finances;			// show finances at end of year

   109

	bool new_nonstop;				// ttdpatch compatible nonstop handling

   110

	bool roadveh_queue;			// buggy road vehicle queueing

   111

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

   112

	byte errmsg_duration;		// duration of error message

   113

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

   114

	bool bribe;							// enable bribing the local authority

   115

	bool nonuniform_stations;// allow nonuniform train stations

   116

	bool always_small_airport; // always allow small airports

   117

	bool realistic_acceleration; // realistic acceleration for trains

   118

	bool wagon_speed_limits; // enable wagon speed limits

   119

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

   120

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

   121

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

   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

	bool extra_dynamite;			// extra dynamite

   159

   160

	bool never_expire_vehicles; // never expire vehicles

   161

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

   162

   163

	bool auto_euro;						// automatically switch to euro in 2002

   164

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

   165

	bool smooth_economy;		// smooth economy

   166

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

   167

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

   168

   169

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

   170

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

   171

   172

	uint map_x; // Size of map

   173

	uint map_y;

   174

   175

	byte drag_signals_density; // many signals density

   176

	bool ainew_active;  // Is the new AI active?

   177

   178

	/*

   179

	 * New Path Finding

   180

	 */

   181

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

   182

   183

	/**

   184

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

   185

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

   186

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

   187

	 * sophisticated way sometime soon

   188

	 */

   189

	uint32 npf_max_search_nodes;

   190

   191

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

   192

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

   193

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

   194

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

   195

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

   196

	uint32 npf_rail_curve_penalty; /* The penalty for curves */

   197

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

   198

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

   199

	uint32 npf_water_curve_penalty; /* The penalty for curves */

   200

	uint32 npf_road_curve_penalty; /* The penalty for curves */

   201

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

   202

   203

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

   204

} Patches;

   205

   206

VARDEF Patches _patches;

   207

   208

   209

typedef struct Cheat {

   210

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

   211

	byte value;			// active?

   212

} Cheat;

   213

   214

   215

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

   216

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

   217

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

   218

   219

typedef struct Cheats {

   220

	Cheat magic_bulldozer;		// dynamite industries, unmovables

   221

	Cheat switch_player;			// change to another player

   222

	Cheat money;							// get rich

   223

	Cheat crossing_tunnels;		// allow tunnels that cross each other

   224

	Cheat build_in_pause;			// build while in pause mode

   225

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

   226

	Cheat switch_climate;

   227

	Cheat change_date;				//changes date ingame

   228

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

   229

} Cheats;

   230

   231

VARDEF Cheats _cheats;

   232

   233

typedef struct Paths {

   234

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

   235

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

   236

	char *data_dir;

   237

	char *gm_dir;

   238

	char *lang_dir;

   239

	char *save_dir;

   240

	char *autosave_dir;

   241

	char *scenario_dir;

   242

	char *second_data_dir;

   243

} Paths;

   244

   245

VARDEF Paths _path;

   246

   247

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

   248

VARDEF int _timer_counter;

   249

   250

   251

// NOSAVE: can be determined from _date

   252

VARDEF byte _cur_year;

   253

VARDEF byte _cur_month;

   254

   255

VARDEF uint32 _frame_counter;

   256

   257

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

   258

   259

VARDEF bool _do_autosave;

   260

VARDEF int _autosave_ctr;

   261

   262

VARDEF byte _display_opt;

   263

VARDEF byte _pause;

   264

VARDEF int _caret_timer;

   265

VARDEF uint32 _news_display_opt;

   266

VARDEF bool _news_ticker_sound;

   267

VARDEF byte _game_mode;

   268

   269

VARDEF StringID _error_message;

   270

VARDEF StringID _error_message_2;

   271

VARDEF int32 _additional_cash_required;

   272

   273

VARDEF uint32 _decode_parameters[20];

   274

   275

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

   276

VARDEF bool _ctrl_pressed;  // Is Ctrl pressed?

   277

VARDEF bool _shift_pressed;  // Is Alt pressed?

   278

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

   279

   280

VARDEF bool _fullscreen;

   281

VARDEF bool _double_size;

   282

VARDEF uint _display_hz;

   283

VARDEF bool _force_full_redraw;

   284

VARDEF uint _fullscreen_bpp;

   285

VARDEF bool _fast_forward;

   286

VARDEF bool _rightclick_emulate;

   287

   288

// IN/OUT parameters to commands

   289

VARDEF byte _yearly_expenses_type;

   290

VARDEF TileIndex _terraform_err_tile;

   291

VARDEF TileIndex _build_tunnel_endtile;

   292

VARDEF bool _generating_world;

   293

VARDEF int _new_town_size;

   294

VARDEF uint _returned_refit_amount;

   295

   296

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

   297

typedef struct {

   298

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

   299

	char name[MAX_PATH];  // name

   300

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

   301

} SmallFiosItem;

   302

   303

// Used when switching from the intro menu.

   304

VARDEF byte _switch_mode;

   305

VARDEF StringID _switch_mode_errorstr;

   306

VARDEF bool _exit_game;

   307

VARDEF SmallFiosItem _file_to_saveload;

   308

VARDEF byte _make_screenshot;

   309

   310

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

   311

   312

VARDEF char *_newgrf_files[32];

   313

   314

   315

VARDEF Vehicle *_place_clicked_vehicle;

   316

   317

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

   318

   319

// debug features

   320

VARDEF char _savedump_path[64];

   321

VARDEF uint _savedump_first, _savedump_freq, _savedump_last;

   322

// end of debug features

   323

   324

// Used for dynamic language support

   325

typedef struct {

   326

	int num; // number of languages

   327

	int curr; // currently selected language index

   328

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

   329

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

   330

	struct {

   331

		char *name;

   332

		char *file;

   333

	} ent[32];

   334

} DynamicLanguages;

   335

   336

VARDEF DynamicLanguages _dynlang;

   337

   338

VARDEF int _num_resolutions;

   339

VARDEF uint16 _resolutions[32][2];

   340

VARDEF uint16 _cur_resolution[2];

   341

   342

VARDEF char _savegame_format[8];

   343

   344

VARDEF char *_config_file;

   345

VARDEF char *_highscore_file;

   346

VARDEF char *_log_file;

   347

   348

// NOSAVE: These can be recalculated from InitializeLandscapeVariables

   349

typedef struct {

   350

	StringID names_s[NUM_CARGO];

   351

	StringID names_long[NUM_CARGO];

   352

	StringID names_short[NUM_CARGO];

   353

	byte weights[NUM_CARGO];

   354

	SpriteID sprites[NUM_CARGO];

   355

	byte transit_days_1[NUM_CARGO];

   356

	byte transit_days_2[NUM_CARGO];

   357

	byte ai_railwagon[3][NUM_CARGO];

   358

	byte ai_roadveh_start[NUM_CARGO];

   359

	byte ai_roadveh_count[NUM_CARGO];

   360

} CargoConst;

   361

   362

VARDEF CargoConst _cargoc;

   363

   364

   365

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

   366

{

   367

	s[n] = v;

   368

}

   369

   370

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

   371

{

   372

	return s[n];

   373

}

   374

   375

static inline void SetDParam(uint n, uint32 v)

   376

{

   377

	assert(n < lengthof(_decode_parameters));

   378

	_decode_parameters[n] = v;

   379

}

   380

   381

static inline void SetDParam64(uint n, uint64 v)

   382

{

   383

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

   384

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

   385

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

   386

}

   387

   388

static inline uint32 GetDParam(uint n)

   389

{

   390

	assert(n < lengthof(_decode_parameters));

   391

	return _decode_parameters[n];

   392

}

   393

   394

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

   395

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

   396

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

   397

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

   398

   399

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

   400

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

   401

// so be careful.

   402

StringID BindCString(const char *str);

   403

   404

   405

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

   406

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

   407

   408

   409

#define SET_EXPENSES_TYPE(x) _yearly_expenses_type = x;

   410

   411

/* landscape.c */

   412

extern const byte _tileh_to_sprite[32];

   413

extern const byte _inclined_tileh[8];

   414

   415

extern const TileTypeProcs * const _tile_type_procs[16];

   416

   417

/* station_cmd.c */

   418

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

   419

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

   420

extern const byte _airport_size_x[];

   421

extern const byte _airport_size_y[];

   422

   423

/* misc */

   424

VARDEF char _screenshot_name[128];

   425

VARDEF byte _vehicle_design_names;

   426

   427

/* tunnelbridge */

   428

#define MAX_BRIDGES 13

   429

   430

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

   431

 * to include npf.h */

   432

#define NPF_TILE_LENGTH 100

   433

   434

/* Forking stuff */

   435

VARDEF bool _dedicated_forks;

   436

   437

#endif /* VARIABLES_H */