OpenTTD
engine.cpp
Go to the documentation of this file.
1 /* $Id: engine.cpp 27797 2017-03-18 20:43:43Z alberth $ */
2 
3 /*
4  * This file is part of OpenTTD.
5  * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
6  * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
7  * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
8  */
9 
12 #include "stdafx.h"
13 #include "company_func.h"
14 #include "command_func.h"
15 #include "news_func.h"
16 #include "aircraft.h"
17 #include "newgrf.h"
18 #include "newgrf_engine.h"
19 #include "strings_func.h"
20 #include "core/random_func.hpp"
21 #include "window_func.h"
22 #include "date_func.h"
23 #include "autoreplace_gui.h"
24 #include "string_func.h"
25 #include "ai/ai.hpp"
26 #include "core/pool_func.hpp"
27 #include "engine_gui.h"
28 #include "engine_func.h"
29 #include "engine_base.h"
30 #include "company_base.h"
31 #include "vehicle_func.h"
32 #include "articulated_vehicles.h"
33 #include "error.h"
34 
35 #include "table/strings.h"
36 #include "table/engines.h"
37 
38 #include "safeguards.h"
39 
40 EnginePool _engine_pool("Engine");
42 
43 EngineOverrideManager _engine_mngr;
44 
50 
52 const uint8 _engine_counts[4] = {
53  lengthof(_orig_rail_vehicle_info),
54  lengthof(_orig_road_vehicle_info),
55  lengthof(_orig_ship_vehicle_info),
56  lengthof(_orig_aircraft_vehicle_info),
57 };
58 
60 const uint8 _engine_offsets[4] = {
61  0,
62  lengthof(_orig_rail_vehicle_info),
63  lengthof(_orig_rail_vehicle_info) + lengthof(_orig_road_vehicle_info),
64  lengthof(_orig_rail_vehicle_info) + lengthof(_orig_road_vehicle_info) + lengthof(_orig_ship_vehicle_info),
65 };
66 
67 assert_compile(lengthof(_orig_rail_vehicle_info) + lengthof(_orig_road_vehicle_info) + lengthof(_orig_ship_vehicle_info) + lengthof(_orig_aircraft_vehicle_info) == lengthof(_orig_engine_info));
68 
70 
71 Engine::Engine() :
72  name(NULL),
73  overrides_count(0),
74  overrides(NULL)
75 {
76 }
77 
78 Engine::Engine(VehicleType type, EngineID base)
79 {
80  this->type = type;
81  this->grf_prop.local_id = base;
82  this->list_position = base;
84 
85  /* Check if this base engine is within the original engine data range */
86  if (base >= _engine_counts[type]) {
87  /* Set model life to maximum to make wagons available */
88  this->info.base_life = 0xFF;
89  /* Set road vehicle tractive effort to the default value */
90  if (type == VEH_ROAD) this->u.road.tractive_effort = 0x4C;
91  /* Aircraft must have CT_INVALID as default, as there is no property */
92  if (type == VEH_AIRCRAFT) this->info.cargo_type = CT_INVALID;
93  /* Set visual effect to the default value */
94  switch (type) {
95  case VEH_TRAIN: this->u.rail.visual_effect = VE_DEFAULT; break;
96  case VEH_ROAD: this->u.road.visual_effect = VE_DEFAULT; break;
97  case VEH_SHIP: this->u.ship.visual_effect = VE_DEFAULT; break;
98  default: break; // The aircraft, disasters and especially visual effects have no NewGRF configured visual effects
99  }
100  /* Set cargo aging period to the default value. */
101  this->info.cargo_age_period = CARGO_AGING_TICKS;
102  return;
103  }
104 
105  /* Copy the original engine info for this slot */
106  this->info = _orig_engine_info[_engine_offsets[type] + base];
107 
108  /* Copy the original engine data for this slot */
109  switch (type) {
110  default: NOT_REACHED();
111 
112  case VEH_TRAIN:
113  this->u.rail = _orig_rail_vehicle_info[base];
114  this->original_image_index = this->u.rail.image_index;
115  this->info.string_id = STR_VEHICLE_NAME_TRAIN_ENGINE_RAIL_KIRBY_PAUL_TANK_STEAM + base;
116 
117  /* Set the default model life of original wagons to "infinite" */
118  if (this->u.rail.railveh_type == RAILVEH_WAGON) this->info.base_life = 0xFF;
119 
120  break;
121 
122  case VEH_ROAD:
123  this->u.road = _orig_road_vehicle_info[base];
124  this->original_image_index = this->u.road.image_index;
125  this->info.string_id = STR_VEHICLE_NAME_ROAD_VEHICLE_MPS_REGAL_BUS + base;
126  break;
127 
128  case VEH_SHIP:
129  this->u.ship = _orig_ship_vehicle_info[base];
130  this->original_image_index = this->u.ship.image_index;
131  this->info.string_id = STR_VEHICLE_NAME_SHIP_MPS_OIL_TANKER + base;
132  break;
133 
134  case VEH_AIRCRAFT:
135  this->u.air = _orig_aircraft_vehicle_info[base];
136  this->original_image_index = this->u.air.image_index;
137  this->info.string_id = STR_VEHICLE_NAME_AIRCRAFT_SAMPSON_U52 + base;
138  break;
139  }
140 }
141 
142 Engine::~Engine()
143 {
144  UnloadWagonOverrides(this);
145  free(this->name);
146 }
147 
152 bool Engine::IsEnabled() const
153 {
154  return this->info.string_id != STR_NEWGRF_INVALID_ENGINE && HasBit(this->info.climates, _settings_game.game_creation.landscape);
155 }
156 
162 uint32 Engine::GetGRFID() const
163 {
164  const GRFFile *file = this->GetGRF();
165  return file == NULL ? 0 : file->grfid;
166 }
167 
174 {
175  /* For engines that can appear in a consist (i.e. rail vehicles and (articulated) road vehicles), a capacity
176  * of zero is a special case, to define the vehicle to not carry anything. The default cargotype is still used
177  * for livery selection etc.
178  * Note: Only the property is tested. A capacity callback returning 0 does not have the same effect.
179  */
180  switch (this->type) {
181  case VEH_TRAIN:
182  if (this->u.rail.capacity == 0) return false;
183  break;
184 
185  case VEH_ROAD:
186  if (this->u.road.capacity == 0) return false;
187  break;
188 
189  case VEH_SHIP:
190  case VEH_AIRCRAFT:
191  break;
192 
193  default: NOT_REACHED();
194  }
195  return this->GetDefaultCargoType() != CT_INVALID;
196 }
197 
198 
206 uint Engine::DetermineCapacity(const Vehicle *v, uint16 *mail_capacity) const
207 {
208  assert(v == NULL || this->index == v->engine_type);
209  if (mail_capacity != NULL) *mail_capacity = 0;
210 
211  if (!this->CanCarryCargo()) return 0;
212 
213  bool new_multipliers = HasBit(this->info.misc_flags, EF_NO_DEFAULT_CARGO_MULTIPLIER);
214  CargoID default_cargo = this->GetDefaultCargoType();
215  CargoID cargo_type = (v != NULL) ? v->cargo_type : default_cargo;
216 
217  if (mail_capacity != NULL && this->type == VEH_AIRCRAFT && IsCargoInClass(cargo_type, CC_PASSENGERS)) {
218  *mail_capacity = GetEngineProperty(this->index, PROP_AIRCRAFT_MAIL_CAPACITY, this->u.air.mail_capacity, v);
219  }
220 
221  /* Check the refit capacity callback if we are not in the default configuration, or if we are using the new multiplier algorithm. */
223  (new_multipliers || default_cargo != cargo_type || (v != NULL && v->cargo_subtype != 0))) {
224  uint16 callback = GetVehicleCallback(CBID_VEHICLE_REFIT_CAPACITY, 0, 0, this->index, v);
225  if (callback != CALLBACK_FAILED) return callback;
226  }
227 
228  /* Get capacity according to property resp. CB */
229  uint capacity;
230  uint extra_mail_cap = 0;
231  switch (this->type) {
232  case VEH_TRAIN:
233  capacity = GetEngineProperty(this->index, PROP_TRAIN_CARGO_CAPACITY, this->u.rail.capacity, v);
234 
235  /* In purchase list add the capacity of the second head. Always use the plain property for this. */
236  if (v == NULL && this->u.rail.railveh_type == RAILVEH_MULTIHEAD) capacity += this->u.rail.capacity;
237  break;
238 
239  case VEH_ROAD:
240  capacity = GetEngineProperty(this->index, PROP_ROADVEH_CARGO_CAPACITY, this->u.road.capacity, v);
241  break;
242 
243  case VEH_SHIP:
244  capacity = GetEngineProperty(this->index, PROP_SHIP_CARGO_CAPACITY, this->u.ship.capacity, v);
245  break;
246 
247  case VEH_AIRCRAFT:
248  capacity = GetEngineProperty(this->index, PROP_AIRCRAFT_PASSENGER_CAPACITY, this->u.air.passenger_capacity, v);
249  if (!IsCargoInClass(cargo_type, CC_PASSENGERS)) {
250  extra_mail_cap = GetEngineProperty(this->index, PROP_AIRCRAFT_MAIL_CAPACITY, this->u.air.mail_capacity, v);
251  }
252  if (!new_multipliers && cargo_type == CT_MAIL) return capacity + extra_mail_cap;
253  default_cargo = CT_PASSENGERS; // Always use 'passengers' wrt. cargo multipliers
254  break;
255 
256  default: NOT_REACHED();
257  }
258 
259  if (!new_multipliers) {
260  /* Use the passenger multiplier for mail as well */
261  capacity += extra_mail_cap;
262  extra_mail_cap = 0;
263  }
264 
265  /* Apply multipliers depending on cargo- and vehicletype. */
266  if (new_multipliers || (this->type != VEH_SHIP && default_cargo != cargo_type)) {
267  uint16 default_multiplier = new_multipliers ? 0x100 : CargoSpec::Get(default_cargo)->multiplier;
268  uint16 cargo_multiplier = CargoSpec::Get(cargo_type)->multiplier;
269  capacity *= cargo_multiplier;
270  if (extra_mail_cap > 0) {
271  uint mail_multiplier = CargoSpec::Get(CT_MAIL)->multiplier;
272  capacity += (default_multiplier * extra_mail_cap * cargo_multiplier + mail_multiplier / 2) / mail_multiplier;
273  }
274  capacity = (capacity + default_multiplier / 2) / default_multiplier;
275  }
276 
277  return capacity;
278 }
279 
285 {
286  Price base_price;
287  uint cost_factor;
288  switch (this->type) {
289  case VEH_ROAD:
290  base_price = this->u.road.running_cost_class;
291  if (base_price == INVALID_PRICE) return 0;
292  cost_factor = GetEngineProperty(this->index, PROP_ROADVEH_RUNNING_COST_FACTOR, this->u.road.running_cost);
293  break;
294 
295  case VEH_TRAIN:
296  base_price = this->u.rail.running_cost_class;
297  if (base_price == INVALID_PRICE) return 0;
298  cost_factor = GetEngineProperty(this->index, PROP_TRAIN_RUNNING_COST_FACTOR, this->u.rail.running_cost);
299  break;
300 
301  case VEH_SHIP:
302  base_price = PR_RUNNING_SHIP;
303  cost_factor = GetEngineProperty(this->index, PROP_SHIP_RUNNING_COST_FACTOR, this->u.ship.running_cost);
304  break;
305 
306  case VEH_AIRCRAFT:
307  base_price = PR_RUNNING_AIRCRAFT;
308  cost_factor = GetEngineProperty(this->index, PROP_AIRCRAFT_RUNNING_COST_FACTOR, this->u.air.running_cost);
309  break;
310 
311  default: NOT_REACHED();
312  }
313 
314  return GetPrice(base_price, cost_factor, this->GetGRF(), -8);
315 }
316 
322 {
323  Price base_price;
324  uint cost_factor;
325  switch (this->type) {
326  case VEH_ROAD:
327  base_price = PR_BUILD_VEHICLE_ROAD;
328  cost_factor = GetEngineProperty(this->index, PROP_ROADVEH_COST_FACTOR, this->u.road.cost_factor);
329  break;
330 
331  case VEH_TRAIN:
332  if (this->u.rail.railveh_type == RAILVEH_WAGON) {
333  base_price = PR_BUILD_VEHICLE_WAGON;
334  cost_factor = GetEngineProperty(this->index, PROP_TRAIN_COST_FACTOR, this->u.rail.cost_factor);
335  } else {
336  base_price = PR_BUILD_VEHICLE_TRAIN;
337  cost_factor = GetEngineProperty(this->index, PROP_TRAIN_COST_FACTOR, this->u.rail.cost_factor);
338  }
339  break;
340 
341  case VEH_SHIP:
342  base_price = PR_BUILD_VEHICLE_SHIP;
343  cost_factor = GetEngineProperty(this->index, PROP_SHIP_COST_FACTOR, this->u.ship.cost_factor);
344  break;
345 
346  case VEH_AIRCRAFT:
347  base_price = PR_BUILD_VEHICLE_AIRCRAFT;
348  cost_factor = GetEngineProperty(this->index, PROP_AIRCRAFT_COST_FACTOR, this->u.air.cost_factor);
349  break;
350 
351  default: NOT_REACHED();
352  }
353 
354  return GetPrice(base_price, cost_factor, this->GetGRF(), -8);
355 }
356 
362 {
363  switch (this->type) {
364  case VEH_TRAIN:
365  return GetEngineProperty(this->index, PROP_TRAIN_SPEED, this->u.rail.max_speed);
366 
367  case VEH_ROAD: {
368  uint max_speed = GetEngineProperty(this->index, PROP_ROADVEH_SPEED, 0);
369  return (max_speed != 0) ? max_speed * 2 : this->u.road.max_speed / 2;
370  }
371 
372  case VEH_SHIP:
373  return GetEngineProperty(this->index, PROP_SHIP_SPEED, this->u.ship.max_speed) / 2;
374 
375  case VEH_AIRCRAFT: {
376  uint max_speed = GetEngineProperty(this->index, PROP_AIRCRAFT_SPEED, 0);
377  if (max_speed != 0) {
378  return (max_speed * 128) / 10;
379  }
380  return this->u.air.max_speed;
381  }
382 
383  default: NOT_REACHED();
384  }
385 }
386 
393 uint Engine::GetPower() const
394 {
395  /* Only trains and road vehicles have 'power'. */
396  switch (this->type) {
397  case VEH_TRAIN:
398  return GetEngineProperty(this->index, PROP_TRAIN_POWER, this->u.rail.power);
399  case VEH_ROAD:
400  return GetEngineProperty(this->index, PROP_ROADVEH_POWER, this->u.road.power) * 10;
401 
402  default: NOT_REACHED();
403  }
404 }
405 
412 {
413  /* Only trains and road vehicles have 'weight'. */
414  switch (this->type) {
415  case VEH_TRAIN:
416  return GetEngineProperty(this->index, PROP_TRAIN_WEIGHT, this->u.rail.weight) << (this->u.rail.railveh_type == RAILVEH_MULTIHEAD ? 1 : 0);
417  case VEH_ROAD:
418  return GetEngineProperty(this->index, PROP_ROADVEH_WEIGHT, this->u.road.weight) / 4;
419 
420  default: NOT_REACHED();
421  }
422 }
423 
430 {
431  /* Only trains and road vehicles have 'tractive effort'. */
432  switch (this->type) {
433  case VEH_TRAIN:
434  return (10 * this->GetDisplayWeight() * GetEngineProperty(this->index, PROP_TRAIN_TRACTIVE_EFFORT, this->u.rail.tractive_effort)) / 256;
435  case VEH_ROAD:
436  return (10 * this->GetDisplayWeight() * GetEngineProperty(this->index, PROP_ROADVEH_TRACTIVE_EFFORT, this->u.road.tractive_effort)) / 256;
437 
438  default: NOT_REACHED();
439  }
440 }
441 
447 {
448  /* Assume leap years; this gives the player a bit more than the given amount of years, but never less. */
450 }
451 
456 uint16 Engine::GetRange() const
457 {
458  switch (this->type) {
459  case VEH_AIRCRAFT:
460  return GetEngineProperty(this->index, PROP_AIRCRAFT_RANGE, this->u.air.max_range);
461 
462  default: NOT_REACHED();
463  }
464 }
465 
471 {
472  switch (this->type) {
473  case VEH_AIRCRAFT:
474  switch (this->u.air.subtype) {
475  case AIR_HELI: return STR_LIVERY_HELICOPTER;
476  case AIR_CTOL: return STR_LIVERY_SMALL_PLANE;
477  case AIR_CTOL | AIR_FAST: return STR_LIVERY_LARGE_PLANE;
478  default: NOT_REACHED();
479  }
480 
481  default: NOT_REACHED();
482  }
483 }
484 
489 {
490  this->Clear();
491  for (VehicleType type = VEH_TRAIN; type <= VEH_AIRCRAFT; type++) {
492  for (uint internal_id = 0; internal_id < _engine_counts[type]; internal_id++) {
493  EngineIDMapping *eid = this->Append();
494  eid->type = type;
495  eid->grfid = INVALID_GRFID;
496  eid->internal_id = internal_id;
497  eid->substitute_id = internal_id;
498  }
499  }
500 }
501 
511 EngineID EngineOverrideManager::GetID(VehicleType type, uint16 grf_local_id, uint32 grfid)
512 {
513  const EngineIDMapping *end = this->End();
514  EngineID index = 0;
515  for (const EngineIDMapping *eid = this->Begin(); eid != end; eid++, index++) {
516  if (eid->type == type && eid->grfid == grfid && eid->internal_id == grf_local_id) {
517  return index;
518  }
519  }
520  return INVALID_ENGINE;
521 }
522 
529 {
530  const Vehicle *v;
531  FOR_ALL_VEHICLES(v) {
532  if (IsCompanyBuildableVehicleType(v)) return false;
533  }
534 
535  /* Reset the engines, they will get new EngineIDs */
536  _engine_mngr.ResetToDefaultMapping();
538 
539  return true;
540 }
541 
546 {
548  _engine_pool.CleanPool();
549 
550  assert(_engine_mngr.Length() >= _engine_mngr.NUM_DEFAULT_ENGINES);
551  const EngineIDMapping *end = _engine_mngr.End();
552  uint index = 0;
553  for (const EngineIDMapping *eid = _engine_mngr.Begin(); eid != end; eid++, index++) {
554  /* Assert is safe; there won't be more than 256 original vehicles
555  * in any case, and we just cleaned the pool. */
556  assert(Engine::CanAllocateItem());
557  const Engine *e = new Engine(eid->type, eid->internal_id);
558  assert(e->index == index);
559  }
560 }
561 
562 void ShowEnginePreviewWindow(EngineID engine);
563 
569 static bool IsWagon(EngineID index)
570 {
571  const Engine *e = Engine::Get(index);
572  return e->type == VEH_TRAIN && e->u.rail.railveh_type == RAILVEH_WAGON;
573 }
574 
580 {
581  uint age = e->age;
582 
583  /* Check for early retirement */
584  if (e->company_avail != 0 && !_settings_game.vehicle.never_expire_vehicles && e->info.base_life != 0xFF) {
585  int retire_early = e->info.retire_early;
586  uint retire_early_max_age = max(0, e->duration_phase_1 + e->duration_phase_2 - retire_early * 12);
587  if (retire_early != 0 && age >= retire_early_max_age) {
588  /* Early retirement is enabled and we're past the date... */
589  e->company_avail = 0;
591  }
592  }
593 
594  if (age < e->duration_phase_1) {
595  uint start = e->reliability_start;
596  e->reliability = age * (e->reliability_max - start) / e->duration_phase_1 + start;
597  } else if ((age -= e->duration_phase_1) < e->duration_phase_2 || _settings_game.vehicle.never_expire_vehicles || e->info.base_life == 0xFF) {
598  /* We are at the peak of this engines life. It will have max reliability.
599  * This is also true if the engines never expire. They will not go bad over time */
601  } else if ((age -= e->duration_phase_2) < e->duration_phase_3) {
602  uint max = e->reliability_max;
603  e->reliability = (int)age * (int)(e->reliability_final - max) / e->duration_phase_3 + max;
604  } else {
605  /* time's up for this engine.
606  * We will now completely retire this design */
607  e->company_avail = 0;
609  /* Kick this engine out of the lists */
611  }
612  SetWindowClassesDirty(WC_BUILD_VEHICLE); // Update to show the new reliability
614 }
615 
618 {
619  /* Determine last engine aging year, default to 2050 as previously. */
621 
622  const Engine *e;
623  FOR_ALL_ENGINES(e) {
624  const EngineInfo *ei = &e->info;
625 
626  /* Exclude certain engines */
628  if (e->type == VEH_TRAIN && e->u.rail.railveh_type == RAILVEH_WAGON) continue;
629 
630  /* Base year ending date on half the model life */
631  YearMonthDay ymd;
632  ConvertDateToYMD(ei->base_intro + (ei->lifelength * DAYS_IN_LEAP_YEAR) / 2, &ymd);
633 
635  }
636 }
637 
643 void StartupOneEngine(Engine *e, Date aging_date)
644 {
645  const EngineInfo *ei = &e->info;
646 
647  e->age = 0;
648  e->flags = 0;
649  e->company_avail = 0;
650  e->company_hidden = 0;
651 
652  /* Don't randomise the start-date in the first two years after gamestart to ensure availability
653  * of engines in early starting games.
654  * Note: TTDP uses fixed 1922 */
655  uint32 r = Random();
657  if (e->intro_date <= _date) {
658  e->age = (aging_date - e->intro_date) >> 5;
659  e->company_avail = (CompanyMask)-1;
660  e->flags |= ENGINE_AVAILABLE;
661  }
662 
663  e->reliability_start = GB(r, 16, 14) + 0x7AE0;
664  r = Random();
665  e->reliability_max = GB(r, 0, 14) + 0xBFFF;
666  e->reliability_final = GB(r, 16, 14) + 0x3FFF;
667 
668  r = Random();
669  e->duration_phase_1 = GB(r, 0, 5) + 7;
670  e->duration_phase_2 = GB(r, 5, 4) + ei->base_life * 12 - 96;
671  e->duration_phase_3 = GB(r, 9, 7) + 120;
672 
673  e->reliability_spd_dec = ei->decay_speed << 2;
674 
676 
677  /* prevent certain engines from ever appearing. */
679  e->flags |= ENGINE_AVAILABLE;
680  e->company_avail = 0;
681  }
682 }
683 
689 {
690  Engine *e;
691  /* Aging of vehicles stops, so account for that when starting late */
692  const Date aging_date = min(_date, ConvertYMDToDate(_year_engine_aging_stops, 0, 1));
693 
694  FOR_ALL_ENGINES(e) {
695  StartupOneEngine(e, aging_date);
696  }
697 
698  /* Update the bitmasks for the vehicle lists */
699  Company *c;
700  FOR_ALL_COMPANIES(c) {
703  }
704 
705  /* Invalidate any open purchase lists */
707 }
708 
714 static void AcceptEnginePreview(EngineID eid, CompanyID company)
715 {
716  Engine *e = Engine::Get(eid);
717  Company *c = Company::Get(company);
718 
719  SetBit(e->company_avail, company);
720  if (e->type == VEH_TRAIN) {
721  assert(e->u.rail.railtype < RAILTYPE_END);
723  } else if (e->type == VEH_ROAD) {
725  }
726 
728  e->preview_asked = (CompanyMask)-1;
729  if (company == _local_company) {
731  }
732 
733  /* Update the toolbar. */
736 
737  /* Notify preview window, that it might want to close.
738  * Note: We cannot directly close the window.
739  * In singleplayer this function is called from the preview window, so
740  * we have to use the GUI-scope scheduling of InvalidateWindowData.
741  */
743 }
744 
751 {
752  CompanyID best_company = INVALID_COMPANY;
753 
754  /* For trains the cargomask has no useful meaning, since you can attach other wagons */
755  uint32 cargomask = e->type != VEH_TRAIN ? GetUnionOfArticulatedRefitMasks(e->index, true) : (uint32)-1;
756 
757  int32 best_hist = -1;
758  const Company *c;
759  FOR_ALL_COMPANIES(c) {
760  if (c->block_preview == 0 && !HasBit(e->preview_asked, c->index) &&
761  c->old_economy[0].performance_history > best_hist) {
762 
763  /* Check whether the company uses similar vehicles */
764  Vehicle *v;
765  FOR_ALL_VEHICLES(v) {
766  if (v->owner != c->index || v->type != e->type) continue;
767  if (!v->GetEngine()->CanCarryCargo() || !HasBit(cargomask, v->cargo_type)) continue;
768 
769  best_hist = c->old_economy[0].performance_history;
770  best_company = c->index;
771  break;
772  }
773  }
774  }
775 
776  return best_company;
777 }
778 
786 static bool IsVehicleTypeDisabled(VehicleType type, bool ai)
787 {
788  switch (type) {
793 
794  default: NOT_REACHED();
795  }
796 }
797 
800 {
801  Company *c;
802  FOR_ALL_COMPANIES(c) {
804  }
805 
806  if (_cur_year >= _year_engine_aging_stops) return;
807 
808  Engine *e;
809  FOR_ALL_ENGINES(e) {
810  EngineID i = e->index;
811  if (e->flags & ENGINE_EXCLUSIVE_PREVIEW) {
812  if (e->preview_company != INVALID_COMPANY) {
813  if (!--e->preview_wait) {
816  }
817  } else if (CountBits(e->preview_asked) < MAX_COMPANIES) {
819 
820  if (e->preview_company == INVALID_COMPANY) {
821  e->preview_asked = (CompanyMask)-1;
822  continue;
823  }
824 
826  e->preview_wait = 20;
827  /* AIs are intentionally not skipped for preview even if they cannot build a certain
828  * vehicle type. This is done to not give poor performing human companies an "unfair"
829  * boost that they wouldn't have gotten against other human companies. The check on
830  * the line below is just to make AIs not notice that they have a preview if they
831  * cannot build the vehicle. */
832  if (!IsVehicleTypeDisabled(e->type, true)) AI::NewEvent(e->preview_company, new ScriptEventEnginePreview(i));
833  if (IsInteractiveCompany(e->preview_company)) ShowEnginePreviewWindow(i);
834  }
835  }
836  }
837 }
838 
844 {
845  Engine *e;
846  FOR_ALL_ENGINES(e) {
847  SB(e->company_hidden, cid, 1, 0);
848  }
849 }
850 
860 CommandCost CmdSetVehicleVisibility(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
861 {
862  Engine *e = Engine::GetIfValid(GB(p2, 0, 31));
863  if (e == NULL || _current_company >= MAX_COMPANIES) return CMD_ERROR;
864  if (!IsEngineBuildable(e->index, e->type, _current_company)) return CMD_ERROR;
865 
866  if ((flags & DC_EXEC) != 0) {
867  SB(e->company_hidden, _current_company, 1, GB(p2, 31, 1));
869  }
870 
871  return CommandCost();
872 }
873 
884 CommandCost CmdWantEnginePreview(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
885 {
886  Engine *e = Engine::GetIfValid(p1);
887  if (e == NULL || !(e->flags & ENGINE_EXCLUSIVE_PREVIEW) || e->preview_company != _current_company) return CMD_ERROR;
888 
889  if (flags & DC_EXEC) AcceptEnginePreview(p1, _current_company);
890 
891  return CommandCost();
892 }
893 
900 {
901  Vehicle *v;
902  Company *c;
903  EngineID index = e->index;
904 
905  /* In case the company didn't build the vehicle during the intro period,
906  * prevent that company from getting future intro periods for a while. */
907  if (e->flags & ENGINE_EXCLUSIVE_PREVIEW) {
908  FOR_ALL_COMPANIES(c) {
909  uint block_preview = c->block_preview;
910 
911  if (!HasBit(e->company_avail, c->index)) continue;
912 
913  /* We assume the user did NOT build it.. prove me wrong ;) */
914  c->block_preview = 20;
915 
916  FOR_ALL_VEHICLES(v) {
917  if (v->type == VEH_TRAIN || v->type == VEH_ROAD || v->type == VEH_SHIP ||
919  if (v->owner == c->index && v->engine_type == index) {
920  /* The user did prove me wrong, so restore old value */
921  c->block_preview = block_preview;
922  break;
923  }
924  }
925  }
926  }
927  }
928 
931 
932  /* Now available for all companies */
933  e->company_avail = (CompanyMask)-1;
934 
935  /* Do not introduce new rail wagons */
936  if (IsWagon(index)) return;
937 
938  if (e->type == VEH_TRAIN) {
939  /* maybe make another rail type available */
940  RailType railtype = e->u.rail.railtype;
941  assert(railtype < RAILTYPE_END);
942  FOR_ALL_COMPANIES(c) c->avail_railtypes = AddDateIntroducedRailTypes(c->avail_railtypes | GetRailTypeInfo(e->u.rail.railtype)->introduces_railtypes, _date);
943  } else if (e->type == VEH_ROAD) {
944  /* maybe make another road type available */
945  FOR_ALL_COMPANIES(c) SetBit(c->avail_roadtypes, HasBit(e->info.misc_flags, EF_ROAD_TRAM) ? ROADTYPE_TRAM : ROADTYPE_ROAD);
946  }
947 
948  /* Only broadcast event if AIs are able to build this vehicle type. */
949  if (!IsVehicleTypeDisabled(e->type, true)) AI::BroadcastNewEvent(new ScriptEventEngineAvailable(index));
950 
951  /* Only provide the "New Vehicle available" news paper entry, if engine can be built. */
952  if (!IsVehicleTypeDisabled(e->type, false)) {
953  SetDParam(0, GetEngineCategoryName(index));
954  SetDParam(1, index);
955  AddNewsItem(STR_NEWS_NEW_VEHICLE_NOW_AVAILABLE_WITH_TYPE, NT_NEW_VEHICLES, NF_VEHICLE, NR_ENGINE, index);
956  }
957 
958  /* Update the toolbar. */
961 
962  /* Close pending preview windows */
964 }
965 
968 {
970  Engine *e;
971  FOR_ALL_ENGINES(e) {
972  /* Age the vehicle */
973  if ((e->flags & ENGINE_AVAILABLE) && e->age != MAX_DAY) {
974  e->age++;
976  }
977 
978  /* Do not introduce invalid engines */
979  if (!e->IsEnabled()) continue;
980 
981  if (!(e->flags & ENGINE_AVAILABLE) && _date >= (e->intro_date + DAYS_IN_YEAR)) {
982  /* Introduce it to all companies */
984  } else if (!(e->flags & (ENGINE_AVAILABLE | ENGINE_EXCLUSIVE_PREVIEW)) && _date >= e->intro_date) {
985  /* Introduction date has passed...
986  * Check if it is allowed to build this vehicle type at all
987  * based on the current game settings. If not, it does not
988  * make sense to show the preview dialog to any company. */
989  if (IsVehicleTypeDisabled(e->type, false)) continue;
990 
991  /* Do not introduce new rail wagons */
992  if (IsWagon(e->index)) continue;
993 
994  /* Show preview dialog to one of the companies. */
997  e->preview_asked = 0;
998  }
999  }
1000 
1001  InvalidateWindowClassesData(WC_BUILD_VEHICLE); // rebuild the purchase list (esp. when sorted by reliability)
1002  }
1003 }
1004 
1010 static bool IsUniqueEngineName(const char *name)
1011 {
1012  const Engine *e;
1013 
1014  FOR_ALL_ENGINES(e) {
1015  if (e->name != NULL && strcmp(e->name, name) == 0) return false;
1016  }
1017 
1018  return true;
1019 }
1020 
1030 CommandCost CmdRenameEngine(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
1031 {
1032  Engine *e = Engine::GetIfValid(p1);
1033  if (e == NULL) return CMD_ERROR;
1034 
1035  bool reset = StrEmpty(text);
1036 
1037  if (!reset) {
1039  if (!IsUniqueEngineName(text)) return_cmd_error(STR_ERROR_NAME_MUST_BE_UNIQUE);
1040  }
1041 
1042  if (flags & DC_EXEC) {
1043  free(e->name);
1044 
1045  if (reset) {
1046  e->name = NULL;
1047  } else {
1048  e->name = stredup(text);
1049  }
1050 
1052  }
1053 
1054  return CommandCost();
1055 }
1056 
1057 
1067 {
1068  const Engine *e = Engine::GetIfValid(engine);
1069 
1070  /* check if it's an engine that is in the engine array */
1071  if (e == NULL) return false;
1072 
1073  /* check if it's an engine of specified type */
1074  if (e->type != type) return false;
1075 
1076  /* check if it's available ... */
1077  if (company == OWNER_DEITY) {
1078  /* ... for any company (preview does not count) */
1079  if (!(e->flags & ENGINE_AVAILABLE) || e->company_avail == 0) return false;
1080  } else {
1081  /* ... for this company */
1082  if (!HasBit(e->company_avail, company)) return false;
1083  }
1084 
1085  if (!e->IsEnabled()) return false;
1086 
1087  if (type == VEH_TRAIN && company != OWNER_DEITY) {
1088  /* Check if the rail type is available to this company */
1089  const Company *c = Company::Get(company);
1090  if (((GetRailTypeInfo(e->u.rail.railtype))->compatible_railtypes & c->avail_railtypes) == 0) return false;
1091  }
1092 
1093  return true;
1094 }
1095 
1103 {
1104  const Engine *e = Engine::GetIfValid(engine);
1105 
1106  /* check if it's an engine that is in the engine array */
1107  if (e == NULL) return false;
1108 
1109  if (!e->CanCarryCargo()) return false;
1110 
1111  const EngineInfo *ei = &e->info;
1112  if (ei->refit_mask == 0) return false;
1113 
1114  /* Are there suffixes?
1115  * Note: This does not mean the suffixes are actually available for every consist at any time. */
1116  if (HasBit(ei->callback_mask, CBM_VEHICLE_CARGO_SUFFIX)) return true;
1117 
1118  /* Is there any cargo except the default cargo? */
1119  CargoID default_cargo = e->GetDefaultCargoType();
1120  return default_cargo != CT_INVALID && ei->refit_mask != 1U << default_cargo;
1121 }
1122 
1127 {
1128  const Engine *e;
1129  Date min_date = INT32_MAX;
1130 
1131  FOR_ALL_ENGINES(e) {
1132  if (!e->IsEnabled()) continue;
1133 
1134  /* We have an available engine... yay! */
1135  if ((e->flags & ENGINE_AVAILABLE) != 0 && e->company_avail != 0) return;
1136 
1137  /* Okay, try to find the earliest date. */
1138  min_date = min(min_date, e->info.base_intro);
1139  }
1140 
1141  if (min_date < INT32_MAX) {
1142  SetDParam(0, min_date);
1143  ShowErrorMessage(STR_ERROR_NO_VEHICLES_AVAILABLE_YET, STR_ERROR_NO_VEHICLES_AVAILABLE_YET_EXPLANATION, WL_WARNING);
1144  } else {
1145  ShowErrorMessage(STR_ERROR_NO_VEHICLES_AVAILABLE_AT_ALL, STR_ERROR_NO_VEHICLES_AVAILABLE_AT_ALL_EXPLANATION, WL_WARNING);
1146  }
1147 }