OpenTTD-patches/src/engine_func.h

/*
 * This file is part of OpenTTD.
 * 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.
 * 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.
 * 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/>.
 */

/** @file engine_func.h Functions related to engines. */

#ifndef ENGINE_FUNC_H
#define ENGINE_FUNC_H

#include "engine_type.h"
#include "vehicle_type.h"
#include "company_type.h"

void SetupEngines();
void StartupEngines();
void CheckEngines();
void AnalyseEngineCallbacks();

/* Original engine data counts and offsets */
extern const uint8 _engine_counts[4];
extern const uint8 _engine_offsets[4];

bool IsEngineBuildable(EngineID engine, VehicleType type, CompanyID company);
bool IsEngineRefittable(EngineID engine);
void GetArticulatedVehicleCargoesAndRefits(EngineID engine, CargoArray *cargoes, CargoTypes *refits, CargoID cargo_type, uint cargo_capacity);
void SetYearEngineAgingStops();
void StartupOneEngine(Engine *e, Date aging_date, Date no_introduce_after_date);

uint GetTotalCapacityOfArticulatedParts(EngineID engine);

#endif /* ENGINE_FUNC_H */
(svn r17248) -Fix: add GPL license notice where appropriate 2009-08-21 20:21:05 +00:00			`/*`
			`* This file is part of OpenTTD.`
			`* 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.`
			`* 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.`
			`* 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/>.`
			`*/`

(svn r12971) -Documentation: add @file in files that missed them and add something more than whitespace as description of files that don't have a description. 2008-05-06 15:11:33 +00:00			`/** @file engine_func.h Functions related to engines. */`
(svn r8862) -Cleanup: doxygen changes, again. Mostly @files missing tags and a few comments style. Some documentation addition, when i can easily supply them 2007-02-23 18:55:07 +00:00
(svn r21595) -Codechange: Some header files had their name changed, update the ifndef/define/endif lines. 2010-12-22 11:46:41 +00:00			`#ifndef ENGINE_FUNC_H`
			`#define ENGINE_FUNC_H`
(svn r1) Import of revision 975 of old (crashed) SVN 2004-08-09 17:04:08 +00:00
(svn r12476) -Codechange: split type engine related types from engine.h (and openttd.h) to engine_type.h. 2008-03-28 18:00:38 +00:00			`#include "engine_type.h"`
(svn r18809) -Codechange/Cleanup: remove unneeded headers from some files, if a header require a header make it include that header 2010-01-15 16:41:15 +00:00			`#include "vehicle_type.h"`
			`#include "company_type.h"`
(svn r3396) - Autoreplace changes: - Change fixed array per player to a single pool. This avoids future problems with vehicle numbers and decreases savegame size. Engine replacements from previous savegames will be lost. - Move engine replacement code from players.c to engine.c. (thanks to blathijs for rewriting this) 2006-01-12 15:52:18 +00:00
(svn r11784) -Codechange: set up initial engine data in one place 2008-01-08 18:25:51 +00:00			`void SetupEngines();`
(svn r9050) -Codechange: Foo(void) -> Foo() 2007-03-07 11:47:46 +00:00			`void StartupEngines();`
(svn r25553) -Fix [FS#5530]: provide a warning when no vehicles are available, and tell what to do in that case 2013-07-02 18:57:26 +00:00			`void CheckEngines();`
NewGRF: Elide unmasked vehicle callbacks where possible This includes: * CBID_VEHICLE_32DAY_CALLBACK * CBID_VEHICLE_REFIT_COST * CBID_VEHICLE_MODIFY_PROPERTY This is on a per-property basis The main benefit of this is to avoid callbacks not handled by the vehicle's current sprite group from using the full graphics chain as the "default" branch in the callback switch. In the case where the graphics chain is long/expensive, a lot of work had to be done before a callback failure result was eventually returned. 2021-05-18 18:07:44 +00:00			`void AnalyseEngineCallbacks();`
(svn r1) Import of revision 975 of old (crashed) SVN 2004-08-09 17:04:08 +00:00
(svn r12924) -Feature: Introducing the so called 'engine pool' which primarily removes the fixed engine type limits and also happens to allow (with the patch option 'dynamic_engines') multiple NewGRF vehicle sets to coexist. 2008-04-29 21:31:29 +00:00			`/* Original engine data counts and offsets */`
			`extern const uint8 _engine_counts[4];`
			`extern const uint8 _engine_offsets[4];`
(svn r1) Import of revision 975 of old (crashed) SVN 2004-08-09 17:04:08 +00:00
(svn r14421) -Codechange: rename all player variables/types to company or client so it is immediatelly clear which one you are working with. 2008-09-30 20:39:50 +00:00			`bool IsEngineBuildable(EngineID engine, VehicleType type, CompanyID company);`
(svn r14683) -Change: only say a engine/vehicle is refittable when it can be refitted to at least two cargo type or when it has subcargos. NOTE: it is still possible that a vehicle is marked refittable when there is nothing to refit to, e.g. when only one subcargo is available but that cannot be determined without a vehicle chain. 2008-12-16 22:02:12 +00:00			`bool IsEngineRefittable(EngineID engine);`
Fix #8064: Incorrect display of refit capacity 2020-04-06 14:39:58 +00:00			`void GetArticulatedVehicleCargoesAndRefits(EngineID engine, CargoArray cargoes, CargoTypes refits, CargoID cargo_type, uint cargo_capacity);`
(svn r14926) -Feature: Automatically set last engine ageing year to the last 'introduction year plus half model life', to allow engines later than 2050 to appear. 2009-01-08 21:48:59 +00:00			`void SetYearEngineAgingStops();`
Add setting for no vehicles introduced after given year 2021-03-17 18:51:19 +00:00			`void StartupOneEngine(Engine *e, Date aging_date, Date no_introduce_after_date);`
(svn r1) Import of revision 975 of old (crashed) SVN 2004-08-09 17:04:08 +00:00
(svn r17728) -Cleanup: Remove some more unneeded/unused parameters. 2009-10-06 19:52:38 +00:00			`uint GetTotalCapacityOfArticulatedParts(EngineID engine);`
(svn r15666) -Fix [FS#2689]: sorting of engines in the purchase list didn't use the same numbers as the GUI showed, e.g. articulated parts weren't taken into accound when ordering by capacity. 2009-03-10 21:17:00 +00:00
(svn r21595) -Codechange: Some header files had their name changed, update the ifndef/define/endif lines. 2010-12-22 11:46:41 +00:00			`#endif /* ENGINE_FUNC_H */`