OpenTTD Source: src/vehicle_func.h Source File

OpenTTD Source 14.0-beta3

vehicle_func.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_FUNC_H
11 #define VEHICLE_FUNC_H
12
13 #include "gfx_type.h"
14 #include "direction_type.h"
15 #include "command_type.h"
16 #include "vehicle_type.h"
17 #include "engine_type.h"
18 #include "transport_type.h"
19 #include "newgrf_config.h"
20 #include "track_type.h"
21 #include "livery.h"
22
23 #define is_custom_sprite(x) (x >= 0xFD)
24 #define IS_CUSTOM_FIRSTHEAD_SPRITE(x) (x == 0xFD)
25 #define IS_CUSTOM_SECONDHEAD_SPRITE(x) (x == 0xFE)
26
27 static const int VEHICLE_PROFIT_MIN_AGE = CalendarTime::DAYS_IN_YEAR * 2;
28 static const Money VEHICLE_PROFIT_THRESHOLD = 10000;
29
36 template <VehicleType T>
37 bool IsValidImageIndex(uint8_t image_index);
38
39 typedef Vehicle *VehicleFromPosProc(Vehicle *v, void *data);
40
41 void VehicleServiceInDepot(Vehicle *v);
42 uint CountVehiclesInChain(const Vehicle *v);
43 void FindVehicleOnPos(TileIndex tile, void *data, VehicleFromPosProc *proc);
44 void FindVehicleOnPosXY(int x, int y, void *data, VehicleFromPosProc *proc);
45 bool HasVehicleOnPos(TileIndex tile, void *data, VehicleFromPosProc *proc);
46 bool HasVehicleOnPosXY(int x, int y, void *data, VehicleFromPosProc *proc);
47 void CallVehicleTicks();
48 uint8_t CalcPercentVehicleFilled(const Vehicle *v, StringID *colour);
49
50 void VehicleLengthChanged(const Vehicle *u);
51
52 void ResetVehicleHash();
53 void ResetVehicleColourMap();
54
55 byte GetBestFittingSubType(Vehicle *v_from, Vehicle *v_for, CargoID dest_cargo_type);
56
57 void ViewportAddVehicles(DrawPixelInfo *dpi);
58
59 void ShowNewGrfVehicleError(EngineID engine, StringID part1, StringID part2, GRFBugs bug_type, bool critical);
60 CommandCost TunnelBridgeIsFree(TileIndex tile, TileIndex endtile, const Vehicle *ignore = nullptr);
61
62 void DecreaseVehicleValue(Vehicle *v);
63 void CheckVehicleBreakdown(Vehicle *v);
64 void AgeVehicle(Vehicle *v);
65 void RunVehicleCalendarDayProc();
66 void VehicleEnteredDepotThisTick(Vehicle *v);
67
68 UnitID GetFreeUnitNumber(VehicleType type);
69
70 void VehicleEnterDepot(Vehicle *v);
71
72 bool CanBuildVehicleInfrastructure(VehicleType type, byte subtype = 0);
73
75 struct GetNewVehiclePosResult {
76 int x, y;
77 TileIndex old_tile;
78 TileIndex new_tile;
79 };
80
81 GetNewVehiclePosResult GetNewVehiclePos(const Vehicle *v);
82 Direction GetDirectionTowards(const Vehicle *v, int x, int y);
83
89 inline bool IsCompanyBuildableVehicleType(VehicleType type)
90 {
91 switch (type) {
92 case VEH_TRAIN:
93 case VEH_ROAD:
94 case VEH_SHIP:
95 case VEH_AIRCRAFT:
96 return true;
97
98 default: return false;
99 }
100 }
101
107 inline bool IsCompanyBuildableVehicleType(const BaseVehicle *v)
108 {
109 return IsCompanyBuildableVehicleType(v->type);
110 }
111
112 LiveryScheme GetEngineLiveryScheme(EngineID engine_type, EngineID parent_engine_type, const Vehicle *v);
113 const struct Livery *GetEngineLivery(EngineID engine_type, CompanyID company, EngineID parent_engine_type, const Vehicle *v, byte livery_setting);
114
115 SpriteID GetEnginePalette(EngineID engine_type, CompanyID company);
116 SpriteID GetVehiclePalette(const Vehicle *v);
117
118 extern const StringID _veh_build_msg_table[];
119 extern const StringID _veh_sell_msg_table[];
120 extern const StringID _veh_refit_msg_table[];
121 extern const StringID _send_to_depot_msg_table[];
122
123 /* Functions to find the right command for certain vehicle type */
124 inline StringID GetCmdBuildVehMsg(VehicleType type)
125 {
126 return _veh_build_msg_table[type];
127 }
128
129 inline StringID GetCmdBuildVehMsg(const BaseVehicle *v)
130 {
131 return GetCmdBuildVehMsg(v->type);
132 }
133
134 inline StringID GetCmdSellVehMsg(VehicleType type)
135 {
136 return _veh_sell_msg_table[type];
137 }
138
139 inline StringID GetCmdSellVehMsg(const BaseVehicle *v)
140 {
141 return GetCmdSellVehMsg(v->type);
142 }
143
144 inline StringID GetCmdRefitVehMsg(VehicleType type)
145 {
146 return _veh_refit_msg_table[type];
147 }
148
149 inline StringID GetCmdRefitVehMsg(const BaseVehicle *v)
150 {
151 return GetCmdRefitVehMsg(v->type);
152 }
153
154 inline StringID GetCmdSendToDepotMsg(VehicleType type)
155 {
156 return _send_to_depot_msg_table[type];
157 }
158
159 inline StringID GetCmdSendToDepotMsg(const BaseVehicle *v)
160 {
161 return GetCmdSendToDepotMsg(v->type);
162 }
163
164 CommandCost EnsureNoVehicleOnGround(TileIndex tile);
165 CommandCost EnsureNoTrainOnTrackBits(TileIndex tile, TrackBits track_bits);
166
167 bool CanVehicleUseStation(EngineID engine_type, const struct Station *st);
168 bool CanVehicleUseStation(const Vehicle *v, const struct Station *st);
169 StringID GetVehicleCannotUseStationReason(const Vehicle *v, const Station *st);
170
171 void ReleaseDisastersTargetingVehicle(VehicleID vehicle);
172
173 typedef std::vector<VehicleID> VehicleSet;
174 void GetVehicleSet(VehicleSet &set, Vehicle *v, uint8_t num_vehicles);
175
176 void CheckCargoCapacity(Vehicle *v);
177
178 bool VehiclesHaveSameEngineList(const Vehicle *v1, const Vehicle *v2);
179 bool VehiclesHaveSameOrderList(const Vehicle *v1, const Vehicle *v2);
180
181 bool IsUniqueVehicleName(const std::string &name);
182
183 #endif /* VEHICLE_FUNC_H */
VEH_AIRCRAFT
@ VEH_AIRCRAFT
Aircraft vehicle type.
Definition: vehicle_type.h:27
transport_type.h
direction_type.h
UnitID
uint16_t UnitID
Type for the company global vehicle unit number.
Definition: transport_type.h:16
ViewportAddVehicles
void ViewportAddVehicles(DrawPixelInfo *dpi)
Add the vehicle sprites that should be drawn at a part of the screen.
Definition: vehicle.cpp:1148
Direction
Direction
Defines the 8 directions on the map.
Definition: direction_type.h:24
GetVehiclePalette
SpriteID GetVehiclePalette(const Vehicle *v)
Get the colour map for a vehicle.
Definition: vehicle.cpp:2123
Station
Station data structure.
Definition: station_base.h:442
StringID
uint32_t StringID
Numeric value that represents a string, independent of the selected language.
Definition: strings_type.h:16
GetVehicleSet
void GetVehicleSet(VehicleSet &set, Vehicle *v, uint8_t num_vehicles)
Calculates the set of vehicles that will be affected by a given selection.
Definition: vehicle.cpp:3143
VehiclesHaveSameEngineList
bool VehiclesHaveSameEngineList(const Vehicle *v1, const Vehicle *v2)
Checks if two vehicle chains have the same list of engines.
Definition: vehicle.cpp:3197
IsValidImageIndex
bool IsValidImageIndex(uint8_t image_index)
Helper to check whether an image index is valid for a particular vehicle.
EnsureNoVehicleOnGround
CommandCost EnsureNoVehicleOnGround(TileIndex tile)
Ensure there is no vehicle at the ground at the given position.
Definition: vehicle.cpp:546
GetEnginePalette
SpriteID GetEnginePalette(EngineID engine_type, CompanyID company)
Get the colour map for an engine.
Definition: vehicle.cpp:2113
LiveryScheme
LiveryScheme
List of different livery schemes.
Definition: livery.h:21
StrongType::Typedef< uint32_t, struct TileIndexTag, StrongType::Compare, StrongType::Integer, StrongType::Compatible< int32_t >, StrongType::Compatible< int64_t > >
HasVehicleOnPos
bool HasVehicleOnPos(TileIndex tile, void *data, VehicleFromPosProc *proc)
Checks whether a vehicle is on a specific location.
Definition: vehicle.cpp:520
VEH_ROAD
@ VEH_ROAD
Road vehicle type.
Definition: vehicle_type.h:25
Vehicle
Vehicle data structure.
Definition: vehicle_base.h:240
newgrf_config.h
Owner
Owner
Enum for all companies/owners.
Definition: company_type.h:18
GRFBugs
GRFBugs
Encountered GRF bugs.
Definition: newgrf_config.h:43
TunnelBridgeIsFree
CommandCost TunnelBridgeIsFree(TileIndex tile, TileIndex endtile, const Vehicle *ignore=nullptr)
Finds vehicle in tunnel / bridge.
Definition: vehicle.cpp:575
RunVehicleCalendarDayProc
void RunVehicleCalendarDayProc()
Age all vehicles, spreading out the action using the current TimerGameCalendar::date_fract.
Definition: vehicle.cpp:933
CheckCargoCapacity
void CheckCargoCapacity(Vehicle *v)
Check the capacity of all vehicles in a chain and spread cargo if needed.
Definition: autoreplace_cmd.cpp:107
CommandCost
Common return value for all commands.
Definition: command_type.h:23
BaseVehicle
Base vehicle class.
Definition: vehicle_type.h:49
GetEngineLivery
const struct Livery * GetEngineLivery(EngineID engine_type, CompanyID company, EngineID parent_engine_type, const Vehicle *v, byte livery_setting)
Determines the livery for a vehicle.
Definition: vehicle.cpp:2035
IsCompanyBuildableVehicleType
bool IsCompanyBuildableVehicleType(VehicleType type)
Is the given vehicle type buildable by a company?
Definition: vehicle_func.h:89
GetFreeUnitNumber
UnitID GetFreeUnitNumber(VehicleType type)
Get an unused unit number for a vehicle (if allowed).
Definition: vehicle.cpp:1864
GetNewVehiclePosResult::new_tile
TileIndex new_tile
Tile of the vehicle after moving.
Definition: vehicle_func.h:78
GetVehicleCannotUseStationReason
StringID GetVehicleCannotUseStationReason(const Vehicle *v, const Station *st)
Get reason string why this station can't be used by the given vehicle.
Definition: vehicle.cpp:3029
VehicleID
uint32_t VehicleID
The type all our vehicle IDs have.
Definition: vehicle_type.h:16
CargoID
byte CargoID
Cargo slots to indicate a cargo type within a game.
Definition: cargo_type.h:22
FindVehicleOnPosXY
void FindVehicleOnPosXY(int x, int y, void *data, VehicleFromPosProc *proc)
Find a vehicle from a specific location.
Definition: vehicle.cpp:445
livery.h
VehicleType
VehicleType
Available vehicle types.
Definition: vehicle_type.h:21
SpriteID
uint32_t SpriteID
The number of a sprite, without mapping bits and colourtables.
Definition: gfx_type.h:17
HasVehicleOnPosXY
bool HasVehicleOnPosXY(int x, int y, void *data, VehicleFromPosProc *proc)
Checks whether a vehicle in on a specific location.
Definition: vehicle.cpp:461
command_type.h
ShowNewGrfVehicleError
void ShowNewGrfVehicleError(EngineID engine, StringID part1, StringID part2, GRFBugs bug_type, bool critical)
Displays a "NewGrf Bug" error message for a engine, and pauses the game if not networking.
Definition: vehicle.cpp:317
vehicle_type.h
VehicleEnteredDepotThisTick
void VehicleEnteredDepotThisTick(Vehicle *v)
Adds a vehicle to the list of vehicles that visited a depot this tick.
Definition: vehicle.cpp:917
engine_type.h
VehicleServiceInDepot
void VehicleServiceInDepot(Vehicle *v)
Service a vehicle and all subsequent vehicles in the consist.
Definition: vehicle.cpp:167
GetNewVehiclePosResult
Position information of a vehicle after it moved.
Definition: vehicle_func.h:75
CalcPercentVehicleFilled
uint8_t CalcPercentVehicleFilled(const Vehicle *v, StringID *colour)
Calculates how full a vehicle is.
Definition: vehicle.cpp:1475
VehicleEnterDepot
void VehicleEnterDepot(Vehicle *v)
Vehicle entirely entered the depot, update its status, orders, vehicle windows, service it,...
Definition: vehicle.cpp:1534
GetNewVehiclePosResult::old_tile
TileIndex old_tile
Current tile of the vehicle.
Definition: vehicle_func.h:77
VehicleLengthChanged
void VehicleLengthChanged(const Vehicle *u)
Logs a bug in GRF and shows a warning message if this is for the first time this happened.
Definition: vehicle.cpp:346
TrackBits
TrackBits
Allow incrementing of Track variables.
Definition: track_type.h:35
OverflowSafeInt< int64_t >
GetNewVehiclePos
GetNewVehiclePosResult GetNewVehiclePos(const Vehicle *v)
Get position information of a vehicle when moving one pixel in the direction it is facing.
Definition: vehicle.cpp:1759
VehiclesHaveSameOrderList
bool VehiclesHaveSameOrderList(const Vehicle *v1, const Vehicle *v2)
Checks if two vehicles have the same list of orders.
Definition: vehicle.cpp:3214
EnsureNoTrainOnTrackBits
CommandCost EnsureNoTrainOnTrackBits(TileIndex tile, TrackBits track_bits)
Tests if a vehicle interacts with the specified track bits.
Definition: vehicle.cpp:608
CanBuildVehicleInfrastructure
bool CanBuildVehicleInfrastructure(VehicleType type, byte subtype=0)
Check whether we can build infrastructure for the given vehicle type.
Definition: vehicle.cpp:1893
AgeVehicle
void AgeVehicle(Vehicle *v)
Update age of a vehicle.
Definition: vehicle.cpp:1423
EngineID
uint16_t EngineID
Unique identification number of an engine.
Definition: engine_type.h:21
VEH_TRAIN
@ VEH_TRAIN
Train vehicle type.
Definition: vehicle_type.h:24
BaseVehicle::type
VehicleType type
Type of vehicle.
Definition: vehicle_type.h:51
ReleaseDisastersTargetingVehicle
void ReleaseDisastersTargetingVehicle(VehicleID vehicle)
Notify disasters that we are about to delete a vehicle.
Definition: disaster_vehicle.cpp:973
DecreaseVehicleValue
void DecreaseVehicleValue(Vehicle *v)
Decrease the value of a vehicle.
Definition: vehicle.cpp:1295
CanVehicleUseStation
bool CanVehicleUseStation(EngineID engine_type, const Station *st)
Can this station be used by the given engine type?
Definition: vehicle.cpp:2983
GetEngineLiveryScheme
LiveryScheme GetEngineLiveryScheme(EngineID engine_type, EngineID parent_engine_type, const Vehicle *v)
Determines the LiveryScheme for a vehicle.
Definition: vehicle.cpp:1941
GetNewVehiclePosResult::y
int y
x and y position of the vehicle after moving
Definition: vehicle_func.h:76
gfx_type.h
VEH_SHIP
@ VEH_SHIP
Ship vehicle type.
Definition: vehicle_type.h:26
IsUniqueVehicleName
bool IsUniqueVehicleName(const std::string &name)
Test if a name is unique among vehicle names.
Definition: vehicle_cmd.cpp:755
TimerGameConst< struct Calendar >::DAYS_IN_YEAR
static constexpr int DAYS_IN_YEAR
days per year
Definition: timer_game_common.h:149
FindVehicleOnPos
void FindVehicleOnPos(TileIndex tile, void *data, VehicleFromPosProc *proc)
Find a vehicle from a specific location.
Definition: vehicle.cpp:505
Livery
Information about a particular livery.
Definition: livery.h:78
GetBestFittingSubType
byte GetBestFittingSubType(Vehicle *v_from, Vehicle *v_for, CargoID dest_cargo_type)
Get the best fitting subtype when 'cloning'/'replacing' v_from with v_for.
Definition: vehicle_gui.cpp:518
track_type.h
DrawPixelInfo
Data about how and where to blit pixels.
Definition: gfx_type.h:151
VEHICLE_PROFIT_MIN_AGE
static const int VEHICLE_PROFIT_MIN_AGE
Only vehicles older than this have a meaningful profit.
Definition: vehicle_func.h:27
VEHICLE_PROFIT_THRESHOLD
static const Money VEHICLE_PROFIT_THRESHOLD
Threshold for a vehicle to be considered making good profit.
Definition: vehicle_func.h:28