OpenTTD

engine_func.h
Go to the documentation of this file.
1 /* $Id: engine_func.h 26849 2014-09-18 19:53:22Z alberth $ */
2
3 /*
4 * This file is part of OpenTTD.
5 * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
6 * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
7 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
8 */
9
12 #ifndef ENGINE_FUNC_H
13 #define ENGINE_FUNC_H
14
15 #include "engine_type.h"
16 #include "vehicle_type.h"
17 #include "company_type.h"
18
19 void SetupEngines();
20 void StartupEngines();
21 void CheckEngines();
22
23 /* Original engine data counts and offsets */
24 extern const uint8 _engine_counts[4];
25 extern const uint8 _engine_offsets[4];
26
27 bool IsEngineBuildable(EngineID engine, VehicleType type, CompanyID company);
28 bool IsEngineRefittable(EngineID engine);
29 void GetArticulatedVehicleCargoesAndRefits(EngineID engine, CargoArray *cargoes, uint32 *refits);
30 void SetYearEngineAgingStops();
31 void StartupOneEngine(Engine *e, Date aging_date);
32
33 uint GetTotalCapacityOfArticulatedParts(EngineID engine);
34
35 #endif /* ENGINE_FUNC_H */
StartupEngines
void StartupEngines()
Start/initialise all our engines.
Definition: engine.cpp:688
engine_type.h
Types related to engines.
IsEngineBuildable
bool IsEngineBuildable(EngineID engine, VehicleType type, CompanyID company)
Check if an engine is buildable.
Definition: engine.cpp:1066
_engine_counts
const uint8 _engine_counts[4]
Number of engines of each vehicle type in original engine data.
Definition: engine.cpp:52
VehicleType
VehicleType
Available vehicle types.
Definition: vehicle_type.h:21
SetupEngines
void SetupEngines()
Initialise the engine pool with the data from the original vehicles.
Definition: engine.cpp:545
StartupOneEngine
void StartupOneEngine(Engine *e, Date aging_date)
Start/initialise one engine.
Definition: engine.cpp:643
_engine_offsets
const uint8 _engine_offsets[4]
Offset of the first engine of each vehicle type in original engine data.
Definition: engine.cpp:60
CheckEngines
void CheckEngines()
Check for engines that have an appropriate availability.
Definition: engine.cpp:1126
Engine
Definition: engine_base.h:23
GetArticulatedVehicleCargoesAndRefits
void GetArticulatedVehicleCargoesAndRefits(EngineID engine, CargoArray *cargoes, uint32 *refits)
Get the default cargoes and refits of an articulated vehicle.
Definition: articulated_vehicles.cpp:172
GetTotalCapacityOfArticulatedParts
uint GetTotalCapacityOfArticulatedParts(EngineID engine)
Get the capacity of an engine with articulated parts.
Definition: engine_gui.cpp:163
CargoArray
Class for storing amounts of cargo.
Definition: cargo_type.h:74
SetYearEngineAgingStops
void SetYearEngineAgingStops()
Compute the value for _year_engine_aging_stops.
Definition: engine.cpp:617
EngineID
uint16 EngineID
Unique identification number of an engine.
Definition: engine_type.h:22
vehicle_type.h
Types related to vehicles.
company_type.h
Types related to companies.
IsEngineRefittable
bool IsEngineRefittable(EngineID engine)
Check if an engine is refittable.
Definition: engine.cpp:1102
Date
int32 Date
The type to store our dates in.
Definition: date_type.h:16
Owner
Owner
Enum for all companies/owners.
Definition: company_type.h:20