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

#include "gfx.h"

    14

    15

// Prices and also the fractional part.

    16

VARDEF Prices _price;

    17

VARDEF uint16 _price_frac[NUM_PRICES];

    18

    19

VARDEF uint32 _cargo_payment_rates[NUM_CARGO];

    20

VARDEF uint16 _cargo_payment_rates_frac[NUM_CARGO];

    21

    23

	GameDifficulty diff;

    24

	byte diff_level;

    25

	byte currency;

    26

	byte units;

    27

	byte town_name;

    28

	byte landscape;

    29

	byte snow_line;

    30

	byte autosave;

    31

	byte road_side;

    33

    34

/* These are the options for the current game

    35

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

    36

VARDEF GameOptions _opt;

    37

    38

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

    39

VARDEF GameOptions _opt_newgame;

    40

    41

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

    42

VARDEF GameOptions *_opt_ptr;

    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

// Position in tile loop

    54

VARDEF TileIndex _cur_tileloop_tile;

    55

    56

// Also save scrollpos_x, scrollpos_y and zoom

    57

VARDEF uint16 _disaster_delay;

    58

    59

// Determines what station to operate on in the

    60

//  tick handler.

    61

VARDEF uint16 _station_tick_ctr;

    62

    63

VARDEF uint32 _random_seeds[2][2];

    64

    65

// Iterator through all towns in OnTick_Town

    66

VARDEF uint32 _cur_town_ctr;

    67

// Frequency iterator at the same place

    68

VARDEF uint32 _cur_town_iter;

    69

    70

VARDEF uint _cur_player_tick_index;

    71

VARDEF uint _next_competitor_start;

    72

    73

// Determines how often to run the tree loop

    74

VARDEF byte _trees_tick_ctr;

    75

    76

// Keep track of current game position

    77

VARDEF int _saved_scrollpos_x;

    78

VARDEF int _saved_scrollpos_y;

    79

VARDEF byte _saved_scrollpos_zoom;

    80

    81

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

    82

    84

	bool modified_catchment;            // different-size catchment areas

    85

	bool vehicle_speed;                 // show vehicle speed

    86

	bool build_on_slopes;               // allow building on slopes

    87

	bool mammoth_trains;                // allow very long trains

    88

	bool join_stations;                 // allow joining of train stations

    89

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

    90

	bool improved_load;                 // improved loading algorithm

    91

	bool gradual_loading;               // load vehicles gradually

    92

	byte station_spread;                // amount a station may spread

    93

	bool inflation;                     // disable inflation

    94

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

    95

	bool longbridges;                   // allow 100 tile long bridges

    96

	bool gotodepot;                     // allow goto depot in orders

    97

	bool build_rawmaterial_ind;         // allow building raw material industries

    98

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

    99

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

   100

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

   101

	uint8 order_review_system;

   102

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

   103

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

   104

	bool signal_side;                   // show signals on right side

   105

	bool show_finances;                 // show finances at end of year

   106

	bool new_nonstop;                   // ttdpatch compatible nonstop handling

   107

	bool roadveh_queue;                 // buggy road vehicle queueing

   108

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

   109

	byte errmsg_duration;               // duration of error message

   110

	byte land_generator;                // the landscape generator

   111

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

   112

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

   113

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

   114

	uint32 generation_seed;             // noise seed for world generation

   115

	byte tree_placer;                   // the tree placer algorithm

   116

	byte heightmap_rotation;            // rotation director for the heightmap

   117

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

   118

	bool bribe;                         // enable bribing the local authority

   119

	bool nonuniform_stations;           // allow nonuniform train stations

   120

	bool always_small_airport;          // always allow small airports

   121

	bool realistic_acceleration;        // realistic acceleration for trains

   122

	bool wagon_speed_limits;            // enable wagon speed limits

   123

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

   124

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

   125

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

   126

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

   127

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

   128

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

   129

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

   130

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

   131

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

   132

   133

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

   134

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

   135

   136

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

   137

	UnitID max_roadveh;                 // max trucks in game per player

   138

	UnitID max_aircraft;                // max planes in game per player

   139

	UnitID max_ships;                   // max ships in game per player

   140

   141

	bool servint_ispercent;             // service intervals are in percents

   142

	uint16 servint_trains;              // service interval for trains

   143

	uint16 servint_roadveh;             // service interval for road vehicles

   144

	uint16 servint_aircraft;            // service interval for aircraft

   145

	uint16 servint_ships;               // service interval for ships

   146

   147

	bool autorenew;

   148

	int16 autorenew_months;

   149

	int32 autorenew_money;

   150

   151

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

   152

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

   153

   154

   155

	bool bridge_pillars;                // show bridge pillars for high bridges

   156

   157

	bool ai_disable_veh_train;          // disable types for AI

   158

	bool ai_disable_veh_roadveh;        // disable types for AI

   159

	bool ai_disable_veh_aircraft;       // disable types for AI

   160

	bool ai_disable_veh_ship;           // disable types for AI

   161

	Year starting_year;                 // starting date

   162

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

   163

	Year colored_news_year;             // when does newspaper become colored?

   164

   165

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

   166

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

   167

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

   168

	bool extra_dynamite;                // extra dynamite

   169

	bool road_stop_on_town_road;        // allow building of drive-through road stops on town owned roads

   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

	Year semaphore_build_before;        // Build semaphore signals automatically before this year

   188

	bool ainew_active;                  // Is the new AI active?

   189

	bool ai_in_multiplayer;             // Do we allow AIs in multiplayer

   190

   191

	/*

   192

	 * New Path Finding

   193

	 */

   194

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

   195

   196

	/**

   197

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

   198

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

   199

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

   200

	 * sophisticated way sometime soon

   201

	 */

   202

	uint32 npf_max_search_nodes;

   203

   204

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

   205

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

   206

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

   207

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

   208

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

   209

	uint32 npf_rail_curve_penalty;         /* The penalty for curves */

   210

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

   211

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

   212

	uint32 npf_water_curve_penalty;        /* The penalty for curves */

   213

	uint32 npf_road_curve_penalty;         /* The penalty for curves */

   214

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

   215

	uint32 npf_road_drive_through_penalty; /* The penalty for going through a drive-through road stop */

   216

   217

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

   218

   219

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

   220

   221

	/** YAPF settings */

   222

	YapfSettings  yapf;

   223

   225

   226

VARDEF Patches _patches;

   227

   228

   230

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

   231

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

   233

   234

   235

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

   236

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

   237

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

   238

   240

	Cheat magic_bulldozer;  // dynamite industries, unmovables

   241

	Cheat switch_player;    // change to another player

   242

	Cheat money;            // get rich

   243

	Cheat crossing_tunnels; // allow tunnels that cross each other

   244

	Cheat build_in_pause;   // build while in pause mode

   245

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

   246

	Cheat switch_climate;

   247

	Cheat change_date;      // changes date ingame

   248

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

   249

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

   251

   252

VARDEF Cheats _cheats;

   253

   255

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

   256

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

   257

	char *data_dir;

   258

	char *gm_dir;

   259

	char *lang_dir;

   260

	char *save_dir;

   261

	char *autosave_dir;

   262

	char *scenario_dir;

   263

	char *heightmap_dir;

   264

	char *second_data_dir;

   266

   267

VARDEF Paths _paths;

   268

   269

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

   270

VARDEF int _timer_counter;

   271

   272

   273

VARDEF uint32 _frame_counter;

   274

   275

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

   276

   277

VARDEF bool _do_autosave;

   278

VARDEF int _autosave_ctr;

   279

   280

VARDEF byte _display_opt;

   281

VARDEF int _caret_timer;

   282

VARDEF uint32 _news_display_opt;

   283

VARDEF bool _news_ticker_sound;

   284

   285

VARDEF StringID _error_message;

   286

VARDEF int32 _additional_cash_required;

   287

   288

VARDEF uint32 _decode_parameters[20];

   289

   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

   300

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

   301

	char name[MAX_PATH];  // name

   302

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

   304

   305

// Used when switching from the intro menu.

   306

VARDEF byte _switch_mode;

   307

VARDEF StringID _switch_mode_errorstr;

   308

VARDEF SmallFiosItem _file_to_saveload;

   309

   310

   311

   312

VARDEF Vehicle *_place_clicked_vehicle;

   313

   314

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

   315

   316

// Used for dynamic language support

   318

	int num; // number of languages

   319

	int curr; // currently selected language index

   320

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

   321

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

   322

	struct {

   323

		char *name;

   324

		char *file;

   325

	} ent[MAX_LANG];

   327

   328

VARDEF DynamicLanguages _dynlang;

   329

   330

VARDEF int _num_resolutions;

   331

VARDEF uint16 _resolutions[32][2];

   332

VARDEF uint16 _cur_resolution[2];

   333

   334

VARDEF char _savegame_format[8];

   335

   336

VARDEF char *_config_file;

   337

VARDEF char *_highscore_file;

   338

VARDEF char *_log_file;

   339

   340

   341

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

   342

{

   343

	s[n] = v;

   344

}

   345

   346

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

   347

{

   348

	return s[n];

   349

}

   350

   351

static inline void SetDParam(uint n, uint32 v)

   352

{

   353

	assert(n < lengthof(_decode_parameters));

   354

	_decode_parameters[n] = v;

   355

}

   356

   357

static inline void SetDParam64(uint n, uint64 v)

   358

{

   359

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

   360

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

   361

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

   362

}

   363

   364

static inline uint32 GetDParam(uint n)

   365

{

   366

	assert(n < lengthof(_decode_parameters));

   367

	return _decode_parameters[n];

   368

}

   369

   370

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

   371

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

   372

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

   373

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

   374

   375

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

   376

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

   377

// so be careful.

   378

StringID BindCString(const char *str);

   379

   380

   381

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

   382

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

   383

   384

   385

#define SET_EXPENSES_TYPE(x) _yearly_expenses_type = x;

   386

   387

/* landscape.c */

   388

extern const byte _tileh_to_sprite[32];

   389

extern const Slope _inclined_tileh[16];

   390

   391

extern const TileTypeProcs * const _tile_type_procs[16];

   392

   393

/* misc */

   394

VARDEF char _screenshot_name[128];

   395

VARDEF byte _vehicle_design_names;

   396

   397

/* Forking stuff */

   398

VARDEF bool _dedicated_forks;

   399

   400

#endif /* VARIABLES_H */