1

/* $Id$ */

     2

     3

#ifndef VARIABLES_H

     4

#define VARIABLES_H

     5

     6

#include "yapf/yapf_settings.h"

     7

     8

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

     9

#if !defined(MAX_PATH)

    10

# define MAX_PATH 260

    11

#endif

    12

    13

// Prices and also the fractional part.

    14

VARDEF Prices _price;

    15

VARDEF uint16 _price_frac[NUM_PRICES];

    16

    17

VARDEF uint32 _cargo_payment_rates[NUM_CARGO];

    18

VARDEF uint16 _cargo_payment_rates_frac[NUM_CARGO];

    19

    20

typedef struct {

    21

	GameDifficulty diff;

    22

	byte diff_level;

    23

	byte currency;

    24

	byte units;

    25

	byte town_name;

    26

	byte landscape;

    27

	byte snow_line;

    28

	byte autosave;

    29

	byte road_side;

    30

} GameOptions;

    31

    32

/* These are the options for the current game

    33

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

    34

VARDEF GameOptions _opt;

    35

    36

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

    37

VARDEF GameOptions _opt_newgame;

    38

    39

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

    40

VARDEF GameOptions *_opt_ptr;

    41

    42

// Current date

    43

VARDEF uint16 _date;

    44

VARDEF uint16 _date_fract;

    45

    46

// Amount of game ticks

    47

VARDEF uint16 _tick_counter;

    48

    49

// This one is not used anymore.

    50

VARDEF VehicleID _vehicle_id_ctr_day;

    51

    52

// Skip aging of cargo?

    53

VARDEF byte _age_cargo_skip_counter;

    54

    55

// Available aircraft types

    56

VARDEF byte _avail_aircraft;

    57

    58

// Position in tile loop

    59

VARDEF TileIndex _cur_tileloop_tile;

    60

    61

// Also save scrollpos_x, scrollpos_y and zoom

    62

VARDEF uint16 _disaster_delay;

    63

    64

// Determines what station to operate on in the

    65

//  tick handler.

    66

VARDEF uint16 _station_tick_ctr;

    67

    68

VARDEF uint32 _random_seeds[2][2];

    69

    70

// Iterator through all towns in OnTick_Town

    71

VARDEF uint32 _cur_town_ctr;

    72

// Frequency iterator at the same place

    73

VARDEF uint32 _cur_town_iter;

    74

    75

VARDEF uint _cur_player_tick_index;

    76

VARDEF uint _next_competitor_start;

    77

    78

// Determines how often to run the tree loop

    79

VARDEF byte _trees_tick_ctr;

    80

    81

// Keep track of current game position

    82

VARDEF int _saved_scrollpos_x;

    83

VARDEF int _saved_scrollpos_y;

    84

VARDEF byte _saved_scrollpos_zoom;

    85

    86

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

    87

    88

typedef struct Patches {

    89

	bool modified_catchment;	//different-size catchment areas

    90

	bool vehicle_speed;			// show vehicle speed

    91

	bool build_on_slopes;		// allow building on slopes

    92

	bool mammoth_trains;		// allow very long trains

    93

	bool join_stations;			// allow joining of train stations

    94

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

    95

	bool improved_load;			// improved loading algorithm

    96

	byte station_spread;		// amount a station may spread

    97

	bool inflation;					// disable inflation

    98

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

    99

	bool longbridges;				// allow 100 tile long bridges

   100

	bool gotodepot;					// allow goto depot in orders

   101

	bool build_rawmaterial_ind;	 // allow building raw material industries

   102

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

   103

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

   104

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

   105

	uint8 order_review_system;

   106

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

   107

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

   108

	bool signal_side;				// show signals on right side

   109

	bool show_finances;			// show finances at end of year

   110

	bool new_nonstop;				// ttdpatch compatible nonstop handling

   111

	bool roadveh_queue;			// buggy road vehicle queueing

   112

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

   113

	byte errmsg_duration;		// duration of error message

   114

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

   115

	bool bribe;							// enable bribing the local authority

   116

	bool nonuniform_stations;// allow nonuniform train stations

   117

	bool always_small_airport; // always allow small airports

   118

	bool realistic_acceleration; // realistic acceleration for trains

   119

	bool wagon_speed_limits; // enable wagon speed limits

   120

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

   121

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

   122

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

   123

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

   124

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

   125

   126

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

   127

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

   128

   129

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

   130

	UnitID max_roadveh;				//max trucks in game per player

   131

	UnitID max_aircraft;			//max planes in game per player

   132

	UnitID max_ships;					//max ships in game per player

   133

   134

	bool servint_ispercent;	// service intervals are in percents

   135

	uint16 servint_trains;	// service interval for trains

   136

	uint16 servint_roadveh;	// service interval for road vehicles

   137

	uint16 servint_aircraft;// service interval for aircraft

   138

	uint16 servint_ships;		// service interval for ships

   139

   140

	bool autorenew;

   141

	int16 autorenew_months;

   142

	int32 autorenew_money;

   143

   144

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

   145

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

   146

   147

   148

	bool bridge_pillars;		// show bridge pillars for high bridges

   149

   150

	bool ai_disable_veh_train;		// disable types for AI

   151

	bool ai_disable_veh_roadveh;		// disable types for AI

   152

	bool ai_disable_veh_aircraft;		// disable types for AI

   153

	bool ai_disable_veh_ship;		// disable types for AI

   154

	uint32 starting_date;		// starting date

   155

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

   156

	uint32 colored_news_date; // when does newspaper become colored?

   157

   158

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

   159

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

   160

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

   161

	bool extra_dynamite;			// extra dynamite

   162

   163

	bool never_expire_vehicles; // never expire vehicles

   164

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

   165

   166

	bool auto_euro;						// automatically switch to euro in 2002

   167

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

   168

	bool smooth_economy;		// smooth economy

   169

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

   170

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

   171

   172

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

   173

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

   174

   175

	uint8 map_x; // Size of map

   176

	uint8 map_y;

   177

   178

	byte drag_signals_density; // many signals density

   179

	bool ainew_active;  // Is the new AI active?

   180

	bool ai_in_multiplayer; // Do we allow AIs in multiplayer

   181

   182

	/*

   183

	 * New Path Finding

   184

	 */

   185

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

   186

   187

	/**

   188

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

   189

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

   190

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

   191

	 * sophisticated way sometime soon

   192

	 */

   193

	uint32 npf_max_search_nodes;

   194

   195

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

   196

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

   197

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

   198

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

   199

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

   200

	uint32 npf_rail_curve_penalty; /* The penalty for curves */

   201

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

   202

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

   203

	uint32 npf_water_curve_penalty; /* The penalty for curves */

   204

	uint32 npf_road_curve_penalty; /* The penalty for curves */

   205

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

   206

   207

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

   208

   209

	/** YAPF settings */

   210

	YapfSettings  yapf;

   211

   212

} Patches;

   213

   214

VARDEF Patches _patches;

   215

   216

   217

typedef struct Cheat {

   218

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

   219

	byte value;			// active?

   220

} Cheat;

   221

   222

   223

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

   224

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

   225

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

   226

   227

typedef struct Cheats {

   228

	Cheat magic_bulldozer;		// dynamite industries, unmovables

   229

	Cheat switch_player;			// change to another player

   230

	Cheat money;							// get rich

   231

	Cheat crossing_tunnels;		// allow tunnels that cross each other

   232

	Cheat build_in_pause;			// build while in pause mode

   233

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

   234

	Cheat switch_climate;

   235

	Cheat change_date;				//changes date ingame

   236

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

   237

	Cheat elrail;                   //allow electric engines to be powered on conventional rail

   238

} Cheats;

   239

   240

VARDEF Cheats _cheats;

   241

   242

typedef struct Paths {

   243

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

   244

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

   245

	char *data_dir;

   246

	char *gm_dir;

   247

	char *lang_dir;

   248

	char *save_dir;

   249

	char *autosave_dir;

   250

	char *scenario_dir;

   251

	char *second_data_dir;

   252

} Paths;

   253

   254

VARDEF Paths _path;

   255

   256

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

   257

VARDEF int _timer_counter;

   258

   259

   260

// NOSAVE: can be determined from _date

   261

VARDEF byte _cur_year;

   262

VARDEF byte _cur_month;

   263

   264

VARDEF uint32 _frame_counter;

   265

   266

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

   267

   268

VARDEF bool _do_autosave;

   269

VARDEF int _autosave_ctr;

   270

   271

VARDEF byte _display_opt;

   272

VARDEF byte _pause;

   273

VARDEF int _caret_timer;

   274

VARDEF uint32 _news_display_opt;

   275

VARDEF bool _news_ticker_sound;

   276

VARDEF byte _game_mode;

   277

   278

VARDEF StringID _error_message;

   279

VARDEF int32 _additional_cash_required;

   280

   281

VARDEF uint32 _decode_parameters[20];

   282

   283

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

   284

VARDEF bool _ctrl_pressed;  // Is Ctrl pressed?

   285

VARDEF bool _shift_pressed;  // Is Alt pressed?

   286

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

   287

   288

VARDEF bool _fullscreen;

   289

VARDEF bool _fast_forward;

   290

VARDEF bool _rightclick_emulate;

   291

   292

// IN/OUT parameters to commands

   293

VARDEF byte _yearly_expenses_type;

   294

VARDEF TileIndex _terraform_err_tile;

   295

VARDEF TileIndex _build_tunnel_endtile;

   296

VARDEF bool _generating_world;

   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

   311

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

   312

   313

VARDEF char *_newgrf_files[32];

   314

   315

   316

VARDEF Vehicle *_place_clicked_vehicle;

   317

   318

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

   319

   320

// Used for dynamic language support

   321

typedef struct {

   322

	int num; // number of languages

   323

	int curr; // currently selected language index

   324

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

   325

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

   326

	struct {

   327

		char *name;

   328

		char *file;

   329

	} ent[32];

   330

} DynamicLanguages;

   331

   332

VARDEF DynamicLanguages _dynlang;

   333

   334

VARDEF int _num_resolutions;

   335

VARDEF uint16 _resolutions[32][2];

   336

VARDEF uint16 _cur_resolution[2];

   337

   338

VARDEF char _savegame_format[8];

   339

   340

VARDEF char *_config_file;

   341

VARDEF char *_highscore_file;

   342

VARDEF char *_log_file;

   343

   344

// NOSAVE: These can be recalculated from InitializeLandscapeVariables

   345

typedef struct {

   346

	StringID names_s[NUM_CARGO];

   347

	StringID names_long[NUM_CARGO];

   348

	StringID names_short[NUM_CARGO];

   349

	byte weights[NUM_CARGO];

   350

	SpriteID sprites[NUM_CARGO];

   351

	byte transit_days_1[NUM_CARGO];

   352

	byte transit_days_2[NUM_CARGO];

   353

	byte ai_roadveh_start[NUM_CARGO];

   354

	byte ai_roadveh_count[NUM_CARGO];

   355

} CargoConst;

   356

   357

VARDEF CargoConst _cargoc;

   358

   359

   360

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

   361

{

   362

	s[n] = v;

   363

}

   364

   365

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

   366

{

   367

	return s[n];

   368

}

   369

   370

static inline void SetDParam(uint n, uint32 v)

   371

{

   372

	assert(n < lengthof(_decode_parameters));

   373

	_decode_parameters[n] = v;

   374

}

   375

   376

static inline void SetDParam64(uint n, uint64 v)

   377

{

   378

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

   379

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

   380

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

   381

}

   382

   383

static inline uint32 GetDParam(uint n)

   384

{

   385

	assert(n < lengthof(_decode_parameters));

   386

	return _decode_parameters[n];

   387

}

   388

   389

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

   390

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

   391

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

   392

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

   393

   394

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

   395

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

   396

// so be careful.

   397

StringID BindCString(const char *str);

   398

   399

   400

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

   401

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

   402

   403

   404

#define SET_EXPENSES_TYPE(x) _yearly_expenses_type = x;

   405

   406

/* landscape.c */

   407

extern const byte _tileh_to_sprite[32];

   408

extern const byte _inclined_tileh[8];

   409

   410

extern const TileTypeProcs * const _tile_type_procs[16];

   411

   412

/* misc */

   413

VARDEF char _screenshot_name[128];

   414

VARDEF byte _vehicle_design_names;

   415

   416

/* Forking stuff */

   417

VARDEF bool _dedicated_forks;

   418

   419

#endif /* VARIABLES_H */