1

/* $Id$ */

     2

     3

/** @file variables.h */

     4

     5

#ifndef VARIABLES_H

     6

#define VARIABLES_H

     7

     8

#include "yapf/yapf_settings.h"

     9

    10

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

    11

#if !defined(MAX_PATH)

    12

# define MAX_PATH 260

    13

#endif

    14

    15

#include "gfx.h"

    16

    17

/* Prices and also the fractional part. */

    18

VARDEF Prices _price;

    19

VARDEF uint16 _price_frac[NUM_PRICES];

    20

    21

VARDEF Money  _cargo_payment_rates[NUM_CARGO];

    22

VARDEF uint16 _cargo_payment_rates_frac[NUM_CARGO];

    23

    24

struct GameOptions {

    25

	GameDifficulty diff;

    26

	byte diff_level;

    27

	byte currency;

    28

	byte units;

    29

	byte town_name;

    30

	byte landscape;

    31

	byte snow_line;

    32

	byte autosave;

    33

	byte road_side;

    34

};

    35

    36

/* These are the options for the current game

    37

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

    38

VARDEF GameOptions _opt;

    39

    40

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

    41

VARDEF GameOptions _opt_newgame;

    42

    43

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

    44

VARDEF GameOptions *_opt_ptr;

    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

/* Position in tile loop */

    56

VARDEF TileIndex _cur_tileloop_tile;

    57

    58

/* Also save scrollpos_x, scrollpos_y and zoom */

    59

VARDEF uint16 _disaster_delay;

    60

    61

/* Determines what station to operate on in the

    62

 *  tick handler. */

    63

VARDEF uint16 _station_tick_ctr;

    64

    65

VARDEF uint32 _random_seeds[2][2];

    66

    67

/* Iterator through all towns in OnTick_Town */

    68

VARDEF uint32 _cur_town_ctr;

    69

/* Frequency iterator at the same place */

    70

VARDEF uint32 _cur_town_iter;

    71

    72

VARDEF uint _cur_player_tick_index;

    73

VARDEF uint _next_competitor_start;

    74

    75

/* Determines how often to run the tree loop */

    76

VARDEF byte _trees_tick_ctr;

    77

    78

/* Keep track of current game position */

    79

VARDEF int _saved_scrollpos_x;

    80

VARDEF int _saved_scrollpos_y;

    81

    82

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

    83

    84

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 adjacent_stations;             // allow stations to be built directly adjacent to other stations

   122

	bool always_small_airport;          // always allow small airports

   123

	bool realistic_acceleration;        // realistic acceleration for trains

   124

	bool wagon_speed_limits;            // enable wagon speed limits

   125

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

   126

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

   127

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

   128

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

   129

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

   130

	bool smooth_scroll;                 ///< Smooth scroll viewports

   131

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

   132

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

   133

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

   134

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

   135

	bool advanced_vehicle_list;         // Use the "advanced" vehicle list

   136

	bool loading_indicators;            // Show loading indicators

   138

   139

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

   140

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

   141

   142

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

   143

	UnitID max_roadveh;                 // max trucks in game per player

   144

	UnitID max_aircraft;                // max planes in game per player

   145

	UnitID max_ships;                   // max ships in game per player

   146

   147

	bool servint_ispercent;             // service intervals are in percents

   148

	uint16 servint_trains;              // service interval for trains

   149

	uint16 servint_roadveh;             // service interval for road vehicles

   150

	uint16 servint_aircraft;            // service interval for aircraft

   151

	uint16 servint_ships;               // service interval for ships

   152

   153

	bool autorenew;

   154

	int16 autorenew_months;

   155

	int32 autorenew_money;

   156

   157

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

   158

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

   159

   160

   161

	bool bridge_pillars;                // show bridge pillars for high bridges

   162

   163

	bool ai_disable_veh_train;          // disable types for AI

   164

	bool ai_disable_veh_roadveh;        // disable types for AI

   165

	bool ai_disable_veh_aircraft;       // disable types for AI

   166

	bool ai_disable_veh_ship;           // disable types for AI

   167

	Year starting_year;                 // starting date

   168

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

   169

	Year colored_news_year;             // when does newspaper become colored?

   170

   171

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

   172

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

   173

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

   174

	bool extra_dynamite;                // extra dynamite

   175

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

   176

   177

	bool never_expire_vehicles;         // never expire vehicles

   178

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

   179

   180

	bool auto_euro;                     // automatically switch to euro in 2002

   181

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

   182

	bool smooth_economy;                // smooth economy

   183

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

   184

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

   185

   186

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

   187

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

   188

   189

	uint8 map_x;                        // Size of map

   190

	uint8 map_y;

   191

   192

	byte drag_signals_density;          // many signals density

   193

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

   194

	bool ainew_active;                  // Is the new AI active?

   195

	bool ai_in_multiplayer;             // Do we allow AIs in multiplayer

   196

   197

	/*

   198

	 * New Path Finding

   199

	 */

   200

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

   201

   202

	/**

   203

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

   204

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

   205

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

   206

	 * sophisticated way sometime soon

   207

	 */

   208

	uint32 npf_max_search_nodes;

   209

   210

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

   211

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

   212

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

   213

	uint32 npf_rail_station_penalty;       // The penalty for station tiles

   214

	uint32 npf_rail_slope_penalty;         // The penalty for sloping upwards

   215

	uint32 npf_rail_curve_penalty;         // The penalty for curves

   216

	uint32 npf_rail_depot_reverse_penalty; // The penalty for reversing in depots

   217

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

   218

	uint32 npf_water_curve_penalty;        // The penalty for curves

   219

	uint32 npf_road_curve_penalty;         // The penalty for curves

   220

	uint32 npf_crossing_penalty;           // The penalty for level crossings

   221

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

   222

   223

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

   224

   225

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

   226

   227

	/** YAPF settings */

   228

	YapfSettings  yapf;

   229

   230

	uint8 scrollwheel_scrolling;

   231

	uint8 scrollwheel_multiplier;

   232

   233

	uint8 town_growth_rate;  ///< Town growth rate

   234

	uint8 larger_towns;      ///< The number of cities to build. These start off larger and grow twice as fast

   235

	uint8 initial_city_size; ///< Multiplier for the initial size of the cities compared to towns

   236

   237

	bool pause_on_newgame;   ///< Whether to start new games paused or not.

   238

   239

	TownLayoutByte town_layout;  ///< Select town layout

   240

   241

	bool timetabling;        ///< Whether to allow timetabling.

   242

	bool timetable_in_ticks; ///< Whether to show the timetable in ticks rather than days.

   243

};

   244

   245

VARDEF Patches _patches;

   246

   247

   248

struct Cheat {

   249

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

   250

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

   251

};

   252

   253

   254

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

   255

 * of the existing ones! Would break downward compatibility.

   256

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

   257

   258

struct Cheats {

   259

	Cheat magic_bulldozer;  // dynamite industries, unmovables

   260

	Cheat switch_player;    // change to another player

   261

	Cheat money;            // get rich

   262

	Cheat crossing_tunnels; // allow tunnels that cross each other

   263

	Cheat build_in_pause;   // build while in pause mode

   264

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

   265

	Cheat switch_climate;

   266

	Cheat change_date;      // changes date ingame

   267

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

   268

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

   269

};

   270

   271

VARDEF Cheats _cheats;

   272

   273

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

   274

VARDEF int _palette_animation_counter;

   275

   276

   277

VARDEF uint32 _frame_counter;

   278

VARDEF uint32 _realtime_tick;

   279

   280

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

   281

   282

VARDEF bool _do_autosave;

   283

VARDEF int _autosave_ctr;

   284

   285

VARDEF byte _display_opt;

   286

VARDEF byte _transparent_opt;

   287

VARDEF int _caret_timer;

   288

VARDEF uint32 _news_display_opt;

   289

VARDEF bool _news_ticker_sound;

   290

   291

VARDEF StringID _error_message;

   292

VARDEF Money _additional_cash_required;

   293

   294

VARDEF uint64 _decode_parameters[20];

   295

   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

struct SmallFiosItem {

   306

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

   307

	char name[MAX_PATH];  // name

   308

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

   309

};

   310

   311

/* Used when switching from the intro menu. */

   312

VARDEF byte _switch_mode;

   313

VARDEF StringID _switch_mode_errorstr;

   314

VARDEF SmallFiosItem _file_to_saveload;

   315

   316

   317

   318

VARDEF Vehicle *_place_clicked_vehicle;

   319

   320

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

   321

   322

/** Information about a language */

   323

struct Language {

   324

	char *name; ///< The internal name of the language

   325

	char *file; ///< The name of the language as it appears on disk

   326

};

   327

   328

/** Used for dynamic language support */

   329

struct DynamicLanguages {

   330

	int num;                         ///< Number of languages

   331

	int curr;                        ///< Currently selected language index

   332

	char curr_file[MAX_PATH];        ///< Currently selected language file name without path (needed for saving the filename of the loaded language).

   333

	StringID dropdown[MAX_LANG + 1]; ///< List of languages in the settings gui

   334

	Language ent[MAX_LANG];          ///< Information about the languages

   335

};

   336

   337

extern DynamicLanguages _dynlang; // defined in strings.cpp

   338

   339

VARDEF int _num_resolutions;

   340

VARDEF uint16 _resolutions[32][2];

   341

VARDEF uint16 _cur_resolution[2];

   342

   343

VARDEF char _savegame_format[8];

   344

   345

VARDEF char *_config_file;

   346

VARDEF char *_highscore_file;

   347

VARDEF char *_log_file;

   348

   349

   350

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

   351

{

   352

	s[n] = v;

   353

}

   354

   355

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

   356

{

   357

	return s[n];

   358

}

   359

   360

static inline void SetDParam(uint n, uint64 v)

   361

{

   362

	assert(n < lengthof(_decode_parameters));

   363

	_decode_parameters[n] = v;

   364

}

   365

   366

static inline uint64 GetDParam(uint n)

   367

{

   368

	assert(n < lengthof(_decode_parameters));

   369

	return _decode_parameters[n];

   370

}

   371

   372

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

   373

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

   374

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

   375

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

   376

   377

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

   378

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

   379

 * so be careful. */

   380

StringID BindCString(const char *str);

   381

   382

   383

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

   384

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

   385

   386

   387

#define SET_EXPENSES_TYPE(x) _yearly_expenses_type = x;

   388

   389

/* landscape.cpp */

   390

extern const byte _tileh_to_sprite[32];

   391

extern const Slope _inclined_tileh[16];

   392

   393

extern const TileTypeProcs * const _tile_type_procs[16];

   394

   395

/* misc */

   396

VARDEF char _screenshot_name[128];

   397

VARDEF byte _vehicle_design_names;

   398

   399

/* Forking stuff */

   400

VARDEF bool _dedicated_forks;

   401

   402

#endif /* VARIABLES_H */