OpenTTD Source  1.11.0-beta2
vehicle_base.h
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 #ifndef VEHICLE_BASE_H
11 #define VEHICLE_BASE_H
12 
13 #include "core/smallmap_type.hpp"
14 #include "track_type.h"
15 #include "command_type.h"
16 #include "order_base.h"
17 #include "cargopacket.h"
18 #include "texteff.hpp"
19 #include "engine_type.h"
20 #include "order_func.h"
21 #include "transport_type.h"
22 #include "group_type.h"
23 #include "base_consist.h"
24 #include "network/network.h"
25 #include <list>
26 #include <map>
27 
29 enum VehStatus {
30  VS_HIDDEN = 0x01,
31  VS_STOPPED = 0x02,
32  VS_UNCLICKABLE = 0x04,
33  VS_DEFPAL = 0x08,
35  VS_SHADOW = 0x20,
37  VS_CRASHED = 0x80,
38 };
39 
52 };
53 
62 };
63 
65 struct NewGRFCache {
66  /* Values calculated when they are requested for the first time after invalidating the NewGRF cache. */
72  uint8 cache_valid;
73 };
74 
80 
87 
91 
92  VE_DEFAULT = 0xFF,
93 };
94 
97  VESM_NONE = 0,
101 
102  VESM_END
103 };
104 
117 };
118 
120 struct VehicleCache {
123 
125 };
126 
129  PalSpriteID seq[4];
130  uint count;
131 
132  bool operator==(const VehicleSpriteSeq &other) const
133  {
134  return this->count == other.count && MemCmpT<PalSpriteID>(this->seq, other.seq, this->count) == 0;
135  }
136 
137  bool operator!=(const VehicleSpriteSeq &other) const
138  {
139  return !this->operator==(other);
140  }
141 
145  bool IsValid() const
146  {
147  return this->count != 0;
148  }
149 
153  void Clear()
154  {
155  this->count = 0;
156  }
157 
161  void Set(SpriteID sprite)
162  {
163  this->count = 1;
164  this->seq[0].sprite = sprite;
165  this->seq[0].pal = 0;
166  }
167 
172  {
173  this->count = src.count;
174  for (uint i = 0; i < src.count; ++i) {
175  this->seq[i].sprite = src.seq[i].sprite;
176  this->seq[i].pal = 0;
177  }
178  }
179 
180  void GetBounds(Rect *bounds) const;
181  void Draw(int x, int y, PaletteID default_pal, bool force_pal) const;
182 };
183 
194 };
195 
199 
200 /* Some declarations of functions, so we can make them friendly */
201 struct SaveLoad;
202 struct GroundVehicleCache;
203 extern const SaveLoad *GetVehicleDescription(VehicleType vt);
204 struct LoadgameState;
205 extern bool LoadOldVehicle(LoadgameState *ls, int num);
206 extern void FixOldVehicles();
207 
208 struct GRFFile;
209 
213 struct RefitDesc {
215  uint16 capacity;
216  uint16 remaining;
217  RefitDesc(CargoID cargo, uint16 capacity, uint16 remaining) :
219 };
220 
223 private:
224  typedef std::list<RefitDesc> RefitList;
225  typedef std::map<CargoID, uint> CapacitiesMap;
226 
230 
233 
234 public:
235  friend const SaveLoad *GetVehicleDescription(VehicleType vt);
236  friend void FixOldVehicles();
237  friend void AfterLoadVehicles(bool part_of_load);
238  friend bool LoadOldVehicle(LoadgameState *ls, int num);
239 
241 
248 
252 
254 
255  mutable Rect coord;
256 
259 
263 
265 
266  /* Related to age and service time */
271  uint16 reliability;
277 
278  int32 x_pos;
279  int32 y_pos;
280  int32 z_pos;
282 
284 
289  byte spritenum;
290  byte x_extent;
291  byte y_extent;
292  byte z_extent;
293  int8 x_bb_offs;
294  int8 y_bb_offs;
295  int8 x_offs;
296  int8 y_offs;
298 
299  TextEffectID fill_percent_te_id;
301 
302  uint16 cur_speed;
303  byte subspeed;
305  uint32 motion_counter;
306  byte progress;
307 
308  byte random_bits;
310 
313 
316  uint16 cargo_cap;
317  uint16 refit_cap;
321 
322  byte day_counter;
325 
326  byte vehstatus;
328 
329  union {
332  } orders;
333 
336  byte subtype;
337 
340 
342 
344 
345  void PreDestructor();
347  virtual ~Vehicle();
348 
349  void BeginLoading();
350  void CancelReservation(StationID next, Station *st);
351  void LeaveStation();
352 
355 
356  uint16 &GetGroundVehicleFlags();
357  const uint16 &GetGroundVehicleFlags() const;
358 
360 
361  void HandleLoading(bool mode = false);
362 
363  void GetConsistFreeCapacities(SmallMap<CargoID, uint> &capacities) const;
364 
365  uint GetConsistTotalCapacity() const;
366 
375  virtual void MarkDirty() {}
376 
381  virtual void UpdateDeltaXY() {}
382 
396  inline uint GetOldAdvanceSpeed(uint speed)
397  {
398  return (this->direction & 1) ? speed : speed * 3 / 4;
399  }
400 
413  static inline uint GetAdvanceSpeed(uint speed)
414  {
415  return speed * 3 / 4;
416  }
417 
425  inline uint GetAdvanceDistance()
426  {
427  return (this->direction & 1) ? 192 : 256;
428  }
429 
434  virtual ExpensesType GetExpenseType(bool income) const { return EXPENSES_OTHER; }
435 
439  virtual void PlayLeaveStationSound() const {}
440 
444  virtual bool IsPrimaryVehicle() const { return false; }
445 
446  const Engine *GetEngine() const;
447 
453  virtual void GetImage(Direction direction, EngineImageType image_type, VehicleSpriteSeq *result) const { result->Clear(); }
454 
455  const GRFFile *GetGRF() const;
456  uint32 GetGRFID() const;
457 
462  inline void InvalidateNewGRFCache()
463  {
464  this->grf_cache.cache_valid = 0;
465  }
466 
472  {
473  for (Vehicle *u = this; u != nullptr; u = u->Next()) {
474  u->InvalidateNewGRFCache();
475  }
476  }
477 
482  inline bool IsGroundVehicle() const
483  {
484  return this->type == VEH_TRAIN || this->type == VEH_ROAD;
485  }
486 
491  virtual int GetDisplaySpeed() const { return 0; }
492 
497  virtual int GetDisplayMaxSpeed() const { return 0; }
498 
503  virtual int GetCurrentMaxSpeed() const { return 0; }
504 
509  virtual Money GetRunningCost() const { return 0; }
510 
515  virtual bool IsInDepot() const { return false; }
516 
521  virtual bool IsChainInDepot() const { return this->IsInDepot(); }
522 
527  bool IsStoppedInDepot() const
528  {
529  assert(this == this->First());
530  /* Free wagons have no VS_STOPPED state */
531  if (this->IsPrimaryVehicle() && !(this->vehstatus & VS_STOPPED)) return false;
532  return this->IsChainInDepot();
533  }
534 
539  virtual bool Tick() { return true; };
540 
544  virtual void OnNewDay() {};
545 
551  virtual uint Crash(bool flooded = false);
552 
565  virtual Trackdir GetVehicleTrackdir() const { return INVALID_TRACKDIR; }
566 
571  Money GetDisplayRunningCost() const { return (this->GetRunningCost() >> 8); }
572 
577  Money GetDisplayProfitThisYear() const { return (this->profit_this_year >> 8); }
578 
583  Money GetDisplayProfitLastYear() const { return (this->profit_last_year >> 8); }
584 
585  void SetNext(Vehicle *next);
586 
592  inline Vehicle *Next() const { return this->next; }
593 
599  inline Vehicle *Previous() const { return this->previous; }
600 
605  inline Vehicle *First() const { return this->first; }
606 
611  inline Vehicle *Last()
612  {
613  Vehicle *v = this;
614  while (v->Next() != nullptr) v = v->Next();
615  return v;
616  }
617 
622  inline const Vehicle *Last() const
623  {
624  const Vehicle *v = this;
625  while (v->Next() != nullptr) v = v->Next();
626  return v;
627  }
628 
634  inline Vehicle *Move(int n)
635  {
636  Vehicle *v = this;
637  if (n < 0) {
638  for (int i = 0; i != n && v != nullptr; i--) v = v->Previous();
639  } else {
640  for (int i = 0; i != n && v != nullptr; i++) v = v->Next();
641  }
642  return v;
643  }
644 
650  inline const Vehicle *Move(int n) const
651  {
652  const Vehicle *v = this;
653  if (n < 0) {
654  for (int i = 0; i != n && v != nullptr; i--) v = v->Previous();
655  } else {
656  for (int i = 0; i != n && v != nullptr; i++) v = v->Next();
657  }
658  return v;
659  }
660 
665  inline Order *GetFirstOrder() const { return (this->orders.list == nullptr) ? nullptr : this->orders.list->GetFirstOrder(); }
666 
667  void AddToShared(Vehicle *shared_chain);
668  void RemoveFromShared();
669 
674  inline Vehicle *NextShared() const { return this->next_shared; }
675 
680  inline Vehicle *PreviousShared() const { return this->previous_shared; }
681 
686  inline Vehicle *FirstShared() const { return (this->orders.list == nullptr) ? this->First() : this->orders.list->GetFirstSharedVehicle(); }
687 
692  inline bool IsOrderListShared() const { return this->orders.list != nullptr && this->orders.list->IsShared(); }
693 
698  inline VehicleOrderID GetNumOrders() const { return (this->orders.list == nullptr) ? 0 : this->orders.list->GetNumOrders(); }
699 
704  inline VehicleOrderID GetNumManualOrders() const { return (this->orders.list == nullptr) ? 0 : this->orders.list->GetNumManualOrders(); }
705 
711  {
712  return (this->orders.list == nullptr) ? INVALID_STATION : this->orders.list->GetNextStoppingStation(this);
713  }
714 
715  void ResetRefitCaps();
716 
723  inline void CopyVehicleConfigAndStatistics(const Vehicle *src)
724  {
725  this->CopyConsistPropertiesFrom(src);
726 
727  this->unitnumber = src->unitnumber;
728 
729  this->current_order = src->current_order;
730  this->dest_tile = src->dest_tile;
731 
732  this->profit_this_year = src->profit_this_year;
733  this->profit_last_year = src->profit_last_year;
734  }
735 
736 
737  bool HandleBreakdown();
738 
739  bool NeedsAutorenewing(const Company *c, bool use_renew_setting = true) const;
740 
741  bool NeedsServicing() const;
742  bool NeedsAutomaticServicing() const;
743 
751  virtual TileIndex GetOrderStationLocation(StationID station) { return INVALID_TILE; }
752 
761  virtual bool FindClosestDepot(TileIndex *location, DestinationID *destination, bool *reverse) { return false; }
762 
763  virtual void SetDestTile(TileIndex tile) { this->dest_tile = tile; }
764 
766 
767  void UpdateVisualEffect(bool allow_power_change = true);
768  void ShowVisualEffect() const;
769 
770  void UpdatePosition();
771  void UpdateViewport(bool dirty);
772  void UpdateBoundingBoxCoordinates(bool update_cache) const;
774  bool MarkAllViewportsDirty() const;
775 
776  inline uint16 GetServiceInterval() const { return this->service_interval; }
777 
778  inline void SetServiceInterval(uint16 interval) { this->service_interval = interval; }
779 
780  inline bool ServiceIntervalIsCustom() const { return HasBit(this->vehicle_flags, VF_SERVINT_IS_CUSTOM); }
781 
782  inline bool ServiceIntervalIsPercent() const { return HasBit(this->vehicle_flags, VF_SERVINT_IS_PERCENT); }
783 
784  inline void SetServiceIntervalIsCustom(bool on) { SB(this->vehicle_flags, VF_SERVINT_IS_CUSTOM, 1, on); }
785 
786  inline void SetServiceIntervalIsPercent(bool on) { SB(this->vehicle_flags, VF_SERVINT_IS_PERCENT, 1, on); }
787 
788 private:
794  {
795  if (this->GetNumManualOrders() > 0) {
796  /* Advance to next real order */
797  do {
798  this->cur_real_order_index++;
799  if (this->cur_real_order_index >= this->GetNumOrders()) this->cur_real_order_index = 0;
800  } while (this->GetOrder(this->cur_real_order_index)->IsType(OT_IMPLICIT));
801  } else {
802  this->cur_real_order_index = 0;
803  }
804  }
805 
806 public:
813  {
814  if (this->cur_implicit_order_index == this->cur_real_order_index) {
815  /* Increment real order index as well */
816  this->SkipToNextRealOrderIndex();
817  }
818 
819  assert(this->cur_real_order_index == 0 || this->cur_real_order_index < this->GetNumOrders());
820 
821  /* Advance to next implicit order */
822  do {
823  this->cur_implicit_order_index++;
824  if (this->cur_implicit_order_index >= this->GetNumOrders()) this->cur_implicit_order_index = 0;
825  } while (this->cur_implicit_order_index != this->cur_real_order_index && !this->GetOrder(this->cur_implicit_order_index)->IsType(OT_IMPLICIT));
826 
827  InvalidateVehicleOrder(this, 0);
828  }
829 
837  {
838  if (this->cur_implicit_order_index == this->cur_real_order_index) {
839  /* Increment both real and implicit order */
841  } else {
842  /* Increment real order only */
843  this->SkipToNextRealOrderIndex();
844  InvalidateVehicleOrder(this, 0);
845  }
846  }
847 
852  {
853  /* Make sure the index is valid */
854  if (this->cur_real_order_index >= this->GetNumOrders()) this->cur_real_order_index = 0;
855 
856  if (this->GetNumManualOrders() > 0) {
857  /* Advance to next real order */
858  while (this->GetOrder(this->cur_real_order_index)->IsType(OT_IMPLICIT)) {
859  this->cur_real_order_index++;
860  if (this->cur_real_order_index >= this->GetNumOrders()) this->cur_real_order_index = 0;
861  }
862  } else {
863  this->cur_real_order_index = 0;
864  }
865  }
866 
872  inline Order *GetOrder(int index) const
873  {
874  return (this->orders.list == nullptr) ? nullptr : this->orders.list->GetOrderAt(index);
875  }
876 
881  inline Order *GetLastOrder() const
882  {
883  return (this->orders.list == nullptr) ? nullptr : this->orders.list->GetLastOrder();
884  }
885 
886  bool IsEngineCountable() const;
887  bool HasEngineType() const;
888  bool HasDepotOrder() const;
889  void HandlePathfindingResult(bool path_found);
890 
895  inline bool IsFrontEngine() const
896  {
897  return this->IsGroundVehicle() && HasBit(this->subtype, GVSF_FRONT);
898  }
899 
904  inline bool IsArticulatedPart() const
905  {
906  return this->IsGroundVehicle() && HasBit(this->subtype, GVSF_ARTICULATED_PART);
907  }
908 
913  inline bool HasArticulatedPart() const
914  {
915  return this->Next() != nullptr && this->Next()->IsArticulatedPart();
916  }
917 
924  {
925  assert(this->HasArticulatedPart());
926  return this->Next();
927  }
928 
934  {
935  Vehicle *v = this;
936  while (v->IsArticulatedPart()) v = v->Previous();
937  return v;
938  }
939 
944  inline const Vehicle *GetFirstEnginePart() const
945  {
946  const Vehicle *v = this;
947  while (v->IsArticulatedPart()) v = v->Previous();
948  return v;
949  }
950 
956  {
957  Vehicle *v = this;
958  while (v->HasArticulatedPart()) v = v->GetNextArticulatedPart();
959  return v;
960  }
961 
966  inline Vehicle *GetNextVehicle() const
967  {
968  const Vehicle *v = this;
969  while (v->HasArticulatedPart()) v = v->GetNextArticulatedPart();
970 
971  /* v now contains the last articulated part in the engine */
972  return v->Next();
973  }
974 
979  inline Vehicle *GetPrevVehicle() const
980  {
981  Vehicle *v = this->Previous();
982  while (v != nullptr && v->IsArticulatedPart()) v = v->Previous();
983 
984  return v;
985  }
986 
991  struct OrderIterator {
992  typedef Order value_type;
993  typedef Order* pointer;
994  typedef Order& reference;
995  typedef size_t difference_type;
996  typedef std::forward_iterator_tag iterator_category;
997 
998  explicit OrderIterator(OrderList *list) : list(list), prev(nullptr)
999  {
1000  this->order = (this->list == nullptr) ? nullptr : this->list->GetFirstOrder();
1001  }
1002 
1003  bool operator==(const OrderIterator &other) const { return this->order == other.order; }
1004  bool operator!=(const OrderIterator &other) const { return !(*this == other); }
1005  Order * operator*() const { return this->order; }
1006  OrderIterator & operator++()
1007  {
1008  this->prev = (this->prev == nullptr) ? this->list->GetFirstOrder() : this->prev->next;
1009  this->order = (this->prev == nullptr) ? nullptr : this->prev->next;
1010  return *this;
1011  }
1012 
1013  private:
1014  OrderList *list;
1015  Order *order;
1016  Order *prev;
1017  };
1018 
1023  OrderList *list;
1024  IterateWrapper(OrderList *list = nullptr) : list(list) {}
1025  OrderIterator begin() { return OrderIterator(this->list); }
1026  OrderIterator end() { return OrderIterator(nullptr); }
1027  bool empty() { return this->begin() == this->end(); }
1028  };
1029 
1034  IterateWrapper Orders() const { return IterateWrapper(this->orders.list); }
1035 };
1036 
1041 template <class T, VehicleType Type>
1042 struct SpecializedVehicle : public Vehicle {
1043  static const VehicleType EXPECTED_TYPE = Type;
1044 
1046 
1051  {
1052  this->sprite_cache.sprite_seq.count = 1;
1053  }
1054 
1059  inline T *First() const { return (T *)this->Vehicle::First(); }
1060 
1065  inline T *Last() { return (T *)this->Vehicle::Last(); }
1066 
1071  inline const T *Last() const { return (const T *)this->Vehicle::Last(); }
1072 
1077  inline T *Next() const { return (T *)this->Vehicle::Next(); }
1078 
1083  inline T *Previous() const { return (T *)this->Vehicle::Previous(); }
1084 
1090  inline T *GetNextArticulatedPart() { return (T *)this->Vehicle::GetNextArticulatedPart(); }
1091 
1097  inline T *GetNextArticulatedPart() const { return (T *)this->Vehicle::GetNextArticulatedPart(); }
1098 
1103  inline T *GetFirstEnginePart() { return (T *)this->Vehicle::GetFirstEnginePart(); }
1104 
1109  inline const T *GetFirstEnginePart() const { return (const T *)this->Vehicle::GetFirstEnginePart(); }
1110 
1115  inline T *GetLastEnginePart() { return (T *)this->Vehicle::GetLastEnginePart(); }
1116 
1121  inline T *GetNextVehicle() const { return (T *)this->Vehicle::GetNextVehicle(); }
1122 
1127  inline T *GetPrevVehicle() const { return (T *)this->Vehicle::GetPrevVehicle(); }
1128 
1134  static inline bool IsValidID(size_t index)
1135  {
1136  return Vehicle::IsValidID(index) && Vehicle::Get(index)->type == Type;
1137  }
1138 
1143  static inline T *Get(size_t index)
1144  {
1145  return (T *)Vehicle::Get(index);
1146  }
1147 
1152  static inline T *GetIfValid(size_t index)
1153  {
1154  return IsValidID(index) ? Get(index) : nullptr;
1155  }
1156 
1162  static inline T *From(Vehicle *v)
1163  {
1164  assert(v->type == Type);
1165  return (T *)v;
1166  }
1167 
1173  static inline const T *From(const Vehicle *v)
1174  {
1175  assert(v->type == Type);
1176  return (const T *)v;
1177  }
1178 
1184  inline void UpdateViewport(bool force_update, bool update_delta)
1185  {
1186  bool sprite_has_changed = false;
1187 
1188  /* Skip updating sprites on dedicated servers without screen */
1189  if (_network_dedicated) return;
1190 
1191  /* Explicitly choose method to call to prevent vtable dereference -
1192  * it gives ~3% runtime improvements in games with many vehicles */
1193  if (update_delta) ((T *)this)->T::UpdateDeltaXY();
1194 
1195  /*
1196  * Only check for a new sprite sequence if the vehicle direction
1197  * has changed since we last checked it, assuming that otherwise
1198  * there won't be enough change in bounding box or offsets to need
1199  * to resolve a new sprite.
1200  */
1201  if (this->direction != this->sprite_cache.last_direction || this->sprite_cache.is_viewport_candidate) {
1202  VehicleSpriteSeq seq;
1203 
1204  ((T*)this)->T::GetImage(this->direction, EIT_ON_MAP, &seq);
1205  if (this->sprite_cache.sprite_seq != seq) {
1206  sprite_has_changed = true;
1207  this->sprite_cache.sprite_seq = seq;
1208  }
1209 
1210  this->sprite_cache.last_direction = this->direction;
1211  this->sprite_cache.revalidate_before_draw = false;
1212  } else {
1213  /*
1214  * A change that could potentially invalidate the sprite has been
1215  * made, signal that we should still resolve it before drawing on a
1216  * viewport.
1217  */
1218  this->sprite_cache.revalidate_before_draw = true;
1219  }
1220 
1221  if (force_update || sprite_has_changed) {
1222  this->Vehicle::UpdateViewport(true);
1223  }
1224  }
1225 
1231  static Pool::IterateWrapper<T> Iterate(size_t from = 0) { return Pool::IterateWrapper<T>(from); }
1232 };
1233 
1236  bool *cache;
1239 
1241  UnitID NextID();
1242 
1244  ~FreeUnitIDGenerator() { free(this->cache); }
1245 };
1246 
1248 static const int32 INVALID_COORD = 0x7fffffff;
1249 
1250 #endif /* VEHICLE_BASE_H */
SpecializedVehicle::GetNextVehicle
T * GetNextVehicle() const
Get the next real (non-articulated part) vehicle in the consist.
Definition: vehicle_base.h:1121
GVSF_ENGINE
@ GVSF_ENGINE
Engine that can be front engine, but might be placed behind another engine (not used for road vehicle...
Definition: vehicle_base.h:114
Vehicle::GetGroundVehicleCache
GroundVehicleCache * GetGroundVehicleCache()
Access the ground vehicle cache of the vehicle.
Definition: vehicle.cpp:2883
Vehicle::IsChainInDepot
virtual bool IsChainInDepot() const
Check whether the whole vehicle chain is in the depot.
Definition: vehicle_base.h:521
BaseConsist::cur_implicit_order_index
VehicleOrderID cur_implicit_order_index
The index to the current implicit order.
Definition: base_consist.h:29
Vehicle::SkipToNextRealOrderIndex
void SkipToNextRealOrderIndex()
Advance cur_real_order_index to the next real order.
Definition: vehicle_base.h:793
VehicleOrderID
byte VehicleOrderID
The index of an order within its current vehicle (not pool related)
Definition: order_type.h:15
MutableSpriteCache::is_viewport_candidate
bool is_viewport_candidate
This vehicle can potentially be drawn on a viewport.
Definition: vehicle_base.h:192
TileIndex
uint32 TileIndex
The index/ID of a Tile.
Definition: tile_type.h:78
transport_type.h
LoadgameState
Definition: oldloader.h:19
SmallStack
Minimal stack that uses a pool to avoid pointers.
Definition: smallstack_type.hpp:136
MutableSpriteCache::last_direction
Direction last_direction
Last direction we obtained sprites for.
Definition: vehicle_base.h:189
VE_OFFSET_COUNT
@ VE_OFFSET_COUNT
Number of bits used for the offset.
Definition: vehicle_base.h:78
VE_DISABLE_EFFECT
@ VE_DISABLE_EFFECT
Flag to disable visual effect.
Definition: vehicle_base.h:88
Vehicle::PreDestructor
void PreDestructor()
Destroy all stuff that (still) needs the virtual functions to work properly.
Definition: vehicle.cpp:800
Pool::PoolItem<&_vehicle_pool >::Get
static Titem * Get(size_t index)
Returns Titem with given index.
Definition: pool_type.hpp:329
Direction
Direction
Defines the 8 directions on the map.
Definition: direction_type.h:24
Vehicle::y_pos
int32 y_pos
y coordinate.
Definition: vehicle_base.h:279
SpecializedVehicle::SpecializedVehicleBase
SpecializedVehicle< T, Type > SpecializedVehicleBase
Our type.
Definition: vehicle_base.h:1045
MutableSpriteCache::sprite_seq
VehicleSpriteSeq sprite_seq
Vehicle appearance.
Definition: vehicle_base.h:193
VehicleSpriteSeq::CopyWithoutPalette
void CopyWithoutPalette(const VehicleSpriteSeq &src)
Copy data from another sprite sequence, while dropping all recolouring information.
Definition: vehicle_base.h:171
Vehicle::PreviousShared
Vehicle * PreviousShared() const
Get the previous vehicle of the shared vehicle chain.
Definition: vehicle_base.h:680
Vehicle::GetNumManualOrders
VehicleOrderID GetNumManualOrders() const
Get the number of manually added orders this vehicle has.
Definition: vehicle_base.h:704
Vehicle::GetRunningCost
virtual Money GetRunningCost() const
Gets the running cost of a vehicle.
Definition: vehicle_base.h:509
Vehicle::value
Money value
Value of the vehicle.
Definition: vehicle_base.h:251
Vehicle::x_pos
int32 x_pos
x coordinate.
Definition: vehicle_base.h:278
_vehicle_pool
VehiclePool _vehicle_pool
The pool with all our precious vehicles.
RefitDesc::capacity
uint16 capacity
Capacity the vehicle will have.
Definition: vehicle_base.h:215
Vehicle::HasEngineType
bool HasEngineType() const
Check whether Vehicle::engine_type has any meaning.
Definition: vehicle.cpp:725
Vehicle::GetGroundVehicleFlags
uint16 & GetGroundVehicleFlags()
Access the ground vehicle flags of the vehicle.
Definition: vehicle.cpp:2913
Vehicle::IsEngineCountable
bool IsEngineCountable() const
Check if a vehicle is counted in num_engines in each company struct.
Definition: vehicle.cpp:708
Vehicle::Previous
Vehicle * Previous() const
Get the previous vehicle of this vehicle.
Definition: vehicle_base.h:599
Vehicle::GetNextVehicle
Vehicle * GetNextVehicle() const
Get the next real (non-articulated part) vehicle in the consist.
Definition: vehicle_base.h:966
Vehicle::UpdateDeltaXY
virtual void UpdateDeltaXY()
Updates the x and y offsets and the size of the sprite used for this vehicle.
Definition: vehicle_base.h:381
Vehicle::LeaveStation
void LeaveStation()
Perform all actions when leaving a station.
Definition: vehicle.cpp:2239
Vehicle::Next
Vehicle * Next() const
Get the next vehicle of this vehicle.
Definition: vehicle_base.h:592
SpecializedVehicle::Next
T * Next() const
Get next vehicle in the chain.
Definition: vehicle_base.h:1077
EXPENSES_OTHER
@ EXPENSES_OTHER
Other expenses.
Definition: economy_type.h:170
Vehicle::GetDisplayMaxSpeed
virtual int GetDisplayMaxSpeed() const
Gets the maximum speed in km-ish/h that can be sent into SetDParam for string processing.
Definition: vehicle_base.h:497
Vehicle::y_extent
byte y_extent
y-extent of vehicle bounding box
Definition: vehicle_base.h:291
UnitID
uint16 UnitID
Type for the company global vehicle unit number.
Definition: transport_type.h:16
Station
Station data structure.
Definition: station_base.h:450
RefitDesc::remaining
uint16 remaining
Capacity remaining from before the previous refit.
Definition: vehicle_base.h:216
Vehicle::NeedsAutomaticServicing
bool NeedsAutomaticServicing() const
Checks if the current order should be interrupted for a service-in-depot order.
Definition: vehicle.cpp:252
Vehicle::z_pos
int32 z_pos
z coordinate.
Definition: vehicle_base.h:280
Vehicle::load_unload_ticks
uint16 load_unload_ticks
Ticks to wait before starting next cycle.
Definition: vehicle_base.h:334
Vehicle::GetLastEnginePart
Vehicle * GetLastEnginePart()
Get the last part of an articulated engine.
Definition: vehicle_base.h:955
VehicleSpriteSeq::Clear
void Clear()
Clear all information.
Definition: vehicle_base.h:153
VehicleSpriteSeq::Set
void Set(SpriteID sprite)
Assign a single sprite to the sequence.
Definition: vehicle_base.h:161
NewGRFCache::position_same_id_length
uint32 position_same_id_length
Cache for NewGRF var 41.
Definition: vehicle_base.h:68
FreeUnitIDGenerator::curid
UnitID curid
last ID returned; 0 if none
Definition: vehicle_base.h:1238
Vehicle::random_bits
byte random_bits
Bits used for determining which randomized variational spritegroups to use when drawing.
Definition: vehicle_base.h:308
Vehicle::vehstatus
byte vehstatus
Status.
Definition: vehicle_base.h:326
VE_DEFAULT
@ VE_DEFAULT
Default value to indicate that visual effect should be based on engine class.
Definition: vehicle_base.h:92
Vehicle::grf_cache
NewGRFCache grf_cache
Cache of often used calculated NewGRF values.
Definition: vehicle_base.h:338
VS_DEFPAL
@ VS_DEFPAL
Use default vehicle palette.
Definition: vehicle_base.h:33
Pool::PoolItem<&_vehicle_pool >::index
Tindex index
Index of this pool item.
Definition: pool_type.hpp:227
Vehicle::SetNext
void SetNext(Vehicle *next)
Set the next vehicle of this vehicle.
Definition: vehicle.cpp:2718
order_base.h
Vehicle::Crash
virtual uint Crash(bool flooded=false)
Crash the (whole) vehicle chain.
Definition: vehicle.cpp:260
Vehicle::acceleration
byte acceleration
used by train & aircraft
Definition: vehicle_base.h:304
PalSpriteID::sprite
SpriteID sprite
The 'real' sprite.
Definition: gfx_type.h:23
Vehicle::group_id
GroupID group_id
Index of group Pool array.
Definition: vehicle_base.h:335
Vehicle::Vehicle
Vehicle(VehicleType type=VEH_INVALID)
Vehicle constructor.
Definition: vehicle.cpp:345
Vehicle::old
Order * old
Only used during conversion of old save games.
Definition: vehicle_base.h:331
HasBit
static bool HasBit(const T x, const uint8 y)
Checks if a bit in a value is set.
Definition: bitmath_func.hpp:103
GroundVehicleSubtypeFlags
GroundVehicleSubtypeFlags
Enum to handle ground vehicle subtypes.
Definition: vehicle_base.h:110
VE_TYPE_ELECTRIC
@ VE_TYPE_ELECTRIC
Electric sparks.
Definition: vehicle_base.h:86
Vehicle::next
Vehicle * next
pointer to the next vehicle in the chain
Definition: vehicle_base.h:227
Vehicle::GetGRF
const GRFFile * GetGRF() const
Retrieve the NewGRF the vehicle is tied to.
Definition: vehicle.cpp:751
Year
int32 Year
Type for the year, note: 0 based, i.e. starts at the year 0.
Definition: date_type.h:18
NewGRFCache::cache_valid
uint8 cache_valid
Bitset that indicates which cache values are valid.
Definition: vehicle_base.h:72
VF_LOADING_FINISHED
@ VF_LOADING_FINISHED
Vehicle has finished loading.
Definition: vehicle_base.h:42
SpecializedVehicle::GetNextArticulatedPart
T * GetNextArticulatedPart()
Get the next part of an articulated engine.
Definition: vehicle_base.h:1090
Vehicle::running_ticks
byte running_ticks
Number of ticks this vehicle was not stopped this day.
Definition: vehicle_base.h:324
Vehicle::~Vehicle
virtual ~Vehicle()
We want to 'destruct' the right class.
Definition: vehicle.cpp:866
base_consist.h
VE_TYPE_COUNT
@ VE_TYPE_COUNT
Number of bits used for the effect type.
Definition: vehicle_base.h:82
Vehicle::GetConsistFreeCapacities
void GetConsistFreeCapacities(SmallMap< CargoID, uint > &capacities) const
Get a map of cargoes and free capacities in the consist.
Definition: vehicle.cpp:2336
VS_TRAIN_SLOWING
@ VS_TRAIN_SLOWING
Train is slowing down.
Definition: vehicle_base.h:34
Vehicle::OrderIterator
Iterator to iterate orders Supports deletion of current order.
Definition: vehicle_base.h:991
smallmap_type.hpp
Vehicle::GetNextArticulatedPart
Vehicle * GetNextArticulatedPart() const
Get the next part of an articulated engine.
Definition: vehicle_base.h:923
Vehicle::AfterLoadVehicles
friend void AfterLoadVehicles(bool part_of_load)
So we can set the previous and first pointers while loading.
Definition: vehicle_sl.cpp:240
EngineImageType
EngineImageType
Visualisation contexts of vehicles and engines.
Definition: vehicle_type.h:85
Engine
Definition: engine_base.h:21
VEH_ROAD
@ VEH_ROAD
Road vehicle type.
Definition: vehicle_type.h:25
Vehicle::cur_speed
uint16 cur_speed
current speed
Definition: vehicle_base.h:302
Vehicle
Vehicle data structure.
Definition: vehicle_base.h:222
Vehicle::IsPrimaryVehicle
virtual bool IsPrimaryVehicle() const
Whether this is the primary vehicle in the chain.
Definition: vehicle_base.h:444
Vehicle::IsGroundVehicle
bool IsGroundVehicle() const
Check if the vehicle is a ground vehicle.
Definition: vehicle_base.h:482
VehicleSpriteSeq::Draw
void Draw(int x, int y, PaletteID default_pal, bool force_pal) const
Draw the sprite sequence.
Definition: vehicle.cpp:126
Vehicle::owner
Owner owner
Which company owns the vehicle?
Definition: vehicle_base.h:283
Owner
Owner
Enum for all companies/owners.
Definition: company_type.h:18
VehicleCache::cached_cargo_age_period
uint16 cached_cargo_age_period
Number of ticks before carried cargo is aged.
Definition: vehicle_base.h:122
Vehicle::IsInDepot
virtual bool IsInDepot() const
Check whether the vehicle is in the depot.
Definition: vehicle_base.h:515
VS_AIRCRAFT_BROKEN
@ VS_AIRCRAFT_BROKEN
Aircraft is broken down.
Definition: vehicle_base.h:36
DoCommandFlag
DoCommandFlag
List of flags for a command.
Definition: command_type.h:346
VE_OFFSET_START
@ VE_OFFSET_START
First bit that contains the offset (0 = front, 8 = centre, 15 = rear)
Definition: vehicle_base.h:77
Vehicle::breakdowns_since_last_service
byte breakdowns_since_last_service
Counter for the amount of breakdowns.
Definition: vehicle_base.h:275
Vehicle::UpdateRealOrderIndex
void UpdateRealOrderIndex()
Skip implicit orders until cur_real_order_index is a non-implicit order.
Definition: vehicle_base.h:851
NCVV_POSITION_IN_VEHICLE
@ NCVV_POSITION_IN_VEHICLE
This bit will be set if the NewGRF var 4D currently stored is valid.
Definition: vehicle_base.h:60
SmallMap
Implementation of simple mapping class.
Definition: smallmap_type.hpp:26
Vehicle::IsArticulatedPart
bool IsArticulatedPart() const
Check if the vehicle is an articulated part of an engine.
Definition: vehicle_base.h:904
VehicleCargoList
CargoList that is used for vehicles.
Definition: cargopacket.h:268
SpriteID
uint32 SpriteID
The number of a sprite, without mapping bits and colourtables.
Definition: gfx_type.h:17
VF_STOP_LOADING
@ VF_STOP_LOADING
Don't load anymore during the next load cycle.
Definition: vehicle_base.h:48
VE_TYPE_DIESEL
@ VE_TYPE_DIESEL
Diesel fumes.
Definition: vehicle_base.h:85
VESM_STEAM
@ VESM_STEAM
Steam model.
Definition: vehicle_base.h:98
Vehicle::GetDisplayRunningCost
Money GetDisplayRunningCost() const
Gets the running cost of a vehicle that can be sent into SetDParam for string processing.
Definition: vehicle_base.h:571
VF_AUTOFILL_TIMETABLE
@ VF_AUTOFILL_TIMETABLE
Whether the vehicle should fill in the timetable automatically.
Definition: vehicle_base.h:46
MutableSpriteCache
Cache for vehicle sprites and values relating to whether they should be updated before drawing,...
Definition: vehicle_base.h:188
Vehicle::Orders
IterateWrapper Orders() const
Returns an iterable ensemble of orders of a vehicle.
Definition: vehicle_base.h:1034
Vehicle::Last
const Vehicle * Last() const
Get the last vehicle of this vehicle chain.
Definition: vehicle_base.h:622
Vehicle::BeginLoading
void BeginLoading()
Prepare everything to begin the loading when arriving at a station.
Definition: vehicle.cpp:2092
Vehicle::breakdown_ctr
byte breakdown_ctr
Counter for managing breakdown events.
Definition: vehicle_base.h:273
VS_HIDDEN
@ VS_HIDDEN
Vehicle is not visible.
Definition: vehicle_base.h:30
EngineID
uint16 EngineID
Unique identification number of an engine.
Definition: engine_type.h:21
Vehicle::UpdateVisualEffect
void UpdateVisualEffect(bool allow_power_change=true)
Update the cached visual effect.
Definition: vehicle.cpp:2445
VehicleSpriteSeq::IsValid
bool IsValid() const
Check whether the sequence contains any sprites.
Definition: vehicle_base.h:145
Vehicle::dest_tile
TileIndex dest_tile
Heading for this tile.
Definition: vehicle_base.h:247
Vehicle::HandlePathfindingResult
void HandlePathfindingResult(bool path_found)
Handle the pathfinding result, especially the lost status.
Definition: vehicle.cpp:773
Vehicle::GetDisplayProfitThisYear
Money GetDisplayProfitThisYear() const
Gets the profit vehicle had this year.
Definition: vehicle_base.h:577
Vehicle::GetDisplaySpeed
virtual int GetDisplaySpeed() const
Gets the speed in km-ish/h that can be sent into SetDParam for string processing.
Definition: vehicle_base.h:491
Vehicle::GetPrevVehicle
Vehicle * GetPrevVehicle() const
Get the previous real (non-articulated part) vehicle in the consist.
Definition: vehicle_base.h:979
VE_TYPE_START
@ VE_TYPE_START
First bit used for the type of effect.
Definition: vehicle_base.h:81
GroundVehicleCache
Cached, frequently calculated values.
Definition: ground_vehicle.hpp:29
CommandCost
Common return value for all commands.
Definition: command_type.h:23
Vehicle::UpdateBoundingBoxCoordinates
void UpdateBoundingBoxCoordinates(bool update_cache) const
Update the bounding box co-ordinates of the vehicle.
Definition: vehicle.cpp:1604
BaseVehicle
Base vehicle class.
Definition: vehicle_type.h:50
Vehicle::GetCurrentMaxSpeed
virtual int GetCurrentMaxSpeed() const
Calculates the maximum speed of the vehicle under its current conditions.
Definition: vehicle_base.h:503
FreeUnitIDGenerator::NextID
UnitID NextID()
Returns next free UnitID.
Definition: vehicle.cpp:1771
Vehicle::AddToShared
void AddToShared(Vehicle *shared_chain)
Adds this vehicle to a shared vehicle chain.
Definition: vehicle.cpp:2747
VehStatus
VehStatus
Vehicle status bits in Vehicle::vehstatus.
Definition: vehicle_base.h:29
NewGRFCache::consist_cargo_information
uint32 consist_cargo_information
Cache for NewGRF var 42. (Note: The cargotype is untranslated in the cache because the accessing GRF ...
Definition: vehicle_base.h:69
Vehicle::RemoveFromShared
void RemoveFromShared()
Removes the vehicle from the shared order list.
Definition: vehicle.cpp:2770
VF_CARGO_UNLOADING
@ VF_CARGO_UNLOADING
Vehicle is unloading cargo.
Definition: vehicle_base.h:43
NCVV_POSITION_CONSIST_LENGTH
@ NCVV_POSITION_CONSIST_LENGTH
This bit will be set if the NewGRF var 40 currently stored is valid.
Definition: vehicle_base.h:56
Vehicle::tile
TileIndex tile
Current tile index.
Definition: vehicle_base.h:240
Vehicle::CancelReservation
void CancelReservation(StationID next, Station *st)
Return all reserved cargo packets to the station and reset all packets staged for transfer.
Definition: vehicle.cpp:2222
EIT_ON_MAP
@ EIT_ON_MAP
Vehicle drawn in viewport.
Definition: vehicle_type.h:86
Vehicle::engine_type
EngineID engine_type
The type of engine used for this vehicle.
Definition: vehicle_base.h:297
VS_CRASHED
@ VS_CRASHED
Vehicle is crashed.
Definition: vehicle_base.h:37
VehicleSpriteSeq
Sprite sequence for a vehicle part.
Definition: vehicle_base.h:128
SB
static T SB(T &x, const uint8 s, const uint8 n, const U d)
Set n bits in x starting at bit s to d.
Definition: bitmath_func.hpp:58
LoadOldVehicle
bool LoadOldVehicle(LoadgameState *ls, int num)
Load the vehicles of an old style savegame.
Definition: oldloader_sl.cpp:1221
Vehicle::last_station_visited
StationID last_station_visited
The last station we stopped at.
Definition: vehicle_base.h:311
Vehicle::GetVehicleTrackdir
virtual Trackdir GetVehicleTrackdir() const
Returns the Trackdir on which the vehicle is currently located.
Definition: vehicle_base.h:565
CargoPayment
Helper class to perform the cargo payment.
Definition: economy_base.h:24
Vehicle::cargo
VehicleCargoList cargo
The cargo this vehicle is carrying.
Definition: vehicle_base.h:318
Vehicle::GetOldAdvanceSpeed
uint GetOldAdvanceSpeed(uint speed)
Determines the effective direction-specific vehicle movement speed.
Definition: vehicle_base.h:396
VehicleFlags
VehicleFlags
Bit numbers in Vehicle::vehicle_flags.
Definition: vehicle_base.h:41
Vehicle::GetExpenseType
virtual ExpensesType GetExpenseType(bool income) const
Sets the expense type associated to this vehicle type.
Definition: vehicle_base.h:434
SpecializedVehicle
Class defining several overloaded accessors so we don't have to cast vehicle types that often.
Definition: vehicle_base.h:1042
Vehicle::hash_tile_current
Vehicle ** hash_tile_current
NOSAVE: Cache of the current hash chain.
Definition: vehicle_base.h:262
GVSF_ARTICULATED_PART
@ GVSF_ARTICULATED_PART
Articulated part of an engine.
Definition: vehicle_base.h:112
Vehicle::current_order
Order current_order
The current order (+ status, like: loading)
Definition: vehicle_base.h:327
FreeUnitIDGenerator::~FreeUnitIDGenerator
~FreeUnitIDGenerator()
Releases allocated memory.
Definition: vehicle_base.h:1244
Date
int32 Date
The type to store our dates in.
Definition: date_type.h:14
Vehicle::max_age
Date max_age
Maximum age.
Definition: vehicle_base.h:269
Vehicle::IsFrontEngine
bool IsFrontEngine() const
Check if the vehicle is a front engine.
Definition: vehicle_base.h:895
Vehicle::GetLastOrder
Order * GetLastOrder() const
Returns the last order of a vehicle, or nullptr if it doesn't exists.
Definition: vehicle_base.h:881
FreeUnitIDGenerator
Generates sequence of free UnitID numbers.
Definition: vehicle_base.h:1235
SpecializedVehicle::Get
static T * Get(size_t index)
Gets vehicle with given index.
Definition: vehicle_base.h:1143
Pool::IterateWrapper
Definition: pool_type.hpp:171
VS_STOPPED
@ VS_STOPPED
Vehicle is stopped by the player.
Definition: vehicle_base.h:31
Vehicle::trip_occupancy
int8 trip_occupancy
NOSAVE: Occupancy of vehicle of the current trip (updated after leaving a station).
Definition: vehicle_base.h:320
Vehicle::GetGRFID
uint32 GetGRFID() const
Retrieve the GRF ID of the NewGRF the vehicle is tied to.
Definition: vehicle.cpp:761
VehicleCache
Cached often queried values common to all vehicles.
Definition: vehicle_base.h:120
Vehicle::ShowVisualEffect
void ShowVisualEffect() const
Draw visual effects (smoke and/or sparks) for a vehicle chain.
Definition: vehicle.cpp:2568
Vehicle::GetEngine
const Engine * GetEngine() const
Retrieves the engine of the vehicle.
Definition: vehicle.cpp:741
VisualEffectSpawnModel
VisualEffectSpawnModel
Models for spawning visual effects.
Definition: vehicle_base.h:96
Vehicle::CopyVehicleConfigAndStatistics
void CopyVehicleConfigAndStatistics(const Vehicle *src)
Copy certain configurations and statistics of a vehicle after successful autoreplace/renew The functi...
Definition: vehicle_base.h:723
cargopacket.h
Vehicle::ResetRefitCaps
void ResetRefitCaps()
Reset all refit_cap in the consist to cargo_cap.
Definition: vehicle.cpp:2291
Vehicle::reliability_spd_dec
uint16 reliability_spd_dec
Reliability decrease speed.
Definition: vehicle_base.h:272
Vehicle::UpdateViewport
void UpdateViewport(bool dirty)
Update the vehicle on the viewport, updating the right hash and setting the new coordinates.
Definition: vehicle.cpp:1637
Vehicle::last_loading_station
StationID last_loading_station
Last station the vehicle has stopped at and could possibly leave from with any cargo loaded.
Definition: vehicle_base.h:312
VEH_INVALID
@ VEH_INVALID
Non-existing type of vehicle.
Definition: vehicle_type.h:35
VF_SERVINT_IS_CUSTOM
@ VF_SERVINT_IS_CUSTOM
Service interval is custom.
Definition: vehicle_base.h:50
Vehicle::previous_shared
Vehicle * previous_shared
NOSAVE: pointer to the previous vehicle in the shared order chain.
Definition: vehicle_base.h:232
DepotCommand
DepotCommand
Flags to add to p1 for goto depot commands.
Definition: vehicle_type.h:65
Vehicle::profit_this_year
Money profit_this_year
Profit this year << 8, low 8 bits are fract.
Definition: vehicle_base.h:249
VehiclePool
Pool< Vehicle, VehicleID, 512, 0xFF000 > VehiclePool
A vehicle pool for a little over 1 million vehicles.
Definition: vehicle_base.h:197
Vehicle::MarkAllViewportsDirty
bool MarkAllViewportsDirty() const
Marks viewports dirty where the vehicle's image is.
Definition: vehicle.cpp:1670
Vehicle::PlayLeaveStationSound
virtual void PlayLeaveStationSound() const
Play the sound associated with leaving the station.
Definition: vehicle_base.h:439
GVSF_WAGON
@ GVSF_WAGON
Wagon (not used for road vehicles).
Definition: vehicle_base.h:113
INVALID_TRACKDIR
@ INVALID_TRACKDIR
Flag for an invalid trackdir.
Definition: track_type.h:89
FixOldVehicles
void FixOldVehicles()
Convert the old style vehicles into something that resembles the old new style savegames.
Definition: oldloader_sl.cpp:171
VehicleCache::cached_vis_effect
byte cached_vis_effect
Visual effect to show (see VisualEffect)
Definition: vehicle_base.h:124
Vehicle::FindClosestDepot
virtual bool FindClosestDepot(TileIndex *location, DestinationID *destination, bool *reverse)
Find the closest depot for this vehicle and tell us the location, DestinationID and whether we should...
Definition: vehicle_base.h:761
Vehicle::HandleLoading
void HandleLoading(bool mode=false)
Handle the loading of the vehicle; when not it skips through dummy orders and does nothing in all oth...
Definition: vehicle.cpp:2301
Vehicle::HasDepotOrder
bool HasDepotOrder() const
Checks if a vehicle has a depot in its order list.
Definition: order_cmd.cpp:1872
_network_dedicated
bool _network_dedicated
are we a dedicated server?
Definition: network.cpp:55
Vehicle::Move
const Vehicle * Move(int n) const
Get the vehicle at offset n of this vehicle chain.
Definition: vehicle_base.h:650
VisualEffect
VisualEffect
Meaning of the various bits of the visual effect.
Definition: vehicle_base.h:76
BaseConsist::vehicle_flags
uint16 vehicle_flags
Used for gradual loading and other miscellaneous things (.
Definition: base_consist.h:31
Vehicle::SendToDepot
CommandCost SendToDepot(DoCommandFlag flags, DepotCommand command)
Send this vehicle to the depot using the given command(s).
Definition: vehicle.cpp:2364
NewGRFCache::company_information
uint32 company_information
Cache for NewGRF var 43.
Definition: vehicle_base.h:70
Vehicle::sprite_cache
MutableSpriteCache sprite_cache
Cache of sprites and values related to recalculating them, see MutableSpriteCache.
Definition: vehicle_base.h:341
VehicleType
VehicleType
Available vehicle types.
Definition: vehicle_type.h:21
Vehicle::IsOrderListShared
bool IsOrderListShared() const
Check if we share our orders with another vehicle.
Definition: vehicle_base.h:692
VE_TYPE_DEFAULT
@ VE_TYPE_DEFAULT
Use default from engine class.
Definition: vehicle_base.h:83
Vehicle::y_offs
int8 y_offs
y offset for vehicle sprite
Definition: vehicle_base.h:296
Vehicle::colourmap
SpriteID colourmap
NOSAVE: cached colour mapping.
Definition: vehicle_base.h:264
Vehicle::waiting_triggers
byte waiting_triggers
Triggers to be yet matched before rerandomizing the random bits.
Definition: vehicle_base.h:309
VESM_DIESEL
@ VESM_DIESEL
Diesel model.
Definition: vehicle_base.h:99
NewGRFCache::position_in_vehicle
uint32 position_in_vehicle
Cache for NewGRF var 4D.
Definition: vehicle_base.h:71
Vehicle::IncrementRealOrderIndex
void IncrementRealOrderIndex()
Advanced cur_real_order_index to the next real order, keeps care of the wrap-around and invalidates t...
Definition: vehicle_base.h:836
VF_BUILT_AS_PROTOTYPE
@ VF_BUILT_AS_PROTOTYPE
Vehicle is a prototype (accepted as exclusive preview).
Definition: vehicle_base.h:44
command_type.h
Vehicle::IterateWrapper
Iterable ensemble of orders.
Definition: vehicle_base.h:1022
Vehicle::direction
Direction direction
facing
Definition: vehicle_base.h:281
FreeUnitIDGenerator::cache
bool * cache
array of occupied unit id numbers
Definition: vehicle_base.h:1236
SpecializedVehicle::EXPECTED_TYPE
static const VehicleType EXPECTED_TYPE
Specialized type.
Definition: vehicle_base.h:1043
Vehicle::list
OrderList * list
Pointer to the order list for this vehicle.
Definition: vehicle_base.h:330
BaseConsist::cur_real_order_index
VehicleOrderID cur_real_order_index
The index to the current real (non-implicit) order.
Definition: base_consist.h:28
Vehicle::next_shared
Vehicle * next_shared
pointer to the next vehicle that shares the order
Definition: vehicle_base.h:231
texteff.hpp
Vehicle::FirstShared
Vehicle * FirstShared() const
Get the first vehicle of this vehicle chain.
Definition: vehicle_base.h:686
Vehicle::x_extent
byte x_extent
x-extent of vehicle bounding box
Definition: vehicle_base.h:290
Vehicle::Move
Vehicle * Move(int n)
Get the vehicle at offset n of this vehicle chain.
Definition: vehicle_base.h:634
NCVV_CONSIST_CARGO_INFORMATION
@ NCVV_CONSIST_CARGO_INFORMATION
This bit will be set if the NewGRF var 42 currently stored is valid.
Definition: vehicle_base.h:58
Vehicle::GetFirstEnginePart
const Vehicle * GetFirstEnginePart() const
Get the first part of an articulated engine.
Definition: vehicle_base.h:944
Vehicle::vcache
VehicleCache vcache
Cache of often used vehicle values.
Definition: vehicle_base.h:339
Vehicle::motion_counter
uint32 motion_counter
counter to occasionally play a vehicle sound.
Definition: vehicle_base.h:305
GVSF_FREE_WAGON
@ GVSF_FREE_WAGON
First in a wagon chain (in depot) (not used for road vehicles).
Definition: vehicle_base.h:115
VESM_NONE
@ VESM_NONE
No visual effect.
Definition: vehicle_base.h:97
MutableSpriteCache::revalidate_before_draw
bool revalidate_before_draw
We need to do a GetImage() and check bounds before drawing this sprite.
Definition: vehicle_base.h:190
Vehicle::hash_viewport_next
Vehicle * hash_viewport_next
NOSAVE: Next vehicle in the visual location hash.
Definition: vehicle_base.h:257
Pool
Base class for all pools.
Definition: pool_type.hpp:81
Vehicle::First
Vehicle * First() const
Get the first vehicle of this vehicle chain.
Definition: vehicle_base.h:605
Vehicle::cargo_age_counter
uint16 cargo_age_counter
Ticks till cargo is aged next.
Definition: vehicle_base.h:319
Vehicle::tick_counter
byte tick_counter
Increased by one for each tick.
Definition: vehicle_base.h:323
Vehicle::cargo_cap
uint16 cargo_cap
total capacity
Definition: vehicle_base.h:316
GroupID
uint16 GroupID
Type for all group identifiers.
Definition: group_type.h:13
engine_type.h
Vehicle::IncrementImplicitOrderIndex
void IncrementImplicitOrderIndex()
Increments cur_implicit_order_index, keeps care of the wrap-around and invalidates the GUI.
Definition: vehicle_base.h:812
NCVV_POSITION_SAME_ID_LENGTH
@ NCVV_POSITION_SAME_ID_LENGTH
This bit will be set if the NewGRF var 41 currently stored is valid.
Definition: vehicle_base.h:57
Vehicle::x_offs
int8 x_offs
x offset for vehicle sprite
Definition: vehicle_base.h:295
Vehicle::subspeed
byte subspeed
fractional speed
Definition: vehicle_base.h:303
Vehicle::GetAdvanceSpeed
static uint GetAdvanceSpeed(uint speed)
Determines the effective vehicle movement speed.
Definition: vehicle_base.h:413
Vehicle::GetFirstOrder
Order * GetFirstOrder() const
Get the first order of the vehicles order list.
Definition: vehicle_base.h:665
SpecializedVehicle::From
static T * From(Vehicle *v)
Converts a Vehicle to SpecializedVehicle with type checking.
Definition: vehicle_base.h:1162
Vehicle::z_extent
byte z_extent
z-extent of vehicle bounding box
Definition: vehicle_base.h:292
Vehicle::GetFirstEnginePart
Vehicle * GetFirstEnginePart()
Get the first part of an articulated engine.
Definition: vehicle_base.h:933
Vehicle::InvalidateNewGRFCacheOfChain
void InvalidateNewGRFCacheOfChain()
Invalidates cached NewGRF variables of all vehicles in the chain (after the current vehicle)
Definition: vehicle_base.h:471
PaletteID
uint32 PaletteID
The number of the palette.
Definition: gfx_type.h:18
FreeUnitIDGenerator::maxid
UnitID maxid
maximum ID at the moment of constructor call
Definition: vehicle_base.h:1237
OrderList
Shared order list linking together the linked list of orders and the list of vehicles sharing this or...
Definition: order_base.h:250
VF_SERVINT_IS_PERCENT
@ VF_SERVINT_IS_PERCENT
Service interval is percent.
Definition: vehicle_base.h:51
Vehicle::cargo_payment
CargoPayment * cargo_payment
The cargo payment we're currently in.
Definition: vehicle_base.h:253
Vehicle::NextShared
Vehicle * NextShared() const
Get the next vehicle of the shared vehicle chain.
Definition: vehicle_base.h:674
Vehicle::orders
union Vehicle::@51 orders
The orders currently assigned to the vehicle.
VE_DISABLE_WAGON_POWER
@ VE_DISABLE_WAGON_POWER
Flag to disable wagon power.
Definition: vehicle_base.h:90
SpecializedVehicle::IsValidID
static bool IsValidID(size_t index)
Tests whether given index is a valid index for vehicle of this type.
Definition: vehicle_base.h:1134
Vehicle::age
Date age
Age in days.
Definition: vehicle_base.h:268
Vehicle::HasArticulatedPart
bool HasArticulatedPart() const
Check if an engine has an articulated part.
Definition: vehicle_base.h:913
Vehicle::build_year
Year build_year
Year the vehicle has been built.
Definition: vehicle_base.h:267
Vehicle::profit_last_year
Money profit_last_year
Profit last year << 8, low 8 bits are fract.
Definition: vehicle_base.h:250
Vehicle::breakdown_chance
byte breakdown_chance
Current chance of breakdowns.
Definition: vehicle_base.h:276
GVSF_MULTIHEADED
@ GVSF_MULTIHEADED
Engine is multiheaded (not used for road vehicles).
Definition: vehicle_base.h:116
PalSpriteID
Combination of a palette sprite and a 'real' sprite.
Definition: gfx_type.h:22
Vehicle::unitnumber
UnitID unitnumber
unit number, for display purposes only
Definition: vehicle_base.h:300
SpecializedVehicle::GetIfValid
static T * GetIfValid(size_t index)
Returns vehicle if the index is a valid index for this vehicle type.
Definition: vehicle_base.h:1152
VehicleCache::cached_max_speed
uint16 cached_max_speed
Maximum speed of the consist (minimum of the max speed of all vehicles in the consist).
Definition: vehicle_base.h:121
VF_AUTOFILL_PRES_WAIT_TIME
@ VF_AUTOFILL_PRES_WAIT_TIME
Whether non-destructive auto-fill should preserve waiting times.
Definition: vehicle_base.h:47
SpecializedVehicle::Iterate
static Pool::IterateWrapper< T > Iterate(size_t from=0)
Returns an iterable ensemble of all valid vehicles of type T.
Definition: vehicle_base.h:1231
Vehicle::LoadOldVehicle
friend bool LoadOldVehicle(LoadgameState *ls, int num)
So we can set the proper next pointer while loading.
Definition: oldloader_sl.cpp:1221
Vehicle::GetVehicleDescription
const friend SaveLoad * GetVehicleDescription(VehicleType vt)
So we can use private/protected variables in the saveload code.
Definition: vehicle_sl.cpp:581
NCVV_END
@ NCVV_END
End of the bits.
Definition: vehicle_base.h:61
VE_ADVANCED_EFFECT
@ VE_ADVANCED_EFFECT
Flag for advanced effects.
Definition: vehicle_base.h:89
Vehicle::x_bb_offs
int8 x_bb_offs
x offset of vehicle bounding box
Definition: vehicle_base.h:293
Vehicle::hash_viewport_prev
Vehicle ** hash_viewport_prev
NOSAVE: Previous vehicle in the visual location hash.
Definition: vehicle_base.h:258
Vehicle::breakdown_delay
byte breakdown_delay
Counter for managing breakdown length.
Definition: vehicle_base.h:274
Vehicle::Last
Vehicle * Last()
Get the last vehicle of this vehicle chain.
Definition: vehicle_base.h:611
Vehicle::coord
Rect coord
NOSAVE: Graphical bounding box of the vehicle, i.e. what to redraw on moves.
Definition: vehicle_base.h:255
Vehicle::NeedsServicing
bool NeedsServicing() const
Check if the vehicle needs to go to a depot in near future (if a opportunity presents itself) for ser...
Definition: vehicle.cpp:184
Vehicle::InvalidateNewGRFCache
void InvalidateNewGRFCache()
Invalidates cached NewGRF variables.
Definition: vehicle_base.h:462
network.h
Vehicle::subtype
byte subtype
subtype (Filled with values from AircraftSubType/DisasterSubType/EffectVehicleType/GroundVehicleSubty...
Definition: vehicle_base.h:336
VF_TIMETABLE_STARTED
@ VF_TIMETABLE_STARTED
Whether the vehicle has started running on the timetable yet.
Definition: vehicle_base.h:45
OrderList::GetFirstOrder
Order * GetFirstOrder() const
Get the first order of the order chain.
Definition: order_base.h:290
Vehicle::day_counter
byte day_counter
Increased by one for each day.
Definition: vehicle_base.h:322
BaseConsist::service_interval
uint16 service_interval
The interval for (automatic) servicing; either in days or %.
Definition: base_consist.h:26
VS_UNCLICKABLE
@ VS_UNCLICKABLE
Vehicle is not clickable by the user (shadow vehicles).
Definition: vehicle_base.h:32
NewGRFCacheValidValues
NewGRFCacheValidValues
Bit numbers used to indicate which of the NewGRFCache values are valid.
Definition: vehicle_base.h:55
GVSF_FRONT
@ GVSF_FRONT
Leading engine of a consist.
Definition: vehicle_base.h:111
Vehicle::NeedsAutorenewing
bool NeedsAutorenewing(const Company *c, bool use_renew_setting=true) const
Function to tell if a vehicle needs to be autorenewed.
Definition: vehicle.cpp:140
VF_PATHFINDER_LOST
@ VF_PATHFINDER_LOST
Vehicle's pathfinder is lost.
Definition: vehicle_base.h:49
Vehicle::progress
byte progress
The percentage (if divided by 256) this vehicle already crossed the tile unit.
Definition: vehicle_base.h:306
OverflowSafeInt< int64, INT64_MAX, INT64_MIN >
CargoID
byte CargoID
Cargo slots to indicate a cargo type within a game.
Definition: cargo_type.h:20
Vehicle::IsStoppedInDepot
bool IsStoppedInDepot() const
Check whether the vehicle is in the depot and stopped.
Definition: vehicle_base.h:527
Vehicle::FixOldVehicles
friend void FixOldVehicles()
Convert the old style vehicles into something that resembles the old new style savegames.
Definition: oldloader_sl.cpp:171
Vehicle::previous
Vehicle * previous
NOSAVE: pointer to the previous vehicle in the chain.
Definition: vehicle_base.h:228
INVALID_TILE
static const TileIndex INVALID_TILE
The very nice invalid tile marker.
Definition: tile_type.h:83
Vehicle::cargo_type
CargoID cargo_type
type of cargo this vehicle is carrying
Definition: vehicle_base.h:314
Vehicle::spritenum
byte spritenum
currently displayed sprite index 0xfd == custom sprite, 0xfe == custom second head sprite 0xff == res...
Definition: vehicle_base.h:289
NCVV_COMPANY_INFORMATION
@ NCVV_COMPANY_INFORMATION
This bit will be set if the NewGRF var 43 currently stored is valid.
Definition: vehicle_base.h:59
FreeUnitIDGenerator::FreeUnitIDGenerator
FreeUnitIDGenerator(VehicleType type, CompanyID owner)
Initializes the structure.
Definition: vehicle.cpp:1746
SpecializedVehicle::GetLastEnginePart
T * GetLastEnginePart()
Get the last part of an articulated engine.
Definition: vehicle_base.h:1115
Vehicle::OnNewDay
virtual void OnNewDay()
Calls the new day handler of the vehicle.
Definition: vehicle_base.h:544
PalSpriteID::pal
PaletteID pal
The palette (use PAL_NONE) if not needed)
Definition: gfx_type.h:24
SpecializedVehicle::Previous
T * Previous() const
Get previous vehicle in the chain.
Definition: vehicle_base.h:1083
Trackdir
Trackdir
Enumeration for tracks and directions.
Definition: track_type.h:70
Vehicle::cargo_subtype
byte cargo_subtype
Used for livery refits (NewGRF variations)
Definition: vehicle_base.h:315
VEH_TRAIN
@ VEH_TRAIN
Train vehicle type.
Definition: vehicle_type.h:24
Pool::PoolItem<&_vehicle_pool >::IsValidID
static bool IsValidID(size_t index)
Tests whether given index can be used to get valid (non-nullptr) Titem.
Definition: pool_type.hpp:318
Vehicle::GetAdvanceDistance
uint GetAdvanceDistance()
Determines the vehicle "progress" needed for moving a step.
Definition: vehicle_base.h:425
Vehicle::GetOrder
Order * GetOrder(int index) const
Returns order 'index' of a vehicle or nullptr when it doesn't exists.
Definition: vehicle_base.h:872
BaseVehicle::type
VehicleType type
Type of vehicle.
Definition: vehicle_type.h:52
Vehicle::Tick
virtual bool Tick()
Calls the tick handler of the vehicle.
Definition: vehicle_base.h:539
Vehicle::UpdatePositionAndViewport
void UpdatePositionAndViewport()
Update the position of the vehicle, and update the viewport.
Definition: vehicle.cpp:1660
Vehicle::reliability
uint16 reliability
Reliability.
Definition: vehicle_base.h:271
SpecializedVehicle::First
T * First() const
Get the first vehicle in the chain.
Definition: vehicle_base.h:1059
Vehicle::UpdatePosition
void UpdatePosition()
Update the position of the vehicle.
Definition: vehicle.cpp:1595
Vehicle::hash_tile_prev
Vehicle ** hash_tile_prev
NOSAVE: Previous vehicle in the tile location hash.
Definition: vehicle_base.h:261
ExpensesType
ExpensesType
Types of expenses.
Definition: economy_type.h:157
Vehicle::HandleBreakdown
bool HandleBreakdown()
Handle all of the aspects of a vehicle breakdown This includes adding smoke and sounds,...
Definition: vehicle.cpp:1297
Vehicle::y_bb_offs
int8 y_bb_offs
y offset of vehicle bounding box
Definition: vehicle_base.h:294
free
static void free(const void *ptr)
Version of the standard free that accepts const pointers.
Definition: stdafx.h:454
NewGRFCache::position_consist_length
uint32 position_consist_length
Cache for NewGRF var 40.
Definition: vehicle_base.h:67
SaveLoad
SaveLoad type struct.
Definition: saveload.h:516
VESM_ELECTRIC
@ VESM_ELECTRIC
Electric model.
Definition: vehicle_base.h:100
Rect
Specification of a rectangle with absolute coordinates of all edges.
Definition: geometry_type.hpp:47
Company
Definition: company_base.h:110
group_type.h
Vehicle::GetNumOrders
VehicleOrderID GetNumOrders() const
Get the number of orders this vehicle has.
Definition: vehicle_base.h:698
BaseConsist
Various front vehicle properties that are preserved when autoreplacing, using order-backup or switchi...
Definition: base_consist.h:18
SpecializedVehicle::Last
T * Last()
Get the last vehicle in the chain.
Definition: vehicle_base.h:1065
InvalidateVehicleOrder
void InvalidateVehicleOrder(const Vehicle *v, int data)
Updates the widgets of a vehicle which contains the order-data.
Definition: order_cmd.cpp:250
VehicleSpriteSeq::GetBounds
void GetBounds(Rect *bounds) const
Determine shared bounds of all sprites.
Definition: vehicle.cpp:98
Vehicle::hash_tile_next
Vehicle * hash_tile_next
NOSAVE: Next vehicle in the tile location hash.
Definition: vehicle_base.h:260
Pool::PoolItem
Base class for all PoolItems.
Definition: pool_type.hpp:226
BaseConsist::CopyConsistPropertiesFrom
void CopyConsistPropertiesFrom(const BaseConsist *src)
Copy properties of other BaseConsist.
Definition: base_consist.cpp:22
Vehicle::DeleteUnreachedImplicitOrders
void DeleteUnreachedImplicitOrders()
Delete all implicit orders which were not reached.
Definition: vehicle.cpp:2053
Vehicle::first
Vehicle * first
NOSAVE: pointer to the first vehicle in the chain.
Definition: vehicle_base.h:229
Order::next
Order * next
Pointer to next order. If nullptr, end of list.
Definition: order_base.h:49
SpecializedVehicle::UpdateViewport
void UpdateViewport(bool force_update, bool update_delta)
Update vehicle sprite- and position caches.
Definition: vehicle_base.h:1184
Vehicle::fill_percent_te_id
TextEffectID fill_percent_te_id
a text-effect id to a loading indicator object
Definition: vehicle_base.h:299
Order
Definition: order_base.h:32
SpecializedVehicle::GetPrevVehicle
T * GetPrevVehicle() const
Get the previous real (non-articulated part) vehicle in the consist.
Definition: vehicle_base.h:1127
VS_SHADOW
@ VS_SHADOW
Vehicle is a shadow vehicle.
Definition: vehicle_base.h:35
INVALID_COORD
static const int32 INVALID_COORD
Sentinel for an invalid coordinate.
Definition: vehicle_base.h:1248
MutableSpriteCache::old_coord
Rect old_coord
Co-ordinates from the last valid bounding box.
Definition: vehicle_base.h:191
Vehicle::GetDisplayProfitLastYear
Money GetDisplayProfitLastYear() const
Gets the profit vehicle had last year.
Definition: vehicle_base.h:583
VE_OFFSET_CENTRE
@ VE_OFFSET_CENTRE
Value of offset corresponding to a position above the centre of the vehicle.
Definition: vehicle_base.h:79
SpecializedVehicle::GetFirstEnginePart
T * GetFirstEnginePart()
Get the first part of an articulated engine.
Definition: vehicle_base.h:1103
VE_TYPE_STEAM
@ VE_TYPE_STEAM
Steam plumes.
Definition: vehicle_base.h:84
GetVehicleDescription
const SaveLoad * GetVehicleDescription(VehicleType vt)
Make it possible to make the saveload tables "friends" of other classes.
Definition: vehicle_sl.cpp:581
RefitDesc
Simulated cargo type and capacity for prediction of future links.
Definition: vehicle_base.h:213
track_type.h
Vehicle::GetOrderStationLocation
virtual TileIndex GetOrderStationLocation(StationID station)
Determine the location for the station where the vehicle goes to next.
Definition: vehicle_base.h:751
order_func.h
Vehicle::MarkDirty
virtual void MarkDirty()
Marks the vehicles to be redrawn and updates cached variables.
Definition: vehicle_base.h:375
GRFFile
Dynamic data of a loaded NewGRF.
Definition: newgrf.h:105
Vehicle::refit_cap
uint16 refit_cap
Capacity left over from before last refit.
Definition: vehicle_base.h:317
NewGRFCache
Cached often queried (NewGRF) values.
Definition: vehicle_base.h:65
Vehicle::date_of_last_service
Date date_of_last_service
Last date the vehicle had a service at a depot.
Definition: vehicle_base.h:270
Vehicle::GetNextStoppingStation
StationIDStack GetNextStoppingStation() const
Get the next station the vehicle will stop at.
Definition: vehicle_base.h:710
RefitDesc::cargo
CargoID cargo
Cargo type the vehicle will be carrying.
Definition: vehicle_base.h:214
Vehicle::GetImage
virtual void GetImage(Direction direction, EngineImageType image_type, VehicleSpriteSeq *result) const
Gets the sprite to show for the given direction.
Definition: vehicle_base.h:453