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

// Amount of game ticks

    43

VARDEF uint16 _tick_counter;

    44

    45

// This one is not used anymore.

    46

VARDEF VehicleID _vehicle_id_ctr_day;

    47

    48

// Skip aging of cargo?

    49

VARDEF byte _age_cargo_skip_counter;

    50

    51

// Available aircraft types

    52

VARDEF byte _avail_aircraft;

    53

    54

// Position in tile loop

    55

VARDEF TileIndex _cur_tileloop_tile;

    56

    57

// Also save scrollpos_x, scrollpos_y and zoom

    58

VARDEF uint16 _disaster_delay;

    59

    60

// Determines what station to operate on in the

    61

//  tick handler.

    62

VARDEF uint16 _station_tick_ctr;

    63

    64

VARDEF uint32 _random_seeds[2][2];

    65

    66

// Iterator through all towns in OnTick_Town

    67

VARDEF uint32 _cur_town_ctr;

    68

// Frequency iterator at the same place

    69

VARDEF uint32 _cur_town_iter;

    70

    71

VARDEF uint _cur_player_tick_index;

    72

VARDEF uint _next_competitor_start;

    73

    74

// Determines how often to run the tree loop

    75

VARDEF byte _trees_tick_ctr;

    76

    77

// Keep track of current game position

    78

VARDEF int _saved_scrollpos_x;

    79

VARDEF int _saved_scrollpos_y;

    80

VARDEF byte _saved_scrollpos_zoom;

    81

    82

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

    83

    84

typedef struct Patches {

    85

	bool modified_catchment;            // different-size catchment areas

    86

	bool vehicle_speed;                 // show vehicle speed

    87

	bool build_on_slopes;               // allow building on slopes

    88

	bool mammoth_trains;                // allow very long trains

    89

	bool join_stations;                 // allow joining of train stations

    90

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

    91

	bool improved_load;                 // improved loading algorithm

    92

	bool gradual_loading;               // load vehicles gradually

    93

	byte station_spread;                // amount a station may spread

    94

	bool inflation;                     // disable inflation

    95

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

    96

	bool longbridges;                   // allow 100 tile long bridges

    97

	bool gotodepot;                     // allow goto depot in orders

    98

	bool build_rawmaterial_ind;         // allow building raw material industries

    99

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

   100

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

   101

	bool lost_train_warn;               // if a train can't find its destination, show a warning

   102

	uint8 order_review_system;

   103

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

   104

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

   105

	bool signal_side;                   // show signals on right side

   106

	bool show_finances;                 // show finances at end of year

   107

	bool new_nonstop;                   // ttdpatch compatible nonstop handling

   108

	bool roadveh_queue;                 // buggy road vehicle queueing

   109

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

   110

	byte errmsg_duration;               // duration of error message

   111

	byte land_generator;                // the landscape generator

   112

	byte oil_refinery_limit;            // distance oil refineries allowed from map edge

   113

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

   114

	byte tgen_smoothness;               // how rough is the terrain from 0-3

   115

	uint32 generation_seed;             // noise seed for world generation

   116

	byte tree_placer;                   // the tree placer algorithm

   117

	byte heightmap_rotation;            // rotation director for the heightmap

   118

	byte se_flat_world_height;          // land height a flat world gets in SE

   119

	bool bribe;                         // enable bribing the local authority

   120

	bool nonuniform_stations;           // allow nonuniform train stations

   121

	bool always_small_airport;          // always allow small airports

   122

	bool realistic_acceleration;        // realistic acceleration for trains

   123

	bool wagon_speed_limits;            // enable wagon speed limits

   124

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

   125

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

   126

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

   127

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

   128

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

   129

	bool disable_elrails;               // when true, the elrails are disabled

   130

	bool measure_tooltip;               // Show a permanent tooltip when dragging tools

   131

	byte liveries;                      // Options for displaying company liveries, 0=none, 1=self, 2=all

   132

	bool prefer_teamchat;               // Choose the chat message target with <ENTER>, true=all players, false=your team

   133

   134

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

   135

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

   136

   137

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

   138

	UnitID max_roadveh;                 // max trucks in game per player

   139

	UnitID max_aircraft;                // max planes in game per player

   140

	UnitID max_ships;                   // max ships in game per player

   141

   142

	bool servint_ispercent;             // service intervals are in percents

   143

	uint16 servint_trains;              // service interval for trains

   144

	uint16 servint_roadveh;             // service interval for road vehicles

   145

	uint16 servint_aircraft;            // service interval for aircraft

   146

	uint16 servint_ships;               // service interval for ships

   147

   148

	bool autorenew;

   149

	int16 autorenew_months;

   150

	int32 autorenew_money;

   151

   152

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

   153

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

   154

   155

   156

	bool bridge_pillars;                // show bridge pillars for high bridges

   157

   158

	bool ai_disable_veh_train;          // disable types for AI

   159

	bool ai_disable_veh_roadveh;        // disable types for AI

   160

	bool ai_disable_veh_aircraft;       // disable types for AI

   161

	bool ai_disable_veh_ship;           // disable types for AI

   162

	Year starting_year;                 // starting date

   163

	Year ending_year;                   // end of the game (just show highscore)

   164

	Year colored_news_year;             // when does newspaper become colored?

   165

   166

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

   167

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

   168

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

   169

	bool extra_dynamite;                // extra dynamite

   170

   171

	bool never_expire_vehicles;         // never expire vehicles

   172

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

   173

   174

	bool auto_euro;                     // automatically switch to euro in 2002

   175

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

   176

	bool smooth_economy;                // smooth economy

   177

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

   178

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

   179

   180

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

   181

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

   182

   183

	uint8 map_x;                        // Size of map

   184

	uint8 map_y;

   185

   186

	byte drag_signals_density;          // many signals density

   187

	bool ainew_active;                  // Is the new AI active?

   188

	bool ai_in_multiplayer;             // Do we allow AIs in multiplayer

   189

   190

	/*

   191

	 * New Path Finding

   192

	 */

   193

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

   194

   195

	/**

   196

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

   197

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

   198

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

   199

	 * sophisticated way sometime soon

   200

	 */

   201

	uint32 npf_max_search_nodes;

   202

   203

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

   204

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

   205

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

   206

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

   207

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

   208

	uint32 npf_rail_curve_penalty;         /* The penalty for curves */

   209

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

   210

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

   211

	uint32 npf_water_curve_penalty;        /* The penalty for curves */

   212

	uint32 npf_road_curve_penalty;         /* The penalty for curves */

   213

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

   214

   215

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

   216

   217

	uint8 freight_trains; ///< Value to multiply the weight of cargo by

   218

   219

	/** YAPF settings */

   220

	YapfSettings  yapf;

   221

   222

} Patches;

   223

   224

VARDEF Patches _patches;

   225

   226

   227

typedef struct Cheat {

   228

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

   229

	bool value;     // tells if the bool cheat is active or not

   230

} Cheat;

   231

   232

   233

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

   234

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

   235

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

   236

   237

typedef struct Cheats {

   238

	Cheat magic_bulldozer;  // dynamite industries, unmovables

   239

	Cheat switch_player;    // change to another player

   240

	Cheat money;            // get rich

   241

	Cheat crossing_tunnels; // allow tunnels that cross each other

   242

	Cheat build_in_pause;   // build while in pause mode

   243

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

   244

	Cheat switch_climate;

   245

	Cheat change_date;      // changes date ingame

   246

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

   247

	Cheat dummy;            // empty cheat (enable running el-engines on normal rail)

   248

} Cheats;

   249

   250

VARDEF Cheats _cheats;

   251

   252

typedef struct Paths {

   253

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

   254

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

   255

	char *data_dir;

   256

	char *gm_dir;

   257

	char *lang_dir;

   258

	char *save_dir;

   259

	char *autosave_dir;

   260

	char *scenario_dir;

   261

	char *heightmap_dir;

   262

	char *second_data_dir;

   263

} Paths;

   264

   265

VARDEF Paths _paths;

   266

   267

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

   268

VARDEF int _timer_counter;

   269

   270

   271

VARDEF uint32 _frame_counter;

   272

   273

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

   274

   275

VARDEF bool _do_autosave;

   276

VARDEF int _autosave_ctr;

   277

   278

VARDEF byte _display_opt;

   279

VARDEF byte _pause;

   280

VARDEF int _caret_timer;

   281

VARDEF uint32 _news_display_opt;

   282

VARDEF bool _news_ticker_sound;

   283

VARDEF byte _game_mode;

   284

   285

VARDEF StringID _error_message;

   286

VARDEF int32 _additional_cash_required;

   287

   288

VARDEF uint32 _decode_parameters[20];

   289

   290

VARDEF bool _ctrl_pressed;   // Is Ctrl pressed?

   291

VARDEF bool _shift_pressed;  // Is Shift pressed?

   292

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

   293

   294

VARDEF bool _fullscreen;

   295

VARDEF bool _fast_forward;

   296

VARDEF bool _rightclick_emulate;

   297

   298

// IN/OUT parameters to commands

   299

VARDEF byte _yearly_expenses_type;

   300

VARDEF TileIndex _terraform_err_tile;

   301

VARDEF TileIndex _build_tunnel_endtile;

   302

VARDEF bool _generating_world;

   303

   304

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

   305

typedef struct {

   306

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

   307

	char name[MAX_PATH];  // name

   308

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

   309

} SmallFiosItem;

   310

   311

// Used when switching from the intro menu.

   312

VARDEF byte _switch_mode;

   313

VARDEF StringID _switch_mode_errorstr;

   314

VARDEF bool _exit_game;

   315

VARDEF SmallFiosItem _file_to_saveload;

   316

   317

   318

   319

VARDEF Vehicle *_place_clicked_vehicle;

   320

   321

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

   322

   323

// Used for dynamic language support

   324

typedef struct {

   325

	int num; // number of languages

   326

	int curr; // currently selected language index

   327

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

   328

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

   329

	struct {

   330

		char *name;

   331

		char *file;

   332

	} ent[MAX_LANG];

   333

} DynamicLanguages;

   334

   335

VARDEF DynamicLanguages _dynlang;

   336

   337

VARDEF int _num_resolutions;

   338

VARDEF uint16 _resolutions[32][2];

   339

VARDEF uint16 _cur_resolution[2];

   340

   341

VARDEF char _savegame_format[8];

   342

   343

VARDEF char *_config_file;

   344

VARDEF char *_highscore_file;

   345

VARDEF char *_log_file;

   346

   347

// NOSAVE: These can be recalculated from InitializeLandscapeVariables

   348

typedef struct {

   349

	StringID names_s[NUM_CARGO];

   350

	StringID names_long[NUM_CARGO];

   351

	StringID names_short[NUM_CARGO];

   352

	byte weights[NUM_CARGO];

   353

	SpriteID sprites[NUM_CARGO];

   354

	byte transit_days_1[NUM_CARGO];

   355

	byte transit_days_2[NUM_CARGO];

   356

} CargoConst;

   357

   358

VARDEF CargoConst _cargoc;

   359

   360

   361

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

   362

{

   363

	s[n] = v;

   364

}

   365

   366

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

   367

{

   368

	return s[n];

   369

}

   370

   371

static inline void SetDParam(uint n, uint32 v)

   372

{

   373

	assert(n < lengthof(_decode_parameters));

   374

	_decode_parameters[n] = v;

   375

}

   376

   377

static inline void SetDParam64(uint n, uint64 v)

   378

{

   379

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

   380

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

   381

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

   382

}

   383

   384

static inline uint32 GetDParam(uint n)

   385

{

   386

	assert(n < lengthof(_decode_parameters));

   387

	return _decode_parameters[n];

   388

}

   389

   390

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

   391

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

   392

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

   393

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

   394

   395

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

   396

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

   397

// so be careful.

   398

StringID BindCString(const char *str);

   399

   400

   401

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

   402

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

   403

   404

   405

#define SET_EXPENSES_TYPE(x) _yearly_expenses_type = x;

   406

   407

/* landscape.c */

   408

extern const byte _tileh_to_sprite[32];

   409

extern const byte _inclined_tileh[16];

   410

   411

extern const TileTypeProcs * const _tile_type_procs[16];

   412

   413

/* misc */

   414

VARDEF char _screenshot_name[128];

   415

VARDEF byte _vehicle_design_names;

   416

   417

/* Forking stuff */

   418

VARDEF bool _dedicated_forks;

   419

   420

#endif /* VARIABLES_H */