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

VARDEF uint32 _cargo_payment_rates[NUM_CARGO];

    18

VARDEF uint16 _cargo_payment_rates_frac[NUM_CARGO];

    19

    20

struct GameOptions {

    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

};

    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

/* Position in tile loop */

    52

VARDEF TileIndex _cur_tileloop_tile;

    53

    54

/* Also save scrollpos_x, scrollpos_y and zoom */

    55

VARDEF uint16 _disaster_delay;

    56

    57

/* Determines what station to operate on in the

    58

 *  tick handler. */

    59

VARDEF uint16 _station_tick_ctr;

    60

    61

VARDEF uint32 _random_seeds[2][2];

    62

    63

/* Iterator through all towns in OnTick_Town */

    64

VARDEF uint32 _cur_town_ctr;

    65

/* Frequency iterator at the same place */

    66

VARDEF uint32 _cur_town_iter;

    67

    68

VARDEF uint _cur_player_tick_index;

    69

VARDEF uint _next_competitor_start;

    70

    71

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

    72

VARDEF byte _trees_tick_ctr;

    73

    74

/* Keep track of current game position */

    75

VARDEF int _saved_scrollpos_x;

    76

VARDEF int _saved_scrollpos_y;

    77

    78

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

    79

    80

struct Patches {

    81

	bool modified_catchment;            // different-size catchment areas

    82

	bool vehicle_speed;                 // show vehicle speed

    83

	bool build_on_slopes;               // allow building on slopes

    84

	bool mammoth_trains;                // allow very long trains

    85

	bool join_stations;                 // allow joining of train stations

    86

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

    87

	bool improved_load;                 // improved loading algorithm

    88

	bool gradual_loading;               // load vehicles gradually

    89

	byte station_spread;                // amount a station may spread

    90

	bool inflation;                     // disable inflation

    91

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

    92

	bool longbridges;                   // allow 100 tile long bridges

    93

	bool gotodepot;                     // allow goto depot in orders

    94

	bool build_rawmaterial_ind;         // allow building raw material industries

    95

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

    96

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

    97

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

    98

	uint8 order_review_system;

    99

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

   100

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

   101

	bool signal_side;                   // show signals on right side

   102

	bool show_finances;                 // show finances at end of year

   103

	bool new_nonstop;                   // ttdpatch compatible nonstop handling

   104

	bool roadveh_queue;                 // buggy road vehicle queueing

   105

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

   106

	byte errmsg_duration;               // duration of error message

   107

	byte land_generator;                // the landscape generator

   108

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

   109

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

   110

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

   111

	uint32 generation_seed;             // noise seed for world generation

   112

	byte tree_placer;                   // the tree placer algorithm

   113

	byte heightmap_rotation;            // rotation director for the heightmap

   114

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

   115

	bool bribe;                         // enable bribing the local authority

   116

	bool nonuniform_stations;           // allow nonuniform train stations

   117

	bool adjacent_stations;             // allow stations to be built directly adjacent to other stations

   118

	bool always_small_airport;          // always allow small airports

   119

	bool realistic_acceleration;        // realistic acceleration for trains

   120

	bool wagon_speed_limits;            // enable wagon speed limits

   121

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

   122

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

   123

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

   124

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

   125

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

   126

	bool smooth_scroll;                 ///< Smooth scroll viewports

   127

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

   128

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

   129

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

   130

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

   131

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

   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

   224

	uint8 scrollwheel_scrolling;

   225

	uint8 scrollwheel_multiplier;

   226

   227

	uint8 town_growth_rate;  ///< Town growth rate

   228

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

   229

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

   230

   231

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

   232

   233

	TownLayoutByte town_layout;  ///< Select town layout

   234

};

   235

   236

VARDEF Patches _patches;

   237

   238

   239

struct Cheat {

   240

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

   241

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

   242

};

   243

   244

   245

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

   246

 * of the existing ones! Would break downward compatibility.

   247

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

   248

   249

struct Cheats {

   250

	Cheat magic_bulldozer;  // dynamite industries, unmovables

   251

	Cheat switch_player;    // change to another player

   252

	Cheat money;            // get rich

   253

	Cheat crossing_tunnels; // allow tunnels that cross each other

   254

	Cheat build_in_pause;   // build while in pause mode

   255

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

   256

	Cheat switch_climate;

   257

	Cheat change_date;      // changes date ingame

   258

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

   259

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

   260

};

   261

   262

VARDEF Cheats _cheats;

   263

   264

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

   265

VARDEF int _timer_counter;

   266

   267

   268

VARDEF uint32 _frame_counter;

   269

   270

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

   271

   272

VARDEF bool _do_autosave;

   273

VARDEF int _autosave_ctr;

   274

   275

VARDEF byte _display_opt;

   276

VARDEF byte _transparent_opt;

   277

VARDEF int _caret_timer;

   278

VARDEF uint32 _news_display_opt;

   279

VARDEF bool _news_ticker_sound;

   280

   281

VARDEF StringID _error_message;

   282

VARDEF int32 _additional_cash_required;

   283

   284

VARDEF uint32 _decode_parameters[20];

   285

   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

   294

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

   295

struct SmallFiosItem {

   296

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

   297

	char name[MAX_PATH];  // name

   298

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

   299

};

   300

   301

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

   302

VARDEF byte _switch_mode;

   303

VARDEF StringID _switch_mode_errorstr;

   304

VARDEF SmallFiosItem _file_to_saveload;

   305

   306

   307

   308

VARDEF Vehicle *_place_clicked_vehicle;

   309

   310

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

   311

   312

/** Information about a language */

   313

struct Language {

   314

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

   315

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

   316

};

   317

   318

/** Used for dynamic language support */

   319

struct DynamicLanguages {

   320

	int num;                         ///< Number of languages

   321

	int curr;                        ///< Currently selected language index

   322

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

   323

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

   324

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

   325

};

   326

   327

extern DynamicLanguages _dynlang; // defined in strings.cpp

   328

   329

VARDEF int _num_resolutions;

   330

VARDEF uint16 _resolutions[32][2];

   331

VARDEF uint16 _cur_resolution[2];

   332

   333

VARDEF char _savegame_format[8];

   334

   335

VARDEF char *_config_file;

   336

VARDEF char *_highscore_file;

   337

VARDEF char *_log_file;

   338

   339

   340

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

   341

{

   342

	s[n] = v;

   343

}

   344

   345

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

   346

{

   347

	return s[n];

   348

}

   349

   350

static inline void SetDParam(uint n, uint32 v)

   351

{

   352

	assert(n < lengthof(_decode_parameters));

   353

	_decode_parameters[n] = v;

   354

}

   355

   356

static inline void SetDParam64(uint n, uint64 v)

   357

{

   358

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

   359

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

   360

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

   361

}

   362

   363

static inline uint32 GetDParam(uint n)

   364

{

   365

	assert(n < lengthof(_decode_parameters));

   366

	return _decode_parameters[n];

   367

}

   368

   369

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

   370

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

   371

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

   372

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

   373

   374

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

   375

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

   376

 * so be careful. */

   377

StringID BindCString(const char *str);

   378

   379

   380

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

   381

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

   382

   383

   384

#define SET_EXPENSES_TYPE(x) _yearly_expenses_type = x;

   385

   386

/* landscape.cpp */

   387

extern const byte _tileh_to_sprite[32];

   388

extern const Slope _inclined_tileh[16];

   389

   390

extern const TileTypeProcs * const _tile_type_procs[16];

   391

   392

/* misc */

   393

VARDEF char _screenshot_name[128];

   394

VARDEF byte _vehicle_design_names;

   395

   396

/* Forking stuff */

   397

VARDEF bool _dedicated_forks;

   398

   399

#endif /* VARIABLES_H */