OpenTTD Source  20241108-master-g80f628063a
engine.cpp
Go to the documentation of this file.
1 /*
2  * This file is part of OpenTTD.
3  * 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.
4  * 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.
5  * 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/>.
6  */
7 
10 #include "stdafx.h"
11 #include "company_func.h"
12 #include "command_func.h"
13 #include "news_func.h"
14 #include "aircraft.h"
15 #include "newgrf.h"
16 #include "newgrf_engine.h"
17 #include "strings_func.h"
18 #include "core/random_func.hpp"
19 #include "window_func.h"
20 #include "autoreplace_gui.h"
21 #include "string_func.h"
22 #include "ai/ai.hpp"
23 #include "core/pool_func.hpp"
24 #include "engine_gui.h"
25 #include "engine_func.h"
26 #include "engine_base.h"
27 #include "company_base.h"
28 #include "vehicle_func.h"
29 #include "articulated_vehicles.h"
30 #include "error.h"
31 #include "engine_base.h"
32 #include "timer/timer.h"
33 #include "timer/timer_game_tick.h"
35 
36 #include "table/strings.h"
37 #include "table/engines.h"
38 
39 #include "safeguards.h"
40 
41 EnginePool _engine_pool("Engine");
43 
44 EngineOverrideManager _engine_mngr;
45 
51 
53 const uint8_t _engine_counts[4] = {
54  lengthof(_orig_rail_vehicle_info),
55  lengthof(_orig_road_vehicle_info),
56  lengthof(_orig_ship_vehicle_info),
57  lengthof(_orig_aircraft_vehicle_info),
58 };
59 
61 const uint8_t _engine_offsets[4] = {
62  0,
63  lengthof(_orig_rail_vehicle_info),
64  lengthof(_orig_rail_vehicle_info) + lengthof(_orig_road_vehicle_info),
65  lengthof(_orig_rail_vehicle_info) + lengthof(_orig_road_vehicle_info) + lengthof(_orig_ship_vehicle_info),
66 };
67 
68 static_assert(lengthof(_orig_rail_vehicle_info) + lengthof(_orig_road_vehicle_info) + lengthof(_orig_ship_vehicle_info) + lengthof(_orig_aircraft_vehicle_info) == lengthof(_orig_engine_info));
69 
71 
72 Engine::Engine(VehicleType type, EngineID base)
73 {
74  this->type = type;
75  this->grf_prop.local_id = base;
76  this->list_position = base;
79 
80  /* Check if this base engine is within the original engine data range */
81  if (base >= _engine_counts[type]) {
82  /* 'power' defaults to zero, so we also have to default to 'wagon' */
83  if (type == VEH_TRAIN) this->u.rail.railveh_type = RAILVEH_WAGON;
84  /* Set model life to maximum to make wagons available */
85  this->info.base_life = 0xFF;
86  /* Set road vehicle tractive effort to the default value */
87  if (type == VEH_ROAD) this->u.road.tractive_effort = 0x4C;
88  /* Aircraft must have INVALID_CARGO as default, as there is no property */
89  if (type == VEH_AIRCRAFT) this->info.cargo_type = INVALID_CARGO;
90  /* Ships must have a non-zero acceleration. */
91  if (type == VEH_SHIP) this->u.ship.acceleration = 1;
92  /* Set visual effect to the default value */
93  switch (type) {
94  case VEH_TRAIN: this->u.rail.visual_effect = VE_DEFAULT; break;
95  case VEH_ROAD: this->u.road.visual_effect = VE_DEFAULT; break;
96  case VEH_SHIP: this->u.ship.visual_effect = VE_DEFAULT; break;
97  default: break; // The aircraft, disasters and especially visual effects have no NewGRF configured visual effects
98  }
99  /* Set cargo aging period to the default value. */
101  /* Not a variant */
102  this->info.variant_id = INVALID_ENGINE;
103  return;
104  }
105 
106  /* Copy the original engine info for this slot */
107  this->info = _orig_engine_info[_engine_offsets[type] + base];
108 
109  /* Copy the original engine data for this slot */
110  switch (type) {
111  default: NOT_REACHED();
112 
113  case VEH_TRAIN:
114  this->u.rail = _orig_rail_vehicle_info[base];
115  this->original_image_index = this->u.rail.image_index;
116  this->info.string_id = STR_VEHICLE_NAME_TRAIN_ENGINE_RAIL_KIRBY_PAUL_TANK_STEAM + base;
117 
118  /* Set the default model life of original wagons to "infinite" */
119  if (this->u.rail.railveh_type == RAILVEH_WAGON) this->info.base_life = 0xFF;
120 
121  break;
122 
123  case VEH_ROAD:
124  this->u.road = _orig_road_vehicle_info[base];
125  this->original_image_index = this->u.road.image_index;
126  this->info.string_id = STR_VEHICLE_NAME_ROAD_VEHICLE_MPS_REGAL_BUS + base;
127  break;
128 
129  case VEH_SHIP:
130  this->u.ship = _orig_ship_vehicle_info[base];
131  this->original_image_index = this->u.ship.image_index;
132  this->info.string_id = STR_VEHICLE_NAME_SHIP_MPS_OIL_TANKER + base;
133  break;
134 
135  case VEH_AIRCRAFT:
136  this->u.air = _orig_aircraft_vehicle_info[base];
137  this->original_image_index = this->u.air.image_index;
138  this->info.string_id = STR_VEHICLE_NAME_AIRCRAFT_SAMPSON_U52 + base;
139  break;
140  }
141 }
142 
147 bool Engine::IsEnabled() const
148 {
149  return this->info.string_id != STR_NEWGRF_INVALID_ENGINE && HasBit(this->info.climates, _settings_game.game_creation.landscape);
150 }
151 
157 uint32_t Engine::GetGRFID() const
158 {
159  const GRFFile *file = this->GetGRF();
160  return file == nullptr ? 0 : file->grfid;
161 }
162 
169 {
170  /* For engines that can appear in a consist (i.e. rail vehicles and (articulated) road vehicles), a capacity
171  * of zero is a special case, to define the vehicle to not carry anything. The default cargotype is still used
172  * for livery selection etc.
173  * Note: Only the property is tested. A capacity callback returning 0 does not have the same effect.
174  */
175  switch (this->type) {
176  case VEH_TRAIN:
177  if (this->u.rail.capacity == 0) return false;
178  break;
179 
180  case VEH_ROAD:
181  if (this->u.road.capacity == 0) return false;
182  break;
183 
184  case VEH_SHIP:
185  case VEH_AIRCRAFT:
186  break;
187 
188  default: NOT_REACHED();
189  }
190  return IsValidCargoID(this->GetDefaultCargoType());
191 }
192 
193 
201 uint Engine::DetermineCapacity(const Vehicle *v, uint16_t *mail_capacity) const
202 {
203  assert(v == nullptr || this->index == v->engine_type);
204  if (mail_capacity != nullptr) *mail_capacity = 0;
205 
206  if (!this->CanCarryCargo()) return 0;
207 
208  bool new_multipliers = HasBit(this->info.misc_flags, EF_NO_DEFAULT_CARGO_MULTIPLIER);
209  CargoID default_cargo = this->GetDefaultCargoType();
210  CargoID cargo_type = (v != nullptr) ? v->cargo_type : default_cargo;
211 
212  if (mail_capacity != nullptr && this->type == VEH_AIRCRAFT && IsCargoInClass(cargo_type, CC_PASSENGERS)) {
213  *mail_capacity = GetEngineProperty(this->index, PROP_AIRCRAFT_MAIL_CAPACITY, this->u.air.mail_capacity, v);
214  }
215 
216  /* Check the refit capacity callback if we are not in the default configuration, or if we are using the new multiplier algorithm. */
218  (new_multipliers || default_cargo != cargo_type || (v != nullptr && v->cargo_subtype != 0))) {
219  uint16_t callback = GetVehicleCallback(CBID_VEHICLE_REFIT_CAPACITY, 0, 0, this->index, v);
220  if (callback != CALLBACK_FAILED) return callback;
221  }
222 
223  /* Get capacity according to property resp. CB */
224  uint capacity;
225  uint extra_mail_cap = 0;
226  switch (this->type) {
227  case VEH_TRAIN:
228  capacity = GetEngineProperty(this->index, PROP_TRAIN_CARGO_CAPACITY, this->u.rail.capacity, v);
229 
230  /* In purchase list add the capacity of the second head. Always use the plain property for this. */
231  if (v == nullptr && this->u.rail.railveh_type == RAILVEH_MULTIHEAD) capacity += this->u.rail.capacity;
232  break;
233 
234  case VEH_ROAD:
235  capacity = GetEngineProperty(this->index, PROP_ROADVEH_CARGO_CAPACITY, this->u.road.capacity, v);
236  break;
237 
238  case VEH_SHIP:
239  capacity = GetEngineProperty(this->index, PROP_SHIP_CARGO_CAPACITY, this->u.ship.capacity, v);
240  break;
241 
242  case VEH_AIRCRAFT:
243  capacity = GetEngineProperty(this->index, PROP_AIRCRAFT_PASSENGER_CAPACITY, this->u.air.passenger_capacity, v);
244  if (!IsCargoInClass(cargo_type, CC_PASSENGERS)) {
245  extra_mail_cap = GetEngineProperty(this->index, PROP_AIRCRAFT_MAIL_CAPACITY, this->u.air.mail_capacity, v);
246  }
247  if (IsValidCargoID(GetCargoIDByLabel(CT_MAIL))) {
248  if (!new_multipliers && cargo_type == GetCargoIDByLabel(CT_MAIL)) return capacity + extra_mail_cap;
249  }
250  default_cargo = GetCargoIDByLabel(CT_PASSENGERS); // Always use 'passengers' wrt. cargo multipliers
251  break;
252 
253  default: NOT_REACHED();
254  }
255 
256  if (!new_multipliers) {
257  /* Use the passenger multiplier for mail as well */
258  capacity += extra_mail_cap;
259  extra_mail_cap = 0;
260  }
261 
262  /* Apply multipliers depending on cargo- and vehicletype. */
263  if (new_multipliers || (this->type != VEH_SHIP && default_cargo != cargo_type)) {
264  uint16_t default_multiplier = new_multipliers ? 0x100 : CargoSpec::Get(default_cargo)->multiplier;
265  uint16_t cargo_multiplier = CargoSpec::Get(cargo_type)->multiplier;
266  capacity *= cargo_multiplier;
267  if (extra_mail_cap > 0 && IsValidCargoID(GetCargoIDByLabel(CT_MAIL))) {
268  uint mail_multiplier = CargoSpec::Get(GetCargoIDByLabel(CT_MAIL))->multiplier;
269  capacity += (default_multiplier * extra_mail_cap * cargo_multiplier + mail_multiplier / 2) / mail_multiplier;
270  }
271  capacity = (capacity + default_multiplier / 2) / default_multiplier;
272  }
273 
274  return capacity;
275 }
276 
282 {
283  Price base_price;
284  uint cost_factor;
285  switch (this->type) {
286  case VEH_ROAD:
287  base_price = this->u.road.running_cost_class;
288  if (base_price == INVALID_PRICE) return 0;
289  cost_factor = GetEngineProperty(this->index, PROP_ROADVEH_RUNNING_COST_FACTOR, this->u.road.running_cost);
290  break;
291 
292  case VEH_TRAIN:
293  base_price = this->u.rail.running_cost_class;
294  if (base_price == INVALID_PRICE) return 0;
295  cost_factor = GetEngineProperty(this->index, PROP_TRAIN_RUNNING_COST_FACTOR, this->u.rail.running_cost);
296  break;
297 
298  case VEH_SHIP:
299  base_price = PR_RUNNING_SHIP;
300  cost_factor = GetEngineProperty(this->index, PROP_SHIP_RUNNING_COST_FACTOR, this->u.ship.running_cost);
301  break;
302 
303  case VEH_AIRCRAFT:
304  base_price = PR_RUNNING_AIRCRAFT;
305  cost_factor = GetEngineProperty(this->index, PROP_AIRCRAFT_RUNNING_COST_FACTOR, this->u.air.running_cost);
306  break;
307 
308  default: NOT_REACHED();
309  }
310 
311  return GetPrice(base_price, cost_factor, this->GetGRF(), -8);
312 }
313 
319 {
320  Price base_price;
321  uint cost_factor;
322  switch (this->type) {
323  case VEH_ROAD:
324  base_price = PR_BUILD_VEHICLE_ROAD;
325  cost_factor = GetEngineProperty(this->index, PROP_ROADVEH_COST_FACTOR, this->u.road.cost_factor);
326  break;
327 
328  case VEH_TRAIN:
329  if (this->u.rail.railveh_type == RAILVEH_WAGON) {
330  base_price = PR_BUILD_VEHICLE_WAGON;
331  cost_factor = GetEngineProperty(this->index, PROP_TRAIN_COST_FACTOR, this->u.rail.cost_factor);
332  } else {
333  base_price = PR_BUILD_VEHICLE_TRAIN;
334  cost_factor = GetEngineProperty(this->index, PROP_TRAIN_COST_FACTOR, this->u.rail.cost_factor);
335  }
336  break;
337 
338  case VEH_SHIP:
339  base_price = PR_BUILD_VEHICLE_SHIP;
340  cost_factor = GetEngineProperty(this->index, PROP_SHIP_COST_FACTOR, this->u.ship.cost_factor);
341  break;
342 
343  case VEH_AIRCRAFT:
344  base_price = PR_BUILD_VEHICLE_AIRCRAFT;
345  cost_factor = GetEngineProperty(this->index, PROP_AIRCRAFT_COST_FACTOR, this->u.air.cost_factor);
346  break;
347 
348  default: NOT_REACHED();
349  }
350 
351  return GetPrice(base_price, cost_factor, this->GetGRF(), -8);
352 }
353 
359 {
360  switch (this->type) {
361  case VEH_TRAIN:
362  return GetEngineProperty(this->index, PROP_TRAIN_SPEED, this->u.rail.max_speed);
363 
364  case VEH_ROAD: {
365  uint max_speed = GetEngineProperty(this->index, PROP_ROADVEH_SPEED, 0);
366  return (max_speed != 0) ? max_speed * 2 : this->u.road.max_speed / 2;
367  }
368 
369  case VEH_SHIP:
370  return GetEngineProperty(this->index, PROP_SHIP_SPEED, this->u.ship.max_speed) / 2;
371 
372  case VEH_AIRCRAFT: {
373  uint max_speed = GetEngineProperty(this->index, PROP_AIRCRAFT_SPEED, 0);
374  if (max_speed != 0) {
375  return (max_speed * 128) / 10;
376  }
377  return this->u.air.max_speed;
378  }
379 
380  default: NOT_REACHED();
381  }
382 }
383 
390 uint Engine::GetPower() const
391 {
392  /* Only trains and road vehicles have 'power'. */
393  switch (this->type) {
394  case VEH_TRAIN:
395  return GetEngineProperty(this->index, PROP_TRAIN_POWER, this->u.rail.power);
396  case VEH_ROAD:
397  return GetEngineProperty(this->index, PROP_ROADVEH_POWER, this->u.road.power) * 10;
398 
399  default: NOT_REACHED();
400  }
401 }
402 
409 {
410  /* Only trains and road vehicles have 'weight'. */
411  switch (this->type) {
412  case VEH_TRAIN:
413  return GetEngineProperty(this->index, PROP_TRAIN_WEIGHT, this->u.rail.weight) << (this->u.rail.railveh_type == RAILVEH_MULTIHEAD ? 1 : 0);
414  case VEH_ROAD:
415  return GetEngineProperty(this->index, PROP_ROADVEH_WEIGHT, this->u.road.weight) / 4;
416 
417  default: NOT_REACHED();
418  }
419 }
420 
427 {
428  /* Only trains and road vehicles have 'tractive effort'. */
429  switch (this->type) {
430  case VEH_TRAIN:
431  return (GROUND_ACCELERATION * this->GetDisplayWeight() * GetEngineProperty(this->index, PROP_TRAIN_TRACTIVE_EFFORT, this->u.rail.tractive_effort)) / 256;
432  case VEH_ROAD:
433  return (GROUND_ACCELERATION * this->GetDisplayWeight() * GetEngineProperty(this->index, PROP_ROADVEH_TRACTIVE_EFFORT, this->u.road.tractive_effort)) / 256;
434 
435  default: NOT_REACHED();
436  }
437 }
438 
444 {
445  /* Assume leap years; this gives the player a bit more than the given amount of years, but never less. */
447 }
448 
453 uint16_t Engine::GetRange() const
454 {
455  switch (this->type) {
456  case VEH_AIRCRAFT:
457  return GetEngineProperty(this->index, PROP_AIRCRAFT_RANGE, this->u.air.max_range);
458 
459  default: NOT_REACHED();
460  }
461 }
462 
468 {
469  switch (this->type) {
470  case VEH_AIRCRAFT:
471  switch (this->u.air.subtype) {
472  case AIR_HELI: return STR_LIVERY_HELICOPTER;
473  case AIR_CTOL: return STR_LIVERY_SMALL_PLANE;
474  case AIR_CTOL | AIR_FAST: return STR_LIVERY_LARGE_PLANE;
475  default: NOT_REACHED();
476  }
477 
478  default: NOT_REACHED();
479  }
480 }
481 
488 {
489  /* In case company is spectator. */
490  if (c >= MAX_COMPANIES) return false;
491 
492  /* Shortcut if this engine is explicitly hidden. */
493  if (this->IsHidden(c)) return true;
494 
495  /* Check for hidden parent variants. This is a bit convoluted as we must check hidden status of
496  * the last display variant rather than the actual parent variant. */
497  const Engine *re = this;
498  const Engine *ve = re->GetDisplayVariant();
499  while (!(ve->IsHidden(c)) && re->info.variant_id != INVALID_ENGINE) {
500  re = Engine::Get(re->info.variant_id);
501  ve = re->GetDisplayVariant();
502  }
503  return ve->IsHidden(c);
504 }
505 
510 {
511  this->clear();
512  for (VehicleType type = VEH_TRAIN; type <= VEH_AIRCRAFT; type++) {
513  for (uint internal_id = 0; internal_id < _engine_counts[type]; internal_id++) {
514  EngineIDMapping &eid = this->emplace_back();
515  eid.type = type;
516  eid.grfid = INVALID_GRFID;
517  eid.internal_id = internal_id;
518  eid.substitute_id = internal_id;
519  }
520  }
521 }
522 
532 EngineID EngineOverrideManager::GetID(VehicleType type, uint16_t grf_local_id, uint32_t grfid)
533 {
534  EngineID index = 0;
535  for (const EngineIDMapping &eid : *this) {
536  if (eid.type == type && eid.grfid == grfid && eid.internal_id == grf_local_id) {
537  return index;
538  }
539  index++;
540  }
541  return INVALID_ENGINE;
542 }
543 
550 {
551  for (const Vehicle *v : Vehicle::Iterate()) {
552  if (IsCompanyBuildableVehicleType(v)) return false;
553  }
554 
555  /* Reset the engines, they will get new EngineIDs */
556  _engine_mngr.ResetToDefaultMapping();
558 
559  return true;
560 }
561 
566 {
568  _engine_pool.CleanPool();
569 
570  assert(_engine_mngr.size() >= _engine_mngr.NUM_DEFAULT_ENGINES);
571  [[maybe_unused]] uint index = 0;
572  for (const EngineIDMapping &eid : _engine_mngr) {
573  /* Assert is safe; there won't be more than 256 original vehicles
574  * in any case, and we just cleaned the pool. */
575  assert(Engine::CanAllocateItem());
576  [[maybe_unused]] const Engine *e = new Engine(eid.type, eid.internal_id);
577  assert(e->index == index);
578  index++;
579  }
580 }
581 
582 void ShowEnginePreviewWindow(EngineID engine);
583 
589 static bool IsWagon(EngineID index)
590 {
591  const Engine *e = Engine::Get(index);
592  return e->type == VEH_TRAIN && e->u.rail.railveh_type == RAILVEH_WAGON;
593 }
594 
600 static void ClearLastVariant(EngineID engine_id, VehicleType type)
601 {
602  for (Engine *e : Engine::IterateType(type)) {
603  if (e->display_last_variant == engine_id) e->display_last_variant = INVALID_ENGINE;
604  }
605 }
606 
611 void CalcEngineReliability(Engine *e, bool new_month)
612 {
613  /* Get source engine for reliability age. This is normally our engine unless variant reliability syncing is requested. */
614  Engine *re = e;
615  while (re->info.variant_id != INVALID_ENGINE && HasFlag(re->info.extra_flags, ExtraEngineFlags::SyncReliability)) {
616  re = Engine::Get(re->info.variant_id);
617  }
618 
619  uint32_t age = re->age;
620  if (new_month && re->index > e->index && age != INT32_MAX) age++; /* parent variant's age has not yet updated. */
621 
622  /* Check for early retirement */
623  if (e->company_avail != 0 && !_settings_game.vehicle.never_expire_vehicles && e->info.base_life != 0xFF) {
624  int retire_early = e->info.retire_early;
625  uint retire_early_max_age = std::max(0, e->duration_phase_1 + e->duration_phase_2 - retire_early * 12);
626  if (retire_early != 0 && age >= retire_early_max_age) {
627  /* Early retirement is enabled and we're past the date... */
628  e->company_avail = 0;
629  ClearLastVariant(e->index, e->type);
631  }
632  }
633 
634  if (age < e->duration_phase_1) {
635  uint start = e->reliability_start;
636  e->reliability = age * (e->reliability_max - start) / e->duration_phase_1 + start;
637  } else if ((age -= e->duration_phase_1) < e->duration_phase_2 || _settings_game.vehicle.never_expire_vehicles || e->info.base_life == 0xFF) {
638  /* We are at the peak of this engines life. It will have max reliability.
639  * This is also true if the engines never expire. They will not go bad over time */
641  } else if ((age -= e->duration_phase_2) < e->duration_phase_3) {
642  uint max = e->reliability_max;
643  e->reliability = (int)age * (int)(e->reliability_final - max) / e->duration_phase_3 + max;
644  } else {
645  /* time's up for this engine.
646  * We will now completely retire this design */
647  e->company_avail = 0;
649  /* Kick this engine out of the lists */
650  ClearLastVariant(e->index, e->type);
652  }
653 
654 }
655 
658 {
659  /* Determine last engine aging year, default to 2050 as previously. */
661 
662  for (const Engine *e : Engine::Iterate()) {
663  const EngineInfo *ei = &e->info;
664 
665  /* Exclude certain engines */
667  if (e->type == VEH_TRAIN && e->u.rail.railveh_type == RAILVEH_WAGON) continue;
668 
669  /* Base year ending date on half the model life */
670  TimerGameCalendar::YearMonthDay ymd = TimerGameCalendar::ConvertDateToYMD(ei->base_intro + (ei->lifelength.base() * CalendarTime::DAYS_IN_LEAP_YEAR) / 2);
671 
673  }
674 }
675 
682 void StartupOneEngine(Engine *e, const TimerGameCalendar::YearMonthDay &aging_ymd, uint32_t seed)
683 {
684  const EngineInfo *ei = &e->info;
685 
686  e->age = 0;
687  e->flags = 0;
688  e->company_avail = 0;
689  e->company_hidden = 0;
690 
691  /* Vehicles with the same base_intro date shall be introduced at the same time.
692  * Make sure they use the same randomisation of the date. */
693  SavedRandomSeeds saved_seeds;
694  SaveRandomSeeds(&saved_seeds);
696  ei->base_intro.base() ^
697  e->type ^
698  e->GetGRFID());
699  uint32_t r = Random();
700 
701  /* Don't randomise the start-date in the first two years after gamestart to ensure availability
702  * of engines in early starting games.
703  * Note: TTDP uses fixed 1922 */
704  e->intro_date = ei->base_intro <= TimerGameCalendar::ConvertYMDToDate(_settings_game.game_creation.starting_year + 2, 0, 1) ? ei->base_intro : (TimerGameCalendar::Date)GB(r, 0, 9) + ei->base_intro;
706  TimerGameCalendar::YearMonthDay intro_ymd = TimerGameCalendar::ConvertDateToYMD(e->intro_date);
707  int aging_months = aging_ymd.year.base() * 12 + aging_ymd.month;
708  int intro_months = intro_ymd.year.base() * 12 + intro_ymd.month;
709  if (intro_ymd.day > 1) intro_months++; // Engines are introduced at the first month start at/after intro date.
710  e->age = aging_months - intro_months;
711  e->company_avail = MAX_UVALUE(CompanyMask);
712  e->flags |= ENGINE_AVAILABLE;
713  }
714 
715  /* Get parent variant index for syncing reliability via random seed. */
716  const Engine *re = e;
717  while (re->info.variant_id != INVALID_ENGINE && HasFlag(re->info.extra_flags, ExtraEngineFlags::SyncReliability)) {
718  re = Engine::Get(re->info.variant_id);
719  }
720 
722  (re->index << 16) ^ (re->info.base_intro.base() << 12) ^ (re->info.decay_speed << 8) ^
723  (re->info.lifelength.base() << 4) ^ re->info.retire_early ^
724  e->type ^
725  e->GetGRFID());
726 
727  /* Base reliability defined as a percentage of UINT16_MAX. */
728  const uint16_t RELIABILITY_START = UINT16_MAX * 48 / 100;
729  const uint16_t RELIABILITY_MAX = UINT16_MAX * 75 / 100;
730  const uint16_t RELIABILITY_FINAL = UINT16_MAX * 25 / 100;
731 
732  static_assert(RELIABILITY_START == 0x7AE0);
733  static_assert(RELIABILITY_MAX == 0xBFFF);
734  static_assert(RELIABILITY_FINAL == 0x3FFF);
735 
736  r = Random();
737  /* 14 bits gives a value between 0 and 16383, which is up to an additional 25%p reliability on top of the base reliability. */
738  e->reliability_start = GB(r, 16, 14) + RELIABILITY_START;
739  e->reliability_max = GB(r, 0, 14) + RELIABILITY_MAX;
740 
741  r = Random();
742  e->reliability_final = GB(r, 16, 14) + RELIABILITY_FINAL;
743 
744  e->duration_phase_1 = GB(r, 0, 5) + 7;
745  e->duration_phase_2 = std::max(0, int(GB(r, 5, 4)) + ei->base_life.base() * 12 - 96);
746  e->duration_phase_3 = GB(r, 9, 7) + 120;
747 
748  RestoreRandomSeeds(saved_seeds);
749 
750  e->reliability_spd_dec = ei->decay_speed << 2;
751 
752  /* prevent certain engines from ever appearing. */
754  e->flags |= ENGINE_AVAILABLE;
755  e->company_avail = 0;
756  }
757 }
758 
764 {
765  /* Aging of vehicles stops, so account for that when starting late */
766  const TimerGameCalendar::Date aging_date = std::min(TimerGameCalendar::date, TimerGameCalendar::ConvertYMDToDate(_year_engine_aging_stops, 0, 1));
767  TimerGameCalendar::YearMonthDay aging_ymd = TimerGameCalendar::ConvertDateToYMD(aging_date);
768  uint32_t seed = Random();
769 
770  for (Engine *e : Engine::Iterate()) {
771  StartupOneEngine(e, aging_ymd, seed);
772  }
773  for (Engine *e : Engine::Iterate()) {
774  CalcEngineReliability(e, false);
775  }
776 
777  /* Update the bitmasks for the vehicle lists */
778  for (Company *c : Company::Iterate()) {
779  c->avail_railtypes = GetCompanyRailTypes(c->index);
780  c->avail_roadtypes = GetCompanyRoadTypes(c->index);
781  }
782 
783  /* Invalidate any open purchase lists */
785 
788 }
789 
795 static void EnableEngineForCompany(EngineID eid, CompanyID company)
796 {
797  Engine *e = Engine::Get(eid);
798  Company *c = Company::Get(company);
799 
800  SetBit(e->company_avail, company);
801  if (e->type == VEH_TRAIN) {
803  } else if (e->type == VEH_ROAD) {
805  }
806 
807  if (company == _local_company) {
809 
810  /* Update the toolbar. */
815  }
816 }
817 
823 static void DisableEngineForCompany(EngineID eid, CompanyID company)
824 {
825  Engine *e = Engine::Get(eid);
826  Company *c = Company::Get(company);
827 
828  ClrBit(e->company_avail, company);
829  if (e->type == VEH_TRAIN) {
831  } else if (e->type == VEH_ROAD) {
833  }
834 
835  if (company == _local_company) {
836  ClearLastVariant(e->index, e->type);
838  }
839 }
840 
847 static void AcceptEnginePreview(EngineID eid, CompanyID company, int recursion_depth = 0)
848 {
849  Engine *e = Engine::Get(eid);
850 
852  e->preview_asked = MAX_UVALUE(CompanyMask);
853 
854  EnableEngineForCompany(eid, company);
855 
856  /* Notify preview window, that it might want to close.
857  * Note: We cannot directly close the window.
858  * In singleplayer this function is called from the preview window, so
859  * we have to use the GUI-scope scheduling of InvalidateWindowData.
860  */
862 
863  /* Don't search for variants to include if we are 10 levels deep already. */
864  if (recursion_depth >= 10) return;
865 
866  /* Find variants to be included in preview. */
867  for (Engine *ve : Engine::IterateType(e->type)) {
868  if (ve->index != eid && ve->info.variant_id == eid && HasFlag(ve->info.extra_flags, ExtraEngineFlags::JoinPreview)) {
869  AcceptEnginePreview(ve->index, company, recursion_depth + 1);
870  }
871  }
872 }
873 
880 {
881  CompanyID best_company = INVALID_COMPANY;
882 
883  /* For trains the cargomask has no useful meaning, since you can attach other wagons */
884  CargoTypes cargomask = e->type != VEH_TRAIN ? GetUnionOfArticulatedRefitMasks(e->index, true) : ALL_CARGOTYPES;
885 
886  int32_t best_hist = -1;
887  for (const Company *c : Company::Iterate()) {
888  if (c->block_preview == 0 && !HasBit(e->preview_asked, c->index) &&
889  c->old_economy[0].performance_history > best_hist) {
890 
891  /* Check whether the company uses similar vehicles */
892  for (const Vehicle *v : Vehicle::Iterate()) {
893  if (v->owner != c->index || v->type != e->type) continue;
894  if (!v->GetEngine()->CanCarryCargo() || !HasBit(cargomask, v->cargo_type)) continue;
895 
896  best_hist = c->old_economy[0].performance_history;
897  best_company = c->index;
898  break;
899  }
900  }
901  }
902 
903  return best_company;
904 }
905 
913 static bool IsVehicleTypeDisabled(VehicleType type, bool ai)
914 {
915  switch (type) {
920 
921  default: NOT_REACHED();
922  }
923 }
924 
926 static IntervalTimer<TimerGameCalendar> _calendar_engines_daily({TimerGameCalendar::DAY, TimerGameCalendar::Priority::ENGINE}, [](auto)
927 {
928  for (Company *c : Company::Iterate()) {
929  c->avail_railtypes = AddDateIntroducedRailTypes(c->avail_railtypes, TimerGameCalendar::date);
930  c->avail_roadtypes = AddDateIntroducedRoadTypes(c->avail_roadtypes, TimerGameCalendar::date);
931  }
932 
934 
935  for (Engine *e : Engine::Iterate()) {
936  EngineID i = e->index;
937  if (e->flags & ENGINE_EXCLUSIVE_PREVIEW) {
938  if (e->preview_company != INVALID_COMPANY) {
939  if (!--e->preview_wait) {
941  e->preview_company = INVALID_COMPANY;
942  }
943  } else if (CountBits(e->preview_asked) < MAX_COMPANIES) {
944  e->preview_company = GetPreviewCompany(e);
945 
946  if (e->preview_company == INVALID_COMPANY) {
947  e->preview_asked = MAX_UVALUE(CompanyMask);
948  continue;
949  }
950 
951  SetBit(e->preview_asked, e->preview_company);
952  e->preview_wait = 20;
953  /* AIs are intentionally not skipped for preview even if they cannot build a certain
954  * vehicle type. This is done to not give poor performing human companies an "unfair"
955  * boost that they wouldn't have gotten against other human companies. The check on
956  * the line below is just to make AIs not notice that they have a preview if they
957  * cannot build the vehicle. */
958  if (!IsVehicleTypeDisabled(e->type, true)) AI::NewEvent(e->preview_company, new ScriptEventEnginePreview(i));
959  if (IsInteractiveCompany(e->preview_company)) ShowEnginePreviewWindow(i);
960  }
961  }
962  }
963 });
964 
970 {
971  for (Engine *e : Engine::Iterate()) {
972  SB(e->company_hidden, cid, 1, 0);
973  }
974 }
975 
984 {
985  Engine *e = Engine::GetIfValid(engine_id);
986  if (e == nullptr || _current_company >= MAX_COMPANIES) return CMD_ERROR;
987  if (!IsEngineBuildable(e->index, e->type, _current_company)) return CMD_ERROR;
988 
989  if ((flags & DC_EXEC) != 0) {
992  }
993 
994  return CommandCost();
995 }
996 
1005 {
1006  Engine *e = Engine::GetIfValid(engine_id);
1007  if (e == nullptr || !(e->flags & ENGINE_EXCLUSIVE_PREVIEW) || e->preview_company != _current_company) return CMD_ERROR;
1008 
1009  if (flags & DC_EXEC) AcceptEnginePreview(engine_id, _current_company);
1010 
1011  return CommandCost();
1012 }
1013 
1022 CommandCost CmdEngineCtrl(DoCommandFlag flags, EngineID engine_id, CompanyID company_id, bool allow)
1023 {
1024  if (_current_company != OWNER_DEITY) return CMD_ERROR;
1025 
1026  if (!Engine::IsValidID(engine_id) || !Company::IsValidID(company_id)) return CMD_ERROR;
1027 
1028  if (flags & DC_EXEC) {
1029  if (allow) {
1030  EnableEngineForCompany(engine_id, company_id);
1031  } else {
1032  DisableEngineForCompany(engine_id, company_id);
1033  }
1034  }
1035 
1036  return CommandCost();
1037 }
1038 
1045 {
1046  EngineID index = e->index;
1047 
1048  /* In case the company didn't build the vehicle during the intro period,
1049  * prevent that company from getting future intro periods for a while. */
1050  if (e->flags & ENGINE_EXCLUSIVE_PREVIEW) {
1051  for (Company *c : Company::Iterate()) {
1052  uint block_preview = c->block_preview;
1053 
1054  if (!HasBit(e->company_avail, c->index)) continue;
1055 
1056  /* We assume the user did NOT build it.. prove me wrong ;) */
1057  c->block_preview = 20;
1058 
1059  for (const Vehicle *v : Vehicle::Iterate()) {
1060  if (v->type == VEH_TRAIN || v->type == VEH_ROAD || v->type == VEH_SHIP ||
1061  (v->type == VEH_AIRCRAFT && Aircraft::From(v)->IsNormalAircraft())) {
1062  if (v->owner == c->index && v->engine_type == index) {
1063  /* The user did prove me wrong, so restore old value */
1064  c->block_preview = block_preview;
1065  break;
1066  }
1067  }
1068  }
1069  }
1070  }
1071 
1074 
1075  /* Now available for all companies */
1076  e->company_avail = MAX_UVALUE(CompanyMask);
1077 
1078  /* Do not introduce new rail wagons */
1079  if (IsWagon(index)) return;
1080 
1081  if (e->type == VEH_TRAIN) {
1082  /* maybe make another rail type available */
1083  assert(e->u.rail.railtype < RAILTYPE_END);
1084  for (Company *c : Company::Iterate()) c->avail_railtypes = AddDateIntroducedRailTypes(c->avail_railtypes | GetRailTypeInfo(e->u.rail.railtype)->introduces_railtypes, TimerGameCalendar::date);
1085  } else if (e->type == VEH_ROAD) {
1086  /* maybe make another road type available */
1087  assert(e->u.road.roadtype < ROADTYPE_END);
1088  for (Company *c : Company::Iterate()) c->avail_roadtypes = AddDateIntroducedRoadTypes(c->avail_roadtypes | GetRoadTypeInfo(e->u.road.roadtype)->introduces_roadtypes, TimerGameCalendar::date);
1089  }
1090 
1091  /* Only broadcast event if AIs are able to build this vehicle type. */
1092  if (!IsVehicleTypeDisabled(e->type, true)) AI::BroadcastNewEvent(new ScriptEventEngineAvailable(index));
1093 
1094  /* Only provide the "New Vehicle available" news paper entry, if engine can be built. */
1095  if (!IsVehicleTypeDisabled(e->type, false) && !HasFlag(e->info.extra_flags, ExtraEngineFlags::NoNews)) {
1096  SetDParam(0, GetEngineCategoryName(index));
1098  AddNewsItem(STR_NEWS_NEW_VEHICLE_NOW_AVAILABLE_WITH_TYPE, NT_NEW_VEHICLES, NF_VEHICLE, NR_ENGINE, index);
1099  }
1100 
1101  /* Update the toolbar. */
1105 
1106  /* Close pending preview windows */
1108 }
1109 
1112 {
1114  bool refresh = false;
1115  for (Engine *e : Engine::Iterate()) {
1116  /* Age the vehicle */
1117  if ((e->flags & ENGINE_AVAILABLE) && e->age != INT32_MAX) {
1118  e->age++;
1119  CalcEngineReliability(e, true);
1120  refresh = true;
1121  }
1122 
1123  /* Do not introduce invalid engines */
1124  if (!e->IsEnabled()) continue;
1125 
1126  if (!(e->flags & ENGINE_AVAILABLE) && TimerGameCalendar::date >= (e->intro_date + CalendarTime::DAYS_IN_YEAR)) {
1127  /* Introduce it to all companies */
1129  } else if (!(e->flags & (ENGINE_AVAILABLE | ENGINE_EXCLUSIVE_PREVIEW)) && TimerGameCalendar::date >= e->intro_date) {
1130  /* Introduction date has passed...
1131  * Check if it is allowed to build this vehicle type at all
1132  * based on the current game settings. If not, it does not
1133  * make sense to show the preview dialog to any company. */
1134  if (IsVehicleTypeDisabled(e->type, false)) continue;
1135 
1136  /* Do not introduce new rail wagons */
1137  if (IsWagon(e->index)) continue;
1138 
1139  /* Engine has no preview */
1140  if (HasFlag(e->info.extra_flags, ExtraEngineFlags::NoPreview)) continue;
1141 
1142  /* Show preview dialog to one of the companies. */
1143  e->flags |= ENGINE_EXCLUSIVE_PREVIEW;
1144  e->preview_company = INVALID_COMPANY;
1145  e->preview_asked = 0;
1146  }
1147  }
1148 
1149  InvalidateWindowClassesData(WC_BUILD_VEHICLE); // rebuild the purchase list (esp. when sorted by reliability)
1150 
1151  if (refresh) {
1154  }
1155  }
1156 }
1157 
1158 static IntervalTimer<TimerGameCalendar> _calendar_engines_monthly({TimerGameCalendar::MONTH, TimerGameCalendar::Priority::ENGINE}, [](auto)
1159 {
1161 });
1162 
1168 static bool IsUniqueEngineName(const std::string &name)
1169 {
1170  for (const Engine *e : Engine::Iterate()) {
1171  if (!e->name.empty() && e->name == name) return false;
1172  }
1173 
1174  return true;
1175 }
1176 
1184 CommandCost CmdRenameEngine(DoCommandFlag flags, EngineID engine_id, const std::string &text)
1185 {
1186  Engine *e = Engine::GetIfValid(engine_id);
1187  if (e == nullptr) return CMD_ERROR;
1188 
1189  bool reset = text.empty();
1190 
1191  if (!reset) {
1193  if (!IsUniqueEngineName(text)) return_cmd_error(STR_ERROR_NAME_MUST_BE_UNIQUE);
1194  }
1195 
1196  if (flags & DC_EXEC) {
1197  if (reset) {
1198  e->name.clear();
1199  } else {
1200  e->name = text;
1201  }
1202 
1204  }
1205 
1206  return CommandCost();
1207 }
1208 
1209 
1219 {
1220  const Engine *e = Engine::GetIfValid(engine);
1221 
1222  /* check if it's an engine that is in the engine array */
1223  if (e == nullptr) return false;
1224 
1225  /* check if it's an engine of specified type */
1226  if (e->type != type) return false;
1227 
1228  /* check if it's available ... */
1229  if (company == OWNER_DEITY) {
1230  /* ... for any company (preview does not count) */
1231  if (!(e->flags & ENGINE_AVAILABLE) || e->company_avail == 0) return false;
1232  } else {
1233  /* ... for this company */
1234  if (!HasBit(e->company_avail, company)) return false;
1235  }
1236 
1237  if (!e->IsEnabled()) return false;
1238 
1239  if (type == VEH_TRAIN && company != OWNER_DEITY) {
1240  /* Check if the rail type is available to this company */
1241  const Company *c = Company::Get(company);
1242  if (((GetRailTypeInfo(e->u.rail.railtype))->compatible_railtypes & c->avail_railtypes) == 0) return false;
1243  }
1244  if (type == VEH_ROAD && company != OWNER_DEITY) {
1245  /* Check if the road type is available to this company */
1246  const Company *c = Company::Get(company);
1247  if ((GetRoadTypeInfo(e->u.road.roadtype)->powered_roadtypes & c->avail_roadtypes) == ROADTYPES_NONE) return false;
1248  }
1249 
1250  return true;
1251 }
1252 
1260 {
1261  const Engine *e = Engine::GetIfValid(engine);
1262 
1263  /* check if it's an engine that is in the engine array */
1264  if (e == nullptr) return false;
1265 
1266  if (!e->CanCarryCargo()) return false;
1267 
1268  const EngineInfo *ei = &e->info;
1269  if (ei->refit_mask == 0) return false;
1270 
1271  /* Are there suffixes?
1272  * Note: This does not mean the suffixes are actually available for every consist at any time. */
1273  if (HasBit(ei->callback_mask, CBM_VEHICLE_CARGO_SUFFIX)) return true;
1274 
1275  /* Is there any cargo except the default cargo? */
1276  CargoID default_cargo = e->GetDefaultCargoType();
1277  CargoTypes default_cargo_mask = 0;
1278  SetBit(default_cargo_mask, default_cargo);
1279  return IsValidCargoID(default_cargo) && ei->refit_mask != default_cargo_mask;
1280 }
1281 
1286 {
1287  TimerGameCalendar::Date min_date = INT32_MAX;
1288 
1289  for (const Engine *e : Engine::Iterate()) {
1290  if (!e->IsEnabled()) continue;
1291 
1292  /* Don't consider train wagons, we need a powered engine available. */
1293  if (e->type == VEH_TRAIN && e->u.rail.railveh_type == RAILVEH_WAGON) continue;
1294 
1295  /* We have an available engine... yay! */
1296  if ((e->flags & ENGINE_AVAILABLE) != 0 && e->company_avail != 0) return;
1297 
1298  /* Okay, try to find the earliest date. */
1299  min_date = std::min(min_date, e->info.base_intro);
1300  }
1301 
1302  if (min_date < INT32_MAX) {
1303  SetDParam(0, min_date);
1304  ShowErrorMessage(STR_ERROR_NO_VEHICLES_AVAILABLE_YET, STR_ERROR_NO_VEHICLES_AVAILABLE_YET_EXPLANATION, WL_WARNING);
1305  } else {
1306  ShowErrorMessage(STR_ERROR_NO_VEHICLES_AVAILABLE_AT_ALL, STR_ERROR_NO_VEHICLES_AVAILABLE_AT_ALL_EXPLANATION, WL_WARNING);
1307  }
1308 }
Base functions for all AIs.
Base for aircraft.
CargoTypes GetUnionOfArticulatedRefitMasks(EngineID engine, bool include_initial_cargo_type)
Ors the refit_masks of all articulated parts.
Functions related to articulated vehicles.
void AddRemoveEngineFromAutoreplaceAndBuildWindows(VehicleType type)
When an engine is made buildable or is removed from being buildable, add/remove it from the build/aut...
Functions related to the autoreplace GUIs.
constexpr debug_inline bool HasBit(const T x, const uint8_t y)
Checks if a bit in a value is set.
constexpr T AssignBit(T &x, const uint8_t y, bool value)
Assigns a bit in a variable.
constexpr T SB(T &x, const uint8_t s, const uint8_t n, const U d)
Set n bits in x starting at bit s to d.
constexpr T SetBit(T &x, const uint8_t y)
Set a bit in a variable.
constexpr uint CountBits(T value)
Counts the number of set bits in a variable.
constexpr static debug_inline uint GB(const T x, const uint8_t s, const uint8_t n)
Fetch n bits from x, started at bit s.
constexpr T ClrBit(T &x, const uint8_t y)
Clears a bit in a variable.
uint8_t CargoID
Cargo slots to indicate a cargo type within a game.
Definition: cargo_type.h:22
bool IsValidCargoID(CargoID t)
Test whether cargo type is not INVALID_CARGO.
Definition: cargo_type.h:107
static constexpr CargoLabel CT_PASSENGERS
Available types of cargo Labels may be re-used between different climates.
Definition: cargo_type.h:30
bool IsCargoInClass(CargoID c, CargoClass cc)
Does cargo c have cargo class cc?
Definition: cargotype.h:232
@ CC_PASSENGERS
Passengers.
Definition: cargotype.h:50
static void BroadcastNewEvent(ScriptEvent *event, CompanyID skip_company=MAX_COMPANIES)
Broadcast a new event to all active AIs.
Definition: ai_core.cpp:263
static void NewEvent(CompanyID company, ScriptEvent *event)
Queue a new event for an AI.
Definition: ai_core.cpp:243
Common return value for all commands.
Definition: command_type.h:23
RailTypes introduces_railtypes
Bitmask of which other railtypes are introduced when this railtype is introduced.
Definition: rail.h:266
RoadTypes powered_roadtypes
bitmask to the OTHER roadtypes on which a vehicle of THIS roadtype generates power
Definition: road.h:122
RoadTypes introduces_roadtypes
Bitmask of which other roadtypes are introduced when this roadtype is introduced.
Definition: road.h:177
static constexpr TimerGameTick::Ticks CARGO_AGING_TICKS
Cycle duration for aging cargo.
static Date ConvertYMDToDate(Year year, Month month, Day day)
Converts a tuple of Year, Month and Day to a Date.
static YearMonthDay ConvertDateToYMD(Date date)
Converts a Date to a Year, Month & Day.
static Date date
Current date in days (day counter).
static Year year
Current year, starting at 0.
static constexpr int DAYS_IN_YEAR
days per year
static constexpr int DAYS_IN_LEAP_YEAR
sometimes, you need one day more...
Functions related to commands.
static const CommandCost CMD_ERROR
Define a default return value for a failed command.
Definition: command_func.h:28
#define return_cmd_error(errcode)
Returns from a function with a specific StringID as error.
Definition: command_func.h:38
DoCommandFlag
List of flags for a command.
Definition: command_type.h:374
@ DC_EXEC
execute the given command
Definition: command_type.h:376
Definition of stuff that is very close to a company, like the company struct itself.
CompanyID _local_company
Company controlled by the human player at this client. Can also be COMPANY_SPECTATOR.
Definition: company_cmd.cpp:52
CompanyID _current_company
Company currently doing an action.
Definition: company_cmd.cpp:53
Functions related to companies.
bool IsInteractiveCompany(CompanyID company)
Is the user representing company?
Definition: company_func.h:57
Owner
Enum for all companies/owners.
Definition: company_type.h:18
@ INVALID_COMPANY
An invalid company.
Definition: company_type.h:30
@ OWNER_DEITY
The object is owned by a superuser / goal script.
Definition: company_type.h:27
@ MAX_COMPANIES
Maximum number of companies.
Definition: company_type.h:23
Money GetPrice(Price index, uint cost_factor, const GRFFile *grf_file, int shift)
Determine a certain price.
Definition: economy.cpp:969
Price
Enumeration of all base prices for use with Prices.
Definition: economy_type.h:89
void ClearEnginesHiddenFlagOfCompany(CompanyID cid)
Clear the 'hidden' flag for all engines of a new company.
Definition: engine.cpp:969
void SetYearEngineAgingStops()
Compute the value for _year_engine_aging_stops.
Definition: engine.cpp:657
static void NewVehicleAvailable(Engine *e)
An engine has become available for general use.
Definition: engine.cpp:1044
const uint8_t _engine_counts[4]
Number of engines of each vehicle type in original engine data.
Definition: engine.cpp:53
void SetupEngines()
Initialise the engine pool with the data from the original vehicles.
Definition: engine.cpp:565
CommandCost CmdSetVehicleVisibility(DoCommandFlag flags, EngineID engine_id, bool hide)
Set the visibility of an engine.
Definition: engine.cpp:983
static CompanyID GetPreviewCompany(Engine *e)
Get the best company for an engine preview.
Definition: engine.cpp:879
static IntervalTimer< TimerGameCalendar > _calendar_engines_daily({TimerGameCalendar::DAY, TimerGameCalendar::Priority::ENGINE}, [](auto) { for(Company *c :Company::Iterate()) { c->avail_railtypes=AddDateIntroducedRailTypes(c->avail_railtypes, TimerGameCalendar::date);c->avail_roadtypes=AddDateIntroducedRoadTypes(c->avail_roadtypes, TimerGameCalendar::date);} if(TimerGameCalendar::year >=_year_engine_aging_stops) return;for(Engine *e :Engine::Iterate()) { EngineID i=e->index;if(e->flags &ENGINE_EXCLUSIVE_PREVIEW) { if(e->preview_company !=INVALID_COMPANY) { if(!--e->preview_wait) { CloseWindowById(WC_ENGINE_PREVIEW, i);e->preview_company=INVALID_COMPANY;} } else if(CountBits(e->preview_asked)< MAX_COMPANIES) { e->preview_company=GetPreviewCompany(e);if(e->preview_company==INVALID_COMPANY) { e->preview_asked=MAX_UVALUE(CompanyMask);continue;} SetBit(e->preview_asked, e->preview_company);e->preview_wait=20;if(!IsVehicleTypeDisabled(e->type, true)) AI::NewEvent(e->preview_company, new ScriptEventEnginePreview(i));if(IsInteractiveCompany(e->preview_company)) ShowEnginePreviewWindow(i);} } } })
Daily check to offer an exclusive engine preview to the companies.
const uint8_t _engine_offsets[4]
Offset of the first engine of each vehicle type in original engine data.
Definition: engine.cpp:61
static void ClearLastVariant(EngineID engine_id, VehicleType type)
Ensure engine is not set as the last used variant for any other engine.
Definition: engine.cpp:600
static bool IsVehicleTypeDisabled(VehicleType type, bool ai)
Checks if a vehicle type is disabled for all/ai companies.
Definition: engine.cpp:913
CommandCost CmdWantEnginePreview(DoCommandFlag flags, EngineID engine_id)
Accept an engine prototype.
Definition: engine.cpp:1004
CommandCost CmdEngineCtrl(DoCommandFlag flags, EngineID engine_id, CompanyID company_id, bool allow)
Allow or forbid a specific company to use an engine.
Definition: engine.cpp:1022
static void AcceptEnginePreview(EngineID eid, CompanyID company, int recursion_depth=0)
Company company accepts engine eid for preview.
Definition: engine.cpp:847
void CalendarEnginesMonthlyLoop()
Monthly update of the availability, reliability, and preview offers of the engines.
Definition: engine.cpp:1111
static bool IsUniqueEngineName(const std::string &name)
Is name still free as name for an engine?
Definition: engine.cpp:1168
bool IsEngineBuildable(EngineID engine, VehicleType type, CompanyID company)
Check if an engine is buildable.
Definition: engine.cpp:1218
static TimerGameCalendar::Year _year_engine_aging_stops
Year that engine aging stops.
Definition: engine.cpp:50
static void DisableEngineForCompany(EngineID eid, CompanyID company)
Forbids engine eid to be used by a company company.
Definition: engine.cpp:823
void StartupEngines()
Start/initialise all our engines.
Definition: engine.cpp:763
static bool IsWagon(EngineID index)
Determine whether an engine type is a wagon (and not a loco).
Definition: engine.cpp:589
void StartupOneEngine(Engine *e, const TimerGameCalendar::YearMonthDay &aging_ymd, uint32_t seed)
Start/initialise one engine.
Definition: engine.cpp:682
void CheckEngines()
Check for engines that have an appropriate availability.
Definition: engine.cpp:1285
bool IsEngineRefittable(EngineID engine)
Check if an engine is refittable.
Definition: engine.cpp:1259
void CalcEngineReliability(Engine *e, bool new_month)
Update Engine::reliability and (if needed) update the engine GUIs.
Definition: engine.cpp:611
static void EnableEngineForCompany(EngineID eid, CompanyID company)
Allows engine eid to be used by a company company.
Definition: engine.cpp:795
CommandCost CmdRenameEngine(DoCommandFlag flags, EngineID engine_id, const std::string &text)
Rename an engine.
Definition: engine.cpp:1184
Base class for engines.
Functions related to engines.
StringID GetEngineCategoryName(EngineID engine)
Return the category of an engine.
Definition: engine_gui.cpp:40
Engine GUI functions, used by build_vehicle_gui and autoreplace_gui
@ RAILVEH_WAGON
simple wagon, not motorized
Definition: engine_type.h:29
@ RAILVEH_MULTIHEAD
indicates a combination of two locomotives
Definition: engine_type.h:28
static const uint MAX_LENGTH_ENGINE_NAME_CHARS
The maximum length of an engine name in characters including '\0'.
Definition: engine_type.h:204
static const EngineID INVALID_ENGINE
Constant denoting an invalid engine.
Definition: engine_type.h:206
uint16_t EngineID
Unique identification number of an engine.
Definition: engine_type.h:21
@ AIR_CTOL
Conventional Take Off and Landing, i.e. planes.
Definition: engine_type.h:95
uint64_t PackEngineNameDParam(EngineID engine_id, EngineNameContext context, uint32_t extra_data=0)
Combine an engine ID and a name context to an engine name dparam.
Definition: engine_type.h:199
@ ENGINE_EXCLUSIVE_PREVIEW
This vehicle is in the exclusive preview stage, either being used or being offered to a company.
Definition: engine_type.h:184
@ ENGINE_AVAILABLE
This vehicle is available to everyone.
Definition: engine_type.h:183
@ SyncReliability
Engine reliability will be synced with variant parent.
@ NoNews
No 'new vehicle' news will be generated.
@ JoinPreview
Engine will join exclusive preview with variant parent.
@ NoPreview
No exclusive preview will be offered.
@ EF_NO_DEFAULT_CARGO_MULTIPLIER
Use the new capacity algorithm. The default cargotype of the vehicle does not affect capacity multipl...
Definition: engine_type.h:174
@ PreviewNews
Name is shown in exclusive preview or newspaper.
Definition: engine_type.h:194
This file contains all the data for vehicles.
constexpr debug_inline bool HasFlag(const T x, const T y)
Checks if a value in a bitset enum is set.
Definition: enum_type.hpp:58
Functions related to errors.
void ShowErrorMessage(StringID summary_msg, int x, int y, CommandCost cc)
Display an error message in a window.
Definition: error_gui.cpp:367
@ WL_WARNING
Other information.
Definition: error.h:25
void MarkWholeScreenDirty()
This function mark the whole screen as dirty.
Definition: gfx.cpp:1529
Base for the NewGRF implementation.
void ReloadNewGRFData()
Reload all NewGRF files during a running game.
Definition: afterload.cpp:3364
@ CBID_VEHICLE_REFIT_CAPACITY
Refit capacity, the passed vehicle needs to have its ->cargo_type set to the cargo we are refitting t...
@ CBM_VEHICLE_CARGO_SUFFIX
Show suffix after cargo name.
@ CBM_VEHICLE_REFIT_CAPACITY
Cargo capacity after refit.
static const uint CALLBACK_FAILED
Different values for Callback result evaluations.
uint16_t GetVehicleCallback(CallbackID callback, uint32_t param1, uint32_t param2, EngineID engine, const Vehicle *v)
Evaluate a newgrf callback for vehicles.
Functions for NewGRF engines.
@ PROP_AIRCRAFT_PASSENGER_CAPACITY
Passenger Capacity.
@ PROP_ROADVEH_WEIGHT
Weight in 1/4 t.
@ PROP_TRAIN_COST_FACTOR
Purchase cost (if dualheaded: sum of both vehicles)
@ PROP_TRAIN_WEIGHT
Weight in t (if dualheaded: for each single vehicle)
@ PROP_AIRCRAFT_RANGE
Aircraft range.
@ PROP_TRAIN_CARGO_CAPACITY
Capacity (if dualheaded: for each single vehicle)
@ PROP_AIRCRAFT_RUNNING_COST_FACTOR
Yearly runningcost.
@ PROP_ROADVEH_RUNNING_COST_FACTOR
Yearly runningcost.
@ PROP_TRAIN_TRACTIVE_EFFORT
Tractive effort coefficient in 1/256.
@ PROP_SHIP_CARGO_CAPACITY
Capacity.
@ PROP_ROADVEH_TRACTIVE_EFFORT
Tractive effort coefficient in 1/256.
@ PROP_SHIP_COST_FACTOR
Purchase cost.
@ PROP_ROADVEH_CARGO_CAPACITY
Capacity.
@ PROP_AIRCRAFT_SPEED
Max. speed: 1 unit = 8 mph = 12.8 km-ish/h.
@ PROP_AIRCRAFT_MAIL_CAPACITY
Mail Capacity.
@ PROP_SHIP_SPEED
Max. speed: 1 unit = 1/3.2 mph = 0.5 km-ish/h.
@ PROP_SHIP_RUNNING_COST_FACTOR
Yearly runningcost.
@ PROP_ROADVEH_COST_FACTOR
Purchase cost.
@ PROP_ROADVEH_POWER
Power in 10 HP.
@ PROP_AIRCRAFT_COST_FACTOR
Purchase cost.
@ PROP_TRAIN_RUNNING_COST_FACTOR
Yearly runningcost (if dualheaded: sum of both vehicles)
@ PROP_TRAIN_POWER
Power in hp (if dualheaded: sum of both vehicles)
@ PROP_TRAIN_SPEED
Max. speed: 1 unit = 1/1.6 mph = 1 km-ish/h.
@ PROP_ROADVEH_SPEED
Max. speed: 1 unit = 1/0.8 mph = 2 km-ish/h.
Functions related to news.
void AddNewsItem(StringID string, NewsType type, NewsFlag flags, NewsReferenceType reftype1=NR_NONE, uint32_t ref1=UINT32_MAX, NewsReferenceType reftype2=NR_NONE, uint32_t ref2=UINT32_MAX, const NewsAllocatedData *data=nullptr)
Add a new newsitem to be shown.
Definition: news_gui.cpp:829
@ NT_NEW_VEHICLES
New vehicle has become available.
Definition: news_type.h:36
@ NR_ENGINE
Reference engine.
Definition: news_type.h:59
@ NF_VEHICLE
Vehicle news item. (new engine available)
Definition: news_type.h:82
Some methods of Pool are placed here in order to reduce compilation time and binary size.
#define INSTANTIATE_POOL_METHODS(name)
Force instantiation of pool methods so we don't get linker errors.
Definition: pool_func.hpp:237
RailTypes GetCompanyRailTypes(CompanyID company, bool introduces)
Get the rail types the given company can build.
Definition: rail.cpp:251
RailTypes AddDateIntroducedRailTypes(RailTypes current, TimerGameCalendar::Date date)
Add the rail types that are to be introduced at the given date.
Definition: rail.cpp:218
const RailTypeInfo * GetRailTypeInfo(RailType railtype)
Returns a pointer to the Railtype information for a given railtype.
Definition: rail.h:307
@ RAILTYPE_END
Used for iterations.
Definition: rail_type.h:33
void SetRandomSeed(uint32_t seed)
(Re)set the state of the random number generators.
Definition: random_func.cpp:66
Pseudo random number generator.
void SaveRandomSeeds(SavedRandomSeeds *storage)
Saves the current seeds.
Definition: random_func.hpp:55
void RestoreRandomSeeds(const SavedRandomSeeds &storage)
Restores previously saved seeds.
Definition: random_func.hpp:65
RoadTypes GetCompanyRoadTypes(CompanyID company, bool introduces)
Get the road types the given company can build.
Definition: road.cpp:199
RoadTypes AddDateIntroducedRoadTypes(RoadTypes current, TimerGameCalendar::Date date)
Add the road types that are to be introduced at the given date.
Definition: road.cpp:166
const RoadTypeInfo * GetRoadTypeInfo(RoadType roadtype)
Returns a pointer to the Roadtype information for a given roadtype.
Definition: road.h:227
@ ROADTYPES_NONE
No roadtypes.
Definition: road_type.h:39
@ ROADTYPE_END
Used for iterations.
Definition: road_type.h:29
A number of safeguards to prevent using unsafe methods.
GameSettings _settings_game
Game settings of a running game or the scenario editor.
Definition: settings.cpp:57
Definition of base types and functions in a cross-platform compatible way.
#define MAX_UVALUE(type)
The largest value that can be entered in a variable.
Definition: stdafx.h:343
#define lengthof(array)
Return the length of an fixed size array.
Definition: stdafx.h:280
size_t Utf8StringLength(const char *s)
Get the length of an UTF-8 encoded string in number of characters and thus not the number of bytes th...
Definition: string.cpp:359
Functions related to low-level strings.
void SetDParam(size_t n, uint64_t v)
Set a string parameter v at index n in the global string parameter array.
Definition: strings.cpp:104
Functions related to OTTD's strings.
uint32_t StringID
Numeric value that represents a string, independent of the selected language.
Definition: strings_type.h:16
bool ai_disable_veh_roadveh
disable types for AI
bool ai_disable_veh_ship
disable types for AI
bool ai_disable_veh_train
disable types for AI
bool ai_disable_veh_aircraft
disable types for AI
bool IsNormalAircraft() const
Check if the aircraft type is a normal flying device; eg not a rotor or a shadow.
Definition: aircraft.h:121
uint16_t multiplier
Capacity multiplier for vehicles. (8 fractional bits)
Definition: cargotype.h:77
static CargoSpec * Get(size_t index)
Retrieve cargo details for the given cargo ID.
Definition: cargotype.h:134
RoadTypes avail_roadtypes
Road types available to this company.
Definition: company_base.h:138
RailTypes avail_railtypes
Rail types available to this company.
Definition: company_base.h:137
VehicleType type
The engine type.
Definition: engine_base.h:195
uint32_t grfid
The GRF ID of the file the entity belongs to.
Definition: engine_base.h:193
uint8_t substitute_id
The (original) entity ID to use if this GRF is not available (currently not used)
Definition: engine_base.h:196
uint16_t internal_id
The internal ID within the GRF file.
Definition: engine_base.h:194
Information about a vehicle.
Definition: engine_type.h:144
uint16_t cargo_age_period
Number of ticks before carried cargo is aged.
Definition: engine_type.h:159
TimerGameCalendar::Year base_life
Basic duration of engine availability (without random parts). 0xFF means infinite life.
Definition: engine_type.h:147
EngineID variant_id
Engine variant ID. If set, will be treated specially in purchase lists.
Definition: engine_type.h:160
uint8_t misc_flags
Miscellaneous flags.
Definition: engine_type.h:155
StringID string_id
Default name of engine.
Definition: engine_type.h:158
uint8_t climates
Climates supported by the engine.
Definition: engine_type.h:150
TimerGameCalendar::Date base_intro
Basic date of engine introduction (without random parts).
Definition: engine_type.h:145
uint16_t callback_mask
Bitmask of vehicle callbacks that have to be called.
Definition: engine_type.h:156
int8_t retire_early
Number of years early to retire vehicle.
Definition: engine_type.h:157
TimerGameCalendar::Year lifelength
Lifetime of a single vehicle.
Definition: engine_type.h:146
Stores the mapping of EngineID to the internal id of newgrfs.
Definition: engine_base.h:203
static bool ResetToCurrentNewGRFConfig()
Tries to reset the engine mapping to match the current NewGRF configuration.
Definition: engine.cpp:549
void ResetToDefaultMapping()
Initializes the EngineOverrideManager with the default engines.
Definition: engine.cpp:509
EngineID GetID(VehicleType type, uint16_t grf_local_id, uint32_t grfid)
Looks up an EngineID in the EngineOverrideManager.
Definition: engine.cpp:532
static const uint NUM_DEFAULT_ENGINES
Number of default entries.
Definition: engine_base.h:204
StringID GetAircraftTypeText() const
Get the name of the aircraft type for display purposes.
Definition: engine.cpp:467
uint GetPower() const
Returns the power of the engine for display and sorting purposes.
Definition: engine.cpp:390
CargoID GetDefaultCargoType() const
Determines the default cargo type of an engine.
Definition: engine_base.h:96
uint16_t GetRange() const
Get the range of an aircraft type.
Definition: engine.cpp:453
GRFFilePropsBase< NUM_CARGO+2 > grf_prop
Properties related the the grf file.
Definition: engine_base.h:77
uint32_t GetGRFID() const
Retrieve the GRF ID of the NewGRF the engine is tied to.
Definition: engine.cpp:157
uint16_t reliability_spd_dec
Speed of reliability decay between services (per day).
Definition: engine_base.h:42
Money GetCost() const
Return how much a new engine costs.
Definition: engine.cpp:318
uint16_t reliability_start
Initial reliability of the engine.
Definition: engine_base.h:43
const Engine * GetDisplayVariant() const
Get the last display variant for an engine.
Definition: engine_base.h:145
TimerGameCalendar::Date intro_date
Date of introduction of the engine.
Definition: engine_base.h:39
uint GetDisplayMaxSpeed() const
Returns max speed of the engine for display purposes.
Definition: engine.cpp:358
uint DetermineCapacity(const Vehicle *v, uint16_t *mail_capacity=nullptr) const
Determines capacity of a given vehicle from scratch.
Definition: engine.cpp:201
CompanyMask company_avail
Bit for each company whether the engine is available for that company.
Definition: engine_base.h:53
uint16_t reliability_max
Maximal reliability of the engine.
Definition: engine_base.h:44
uint GetDisplayWeight() const
Returns the weight of the engine for display purposes.
Definition: engine.cpp:408
uint8_t original_image_index
Original vehicle image index, thus the image index of the overridden vehicle.
Definition: engine_base.h:55
bool IsEnabled() const
Checks whether the engine is a valid (non-articulated part of an) engine.
Definition: engine.cpp:147
VehicleType type
Vehicle type, ie VEH_ROAD, VEH_TRAIN, etc.
Definition: engine_base.h:56
bool IsVariantHidden(CompanyID c) const
Check whether the engine variant chain is hidden in the GUI for the given company.
Definition: engine.cpp:487
uint16_t reliability_final
Final reliability of the engine.
Definition: engine_base.h:45
const GRFFile * GetGRF() const
Retrieve the NewGRF the engine is tied to.
Definition: engine_base.h:167
CompanyID preview_company
Company which is currently being offered a preview INVALID_COMPANY means no company.
Definition: engine_base.h:51
TimerGameCalendar::Date GetLifeLengthInDays() const
Returns the vehicle's (not model's!) life length in days.
Definition: engine.cpp:443
uint16_t duration_phase_3
Third reliability phase in months, decaying to reliability_final.
Definition: engine_base.h:48
uint16_t duration_phase_2
Second reliability phase in months, keeping reliability_max.
Definition: engine_base.h:47
CompanyMask company_hidden
Bit for each company whether the engine is normally hidden in the build gui for that company.
Definition: engine_base.h:54
Money GetRunningCost() const
Return how much the running costs of this engine are.
Definition: engine.cpp:281
uint16_t reliability
Current reliability of the engine.
Definition: engine_base.h:41
CompanyMask preview_asked
Bit for each company which has already been offered a preview.
Definition: engine_base.h:50
uint GetDisplayMaxTractiveEffort() const
Returns the tractive effort of the engine for display purposes.
Definition: engine.cpp:426
int32_t age
Age of the engine in months.
Definition: engine_base.h:40
bool IsHidden(CompanyID c) const
Check whether the engine is hidden in the GUI for the given company.
Definition: engine_base.h:136
static Pool::IterateWrapperFiltered< Engine, EngineTypeFilter > IterateType(VehicleType vt, size_t from=0)
Returns an iterable ensemble of all valid engines of the given type.
Definition: engine_base.h:186
bool CanCarryCargo() const
Determines whether an engine can carry something.
Definition: engine.cpp:168
std::string name
Custom name of engine.
Definition: engine_base.h:38
EngineID display_last_variant
NOSAVE client-side-only last variant selected.
Definition: engine_base.h:59
uint16_t duration_phase_1
First reliability phase in months, increasing reliability from reliability_start to reliability_max.
Definition: engine_base.h:46
uint8_t flags
Flags of the engine.
Definition: engine_base.h:49
uint16_t local_id
id defined by the grf file for this entity
Dynamic data of a loaded NewGRF.
Definition: newgrf.h:108
uint8_t landscape
the landscape we're currently in
TimerGameCalendar::Year starting_year
starting date
uint32_t generation_seed
noise seed for world generation
AISettings ai
what may the AI do?
GameCreationSettings game_creation
settings used during the creation of a game (map)
VehicleSettings vehicle
options for vehicles
Tindex index
Index of this pool item.
Definition: pool_type.hpp:238
static Titem * Get(size_t index)
Returns Titem with given index.
Definition: pool_type.hpp:339
static bool IsValidID(size_t index)
Tests whether given index can be used to get valid (non-nullptr) Titem.
Definition: pool_type.hpp:328
static bool CanAllocateItem(size_t n=1)
Helper functions so we can use PoolItem::Function() instead of _poolitem_pool.Function()
Definition: pool_type.hpp:309
static Titem * GetIfValid(size_t index)
Returns Titem with given index.
Definition: pool_type.hpp:350
static Pool::IterateWrapper< Titem > Iterate(size_t from=0)
Returns an iterable ensemble of all valid Titem.
Definition: pool_type.hpp:388
Base class for all pools.
Definition: pool_type.hpp:80
void CleanPool() override
Virtual method that deletes all items in the pool.
RailType railtype
Railtype, mangled if elrail is disabled.
Definition: engine_type.h:46
RoadType roadtype
Road type.
Definition: engine_type.h:128
Stores the state of all random number generators.
Definition: random_func.hpp:46
static Aircraft * From(Vehicle *v)
Converts a Vehicle to SpecializedVehicle with type checking.
Templated helper to make a type-safe 'typedef' representing a single POD value.
UnitID max_ships
max ships in game per company
UnitID max_trains
max trains in game per company
uint8_t extend_vehicle_life
extend vehicle life by this many years
UnitID max_aircraft
max planes in game per company
UnitID max_roadveh
max trucks in game per company
bool never_expire_vehicles
never expire vehicles
Vehicle data structure.
Definition: vehicle_base.h:244
EngineID engine_type
The type of engine used for this vehicle.
Definition: vehicle_base.h:323
CargoID cargo_type
type of cargo this vehicle is carrying
Definition: vehicle_base.h:342
uint8_t cargo_subtype
Used for livery refits (NewGRF variations)
Definition: vehicle_base.h:343
Definition of Interval and OneShot timers.
Definition of the game-calendar-timer.
Definition of the tick-based game-timer.
@ TRANSPORT_ROAD
Transport by road vehicle.
@ TRANSPORT_WATER
Transport over water.
@ TRANSPORT_AIR
Transport through air.
@ VE_DEFAULT
Default value to indicate that visual effect should be based on engine class.
Definition: vehicle_base.h:97
Functions related to vehicles.
bool IsCompanyBuildableVehicleType(VehicleType type)
Is the given vehicle type buildable by a company?
Definition: vehicle_func.h:91
VehicleType
Available vehicle types.
Definition: vehicle_type.h:21
@ VEH_ROAD
Road vehicle type.
Definition: vehicle_type.h:25
@ VEH_AIRCRAFT
Aircraft vehicle type.
Definition: vehicle_type.h:27
@ VEH_SHIP
Ship vehicle type.
Definition: vehicle_type.h:26
@ VEH_TRAIN
Train vehicle type.
Definition: vehicle_type.h:24
static const int GROUND_ACCELERATION
Acceleration due to gravity, 9.8 m/s^2.
Definition: vehicle_type.h:18
void CloseWindowById(WindowClass cls, WindowNumber number, bool force, int data)
Close a window by its class and window number (if it is open).
Definition: window.cpp:1140
void CloseWindowByClass(WindowClass cls, int data)
Close all windows of a given class.
Definition: window.cpp:1152
void SetWindowClassesDirty(WindowClass cls)
Mark all windows of a particular class as dirty (in need of repainting)
Definition: window.cpp:3119
void InvalidateWindowData(WindowClass cls, WindowNumber number, int data, bool gui_scope)
Mark window data of the window of a given class and specific window number as invalid (in need of re-...
Definition: window.cpp:3211
void InvalidateWindowClassesData(WindowClass cls, int data, bool gui_scope)
Mark window data of all windows of a given class as invalid (in need of re-computing) Note that by de...
Definition: window.cpp:3228
Window functions not directly related to making/drawing windows.
@ WC_BUILD_TOOLBAR
Build toolbar; Window numbers:
Definition: window_type.h:73
@ WC_REPLACE_VEHICLE
Replace vehicle window; Window numbers:
Definition: window_type.h:218
@ WC_ENGINE_PREVIEW
Engine preview window; Window numbers:
Definition: window_type.h:600
@ WC_MAIN_TOOLBAR
Main toolbar (the long bar at the top); Window numbers:
Definition: window_type.h:58
@ WC_BUILD_VEHICLE
Build vehicle; Window numbers:
Definition: window_type.h:389