OpenTTD-patches/src/articulated_vehicles.h

/* $Id$ */

/*
 * 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 articulated_vehicles.h Functions related to articulated vehicles. */

#ifndef ARTICULATED_VEHICLES_H
#define ARTICULATED_VEHICLES_H

#include "vehicle_type.h"
#include "engine_type.h"
#include <vector>

uint CountArticulatedParts(EngineID engine_type, bool purchase_window);
void GetArticulatedPartsEngineIDs(EngineID engine_type, bool purchase_window, std::vector<EngineID> &ids);
CargoArray GetCapacityOfArticulatedParts(EngineID engine);
void AddArticulatedParts(Vehicle *first);
void GetArticulatedRefitMasks(EngineID engine, bool include_initial_cargo_type, CargoTypes *union_mask, CargoTypes *intersection_mask);
CargoTypes GetUnionOfArticulatedRefitMasks(EngineID engine, bool include_initial_cargo_type);
CargoTypes GetIntersectionOfArticulatedRefitMasks(EngineID engine, bool include_initial_cargo_type);
bool IsArticulatedVehicleCarryingDifferentCargoes(const Vehicle *v, CargoID *cargo_type);
bool IsArticulatedVehicleRefittable(EngineID engine);
bool IsArticulatedEngine(EngineID engine_type);
void CheckConsistencyOfArticulatedVehicle(const Vehicle *v);


#endif /* ARTICULATED_VEHICLES_H */
(svn r10008) -Codechange: Move a couple of functions related to articulated vehicles to a file of their own. 2007-06-01 11:41:02 +00:00			`/* $Id$ */`

(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 articulated_vehicles.h Functions related to articulated vehicles. */`
(svn r10008) -Codechange: Move a couple of functions related to articulated vehicles to a file of their own. 2007-06-01 11:41:02 +00:00
			`#ifndef ARTICULATED_VEHICLES_H`
			`#define ARTICULATED_VEHICLES_H`

(svn r11706) -Codechange: split vehicle.h and remove another bunch of useless includes. 2007-12-27 13:35:39 +00:00			`#include "vehicle_type.h"`
(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"`
Fix build and refit cost estimation with artic/multihead vehicles. Trailing vehicle part refit costs were not being added to the cost estimate. 2015-10-12 19:06:59 +00:00			`#include <vector>`
(svn r11706) -Codechange: split vehicle.h and remove another bunch of useless includes. 2007-12-27 13:35:39 +00:00
(svn r11122) -Fix [FS#1234]: crash when building a NewGRF vehicle when the articulated build vehicle callback returneed a different value for the purchase window than the normal build. Thanks for Dalestan and _minime_ for pointers to possible causes. 2007-09-17 04:23:03 +00:00			`uint CountArticulatedParts(EngineID engine_type, bool purchase_window);`
Fix build and refit cost estimation with artic/multihead vehicles. Trailing vehicle part refit costs were not being added to the cost estimate. 2015-10-12 19:06:59 +00:00			`void GetArticulatedPartsEngineIDs(EngineID engine_type, bool purchase_window, std::vector<EngineID> &ids);`
(svn r17728) -Cleanup: Remove some more unneeded/unused parameters. 2009-10-06 19:52:38 +00:00			`CargoArray GetCapacityOfArticulatedParts(EngineID engine);`
(svn r17726) -Cleanup: Remove some unneeded/unused parameters. 2009-10-06 19:30:31 +00:00			`void AddArticulatedParts(Vehicle *first);`
Change: Add CargoTypes type for cargo masks. (#6790) 2018-05-21 21:08:39 +00:00			`void GetArticulatedRefitMasks(EngineID engine, bool include_initial_cargo_type, CargoTypes union_mask, CargoTypes intersection_mask);`
			`CargoTypes GetUnionOfArticulatedRefitMasks(EngineID engine, bool include_initial_cargo_type);`
			`CargoTypes GetIntersectionOfArticulatedRefitMasks(EngineID engine, bool include_initial_cargo_type);`
(svn r23526) -Codechange: unify cargos vs cargoes 2011-12-15 21:56:00 +00:00			`bool IsArticulatedVehicleCarryingDifferentCargoes(const Vehicle v, CargoID cargo_type);`
(svn r15592) -Fix: Refit-info in purchase list did only check the first articulated part. 2009-02-27 20:40:39 +00:00			`bool IsArticulatedVehicleRefittable(EngineID engine);`
(svn r24029) -Change: [NoAI] make AIEngine::IsArticulated return true if the articulated callback flag is set, don't try to run the callback. 2012-03-14 20:49:54 +00:00			`bool IsArticulatedEngine(EngineID engine_type);`
(svn r15701) -Fix [FS#2595]: Blame NewGRFs returning inconsistent information in purchase-list/after building before users have a chance to blame OpenTTD for incorrectly autorenewing/-replacing. 2009-03-13 21:28:40 +00:00			`void CheckConsistencyOfArticulatedVehicle(const Vehicle *v);`

(svn r10008) -Codechange: Move a couple of functions related to articulated vehicles to a file of their own. 2007-06-01 11:41:02 +00:00
			`#endif /* ARTICULATED_VEHICLES_H */`