OpenTTD Source: src/vehicle_func.h Source File

OpenTTD Source 15.0-beta1

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 "timer/timer_game_economy.h"
16#include "command_type.h"
17#include "vehicle_type.h"
18#include "engine_type.h"
19#include "transport_type.h"
20#include "newgrf_config.h"
21#include "track_type.h"
22#include "livery.h"
23
24#define is_custom_sprite(x) (x >= 0xFD)
25#define IS_CUSTOM_FIRSTHEAD_SPRITE(x) (x == 0xFD)
26#define IS_CUSTOM_SECONDHEAD_SPRITE(x) (x == 0xFE)
27
28 static const TimerGameEconomy::Date VEHICLE_PROFIT_MIN_AGE = CalendarTime::DAYS_IN_YEAR * 2;
29 static const Money VEHICLE_PROFIT_THRESHOLD = 10000;
30
37template <VehicleType T>
38 bool IsValidImageIndex(uint8_t image_index);
39
40typedef Vehicle *VehicleFromPosProc(Vehicle *v, void *data);
41
42void VehicleServiceInDepot(Vehicle *v);
43uint CountVehiclesInChain(const Vehicle *v);
44void FindVehicleOnPos(TileIndex tile, void *data, VehicleFromPosProc *proc);
45void FindVehicleOnPosXY(int x, int y, void *data, VehicleFromPosProc *proc);
46bool HasVehicleOnPos(TileIndex tile, void *data, VehicleFromPosProc *proc);
47bool HasVehicleOnPosXY(int x, int y, void *data, VehicleFromPosProc *proc);
48void CallVehicleTicks();
49uint8_t CalcPercentVehicleFilled(const Vehicle *v, StringID *colour);
50
51void VehicleLengthChanged(const Vehicle *u);
52
53void ResetVehicleHash();
54void ResetVehicleColourMap();
55
56uint8_t GetBestFittingSubType(Vehicle *v_from, Vehicle *v_for, CargoID dest_cargo_type);
57
58void ViewportAddVehicles(DrawPixelInfo *dpi);
59
60void ShowNewGrfVehicleError(EngineID engine, StringID part1, StringID part2, GRFBugs bug_type, bool critical);
61 CommandCost TunnelBridgeIsFree(TileIndex tile, TileIndex endtile, const Vehicle *ignore = nullptr);
62
63void DecreaseVehicleValue(Vehicle *v);
64void CheckVehicleBreakdown(Vehicle *v);
65void EconomyAgeVehicle(Vehicle *v);
66void AgeVehicle(Vehicle *v);
67void RunVehicleCalendarDayProc();
68void VehicleEnteredDepotThisTick(Vehicle *v);
69
70 UnitID GetFreeUnitNumber(VehicleType type);
71
72void VehicleEnterDepot(Vehicle *v);
73
74bool CanBuildVehicleInfrastructure(VehicleType type, uint8_t subtype = 0);
75
77 struct GetNewVehiclePosResult {
78 int x, y;
79 TileIndex old_tile;
80 TileIndex new_tile;
81};
82
83 GetNewVehiclePosResult GetNewVehiclePos(const Vehicle *v);
84 Direction GetDirectionTowards(const Vehicle *v, int x, int y);
85
91 inline bool IsCompanyBuildableVehicleType(VehicleType type)
92{
93 return type < VEH_COMPANY_END;
94}
95
101 inline bool IsCompanyBuildableVehicleType(const BaseVehicle *v)
102{
103 return IsCompanyBuildableVehicleType(v->type);
104}
105
106 LiveryScheme GetEngineLiveryScheme(EngineID engine_type, EngineID parent_engine_type, const Vehicle *v);
107const struct Livery *GetEngineLivery(EngineID engine_type, CompanyID company, EngineID parent_engine_type, const Vehicle *v, uint8_t livery_setting);
108
109 SpriteID GetEnginePalette(EngineID engine_type, CompanyID company);
110 SpriteID GetVehiclePalette(const Vehicle *v);
111
112extern const StringID _veh_build_msg_table[];
113extern const StringID _veh_sell_msg_table[];
114extern const StringID _veh_refit_msg_table[];
115extern const StringID _send_to_depot_msg_table[];
116
117/* Functions to find the right command for certain vehicle type */
118inline StringID GetCmdBuildVehMsg(VehicleType type)
119{
120 return _veh_build_msg_table[type];
121}
122
123inline StringID GetCmdBuildVehMsg(const BaseVehicle *v)
124{
125 return GetCmdBuildVehMsg(v->type);
126}
127
128inline StringID GetCmdSellVehMsg(VehicleType type)
129{
130 return _veh_sell_msg_table[type];
131}
132
133inline StringID GetCmdSellVehMsg(const BaseVehicle *v)
134{
135 return GetCmdSellVehMsg(v->type);
136}
137
138inline StringID GetCmdRefitVehMsg(VehicleType type)
139{
140 return _veh_refit_msg_table[type];
141}
142
143inline StringID GetCmdRefitVehMsg(const BaseVehicle *v)
144{
145 return GetCmdRefitVehMsg(v->type);
146}
147
148inline StringID GetCmdSendToDepotMsg(VehicleType type)
149{
150 return _send_to_depot_msg_table[type];
151}
152
153inline StringID GetCmdSendToDepotMsg(const BaseVehicle *v)
154{
155 return GetCmdSendToDepotMsg(v->type);
156}
157
158 CommandCost EnsureNoVehicleOnGround(TileIndex tile);
159 CommandCost EnsureNoTrainOnTrackBits(TileIndex tile, TrackBits track_bits);
160
161bool CanVehicleUseStation(EngineID engine_type, const struct Station *st);
162bool CanVehicleUseStation(const Vehicle *v, const struct Station *st);
163 StringID GetVehicleCannotUseStationReason(const Vehicle *v, const Station *st);
164
165void ReleaseDisasterVehicle(VehicleID vehicle);
166
167typedef std::vector<VehicleID> VehicleSet;
168void GetVehicleSet(VehicleSet &set, Vehicle *v, uint8_t num_vehicles);
169
170void CheckCargoCapacity(Vehicle *v);
171
172bool VehiclesHaveSameEngineList(const Vehicle *v1, const Vehicle *v2);
173bool VehiclesHaveSameOrderList(const Vehicle *v1, const Vehicle *v2);
174
175bool IsUniqueVehicleName(const std::string &name);
176
177#endif /* VEHICLE_FUNC_H */
CargoID
uint8_t CargoID
Cargo slots to indicate a cargo type within a game.
Definition cargo_type.h:22
CommandCost
Common return value for all commands.
Definition command_type.h:23
OverflowSafeInt< int64_t >
TimerGameConst< struct Calendar >::DAYS_IN_YEAR
static constexpr int DAYS_IN_YEAR
days per year
Definition timer_game_common.h:149
command_type.h
Types related to commands.
Owner
Owner
Enum for all companies/owners.
Definition company_type.h:18
direction_type.h
Different types to 'show' directions.
Direction
Direction
Defines the 8 directions on the map.
Definition direction_type.h:24
engine_type.h
Types related to engines.
EngineID
uint16_t EngineID
Unique identification number of an engine.
Definition engine_type.h:21
gfx_type.h
Types related to the graphics and/or input devices.
SpriteID
uint32_t SpriteID
The number of a sprite, without mapping bits and colourtables.
Definition gfx_type.h:18
livery.h
Functions/types related to livery colours.
LiveryScheme
LiveryScheme
List of different livery schemes.
Definition livery.h:21
newgrf_config.h
Functions to find and configure NewGRFs.
GRFBugs
GRFBugs
Encountered GRF bugs.
Definition newgrf_config.h:42
StringID
uint32_t StringID
Numeric value that represents a string, independent of the selected language.
Definition strings_type.h:16
BaseVehicle
Base vehicle class.
Definition vehicle_type.h:50
BaseVehicle::type
VehicleType type
Type of vehicle.
Definition vehicle_type.h:51
DrawPixelInfo
Data about how and where to blit pixels.
Definition gfx_type.h:157
GetNewVehiclePosResult
Position information of a vehicle after it moved.
Definition vehicle_func.h:77
GetNewVehiclePosResult::new_tile
TileIndex new_tile
Tile of the vehicle after moving.
Definition vehicle_func.h:80
GetNewVehiclePosResult::y
int y
x and y position of the vehicle after moving
Definition vehicle_func.h:78
GetNewVehiclePosResult::old_tile
TileIndex old_tile
Current tile of the vehicle.
Definition vehicle_func.h:79
Livery
Information about a particular livery.
Definition livery.h:78
Station
Station data structure.
Definition station_base.h:439
StrongType::Typedef< uint32_t, struct TileIndexTag, StrongType::Compare, StrongType::Integer, StrongType::Compatible< int32_t >, StrongType::Compatible< int64_t > >
Vehicle
Vehicle data structure.
Definition vehicle_base.h:244
timer_game_economy.h
Definition of the game-economy-timer.
track_type.h
All types related to tracks.
TrackBits
TrackBits
Allow incrementing of Track variables.
Definition track_type.h:35
transport_type.h
Base types related to transport.
UnitID
uint16_t UnitID
Type for the company global vehicle unit number.
Definition transport_type.h:16
CanVehicleUseStation
bool CanVehicleUseStation(EngineID engine_type, const Station *st)
Can this station be used by the given engine type?
Definition vehicle.cpp:3058
EnsureNoVehicleOnGround
CommandCost EnsureNoVehicleOnGround(TileIndex tile)
Ensure there is no vehicle at the ground at the given position.
Definition vehicle.cpp:546
IsUniqueVehicleName
bool IsUniqueVehicleName(const std::string &name)
Test if a name is unique among vehicle names.
Definition vehicle_cmd.cpp:753
VehiclesHaveSameEngineList
bool VehiclesHaveSameEngineList(const Vehicle *v1, const Vehicle *v2)
Checks if two vehicle chains have the same list of engines.
Definition vehicle.cpp:3272
VehiclesHaveSameOrderList
bool VehiclesHaveSameOrderList(const Vehicle *v1, const Vehicle *v2)
Checks if two vehicles have the same list of orders.
Definition vehicle.cpp:3289
GetEnginePalette
SpriteID GetEnginePalette(EngineID engine_type, CompanyID company)
Get the colour map for an engine.
Definition vehicle.cpp:2142
VehicleEnterDepot
void VehicleEnterDepot(Vehicle *v)
Vehicle entirely entered the depot, update its status, orders, vehicle windows, service it,...
Definition vehicle.cpp:1552
VEHICLE_PROFIT_MIN_AGE
static const TimerGameEconomy::Date VEHICLE_PROFIT_MIN_AGE
Only vehicles older than this have a meaningful profit.
Definition vehicle_func.h:28
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:3218
HasVehicleOnPosXY
bool HasVehicleOnPosXY(int x, int y, void *data, VehicleFromPosProc *proc)
Checks whether a vehicle in on a specific location.
Definition vehicle.cpp:461
CheckCargoCapacity
void CheckCargoCapacity(Vehicle *v)
Check the capacity of all vehicles in a chain and spread cargo if needed.
Definition autoreplace_cmd.cpp:107
GetFreeUnitNumber
UnitID GetFreeUnitNumber(VehicleType type)
Get an unused unit number for a vehicle (if allowed).
Definition vehicle.cpp:1895
RunVehicleCalendarDayProc
void RunVehicleCalendarDayProc()
Age all vehicles, spreading out the action using the current TimerGameCalendar::date_fract.
Definition vehicle.cpp:937
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
IsValidImageIndex
bool IsValidImageIndex(uint8_t image_index)
Helper to check whether an image index is valid for a particular vehicle.
GetBestFittingSubType
uint8_t 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:599
VehicleServiceInDepot
void VehicleServiceInDepot(Vehicle *v)
Service a vehicle and all subsequent vehicles in the consist.
Definition vehicle.cpp:167
VEHICLE_PROFIT_THRESHOLD
static const Money VEHICLE_PROFIT_THRESHOLD
Threshold for a vehicle to be considered making good profit.
Definition vehicle_func.h:29
EnsureNoTrainOnTrackBits
CommandCost EnsureNoTrainOnTrackBits(TileIndex tile, TrackBits track_bits)
Tests if a vehicle interacts with the specified track bits.
Definition vehicle.cpp:608
FindVehicleOnPosXY
void FindVehicleOnPosXY(int x, int y, void *data, VehicleFromPosProc *proc)
Find a vehicle from a specific location.
Definition vehicle.cpp:445
GetEngineLiveryScheme
LiveryScheme GetEngineLiveryScheme(EngineID engine_type, EngineID parent_engine_type, const Vehicle *v)
Determines the LiveryScheme for a vehicle.
Definition vehicle.cpp:1970
ViewportAddVehicles
void ViewportAddVehicles(DrawPixelInfo *dpi)
Add the vehicle sprites that should be drawn at a part of the screen.
Definition vehicle.cpp:1154
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:1784
HasVehicleOnPos
bool HasVehicleOnPos(TileIndex tile, void *data, VehicleFromPosProc *proc)
Checks whether a vehicle is on a specific location.
Definition vehicle.cpp:520
FindVehicleOnPos
void FindVehicleOnPos(TileIndex tile, void *data, VehicleFromPosProc *proc)
Find a vehicle from a specific location.
Definition vehicle.cpp:505
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:3104
ReleaseDisasterVehicle
void ReleaseDisasterVehicle(VehicleID vehicle)
Notify disasters that we are about to delete a vehicle.
Definition disaster_vehicle.cpp:981
DecreaseVehicleValue
void DecreaseVehicleValue(Vehicle *v)
Decrease the value of a vehicle.
Definition vehicle.cpp:1301
EconomyAgeVehicle
void EconomyAgeVehicle(Vehicle *v)
Update economy age of a vehicle.
Definition vehicle.cpp:1429
GetEngineLivery
const struct Livery * GetEngineLivery(EngineID engine_type, CompanyID company, EngineID parent_engine_type, const Vehicle *v, uint8_t livery_setting)
Determines the livery for a vehicle.
Definition vehicle.cpp:2064
TunnelBridgeIsFree
CommandCost TunnelBridgeIsFree(TileIndex tile, TileIndex endtile, const Vehicle *ignore=nullptr)
Finds vehicle in tunnel / bridge.
Definition vehicle.cpp:575
CanBuildVehicleInfrastructure
bool CanBuildVehicleInfrastructure(VehicleType type, uint8_t subtype=0)
Check whether we can build infrastructure for the given vehicle type.
Definition vehicle.cpp:1922
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
AgeVehicle
void AgeVehicle(Vehicle *v)
Update age of a vehicle.
Definition vehicle.cpp:1441
VehicleEnteredDepotThisTick
void VehicleEnteredDepotThisTick(Vehicle *v)
Adds a vehicle to the list of vehicles that visited a depot this tick.
Definition vehicle.cpp:921
GetVehiclePalette
SpriteID GetVehiclePalette(const Vehicle *v)
Get the colour map for a vehicle.
Definition vehicle.cpp:2152
CalcPercentVehicleFilled
uint8_t CalcPercentVehicleFilled(const Vehicle *v, StringID *colour)
Calculates how full a vehicle is.
Definition vehicle.cpp:1493
IsCompanyBuildableVehicleType
bool IsCompanyBuildableVehicleType(VehicleType type)
Is the given vehicle type buildable by a company?
Definition vehicle_func.h:91
vehicle_type.h
Types related to vehicles.
VehicleType
VehicleType
Available vehicle types.
Definition vehicle_type.h:21
VEH_COMPANY_END
@ VEH_COMPANY_END
Last company-ownable type.
Definition vehicle_type.h:29
VehicleID
uint32_t VehicleID
The type all our vehicle IDs have.
Definition vehicle_type.h:16