openttd-ottdgrfs: src/aircraft.h@7bd07f43b0e3 (annotated)

3963 d7d284c2f1f7 (svn r5124) Add IsAircraftInHangar{Stopped,}(), which supersedes CheckStoppedInHangar() tron parents: diff changeset	1	/* $Id$ */
d7d284c2f1f7 (svn r5124) Add IsAircraftInHangar{Stopped,}(), which supersedes CheckStoppedInHangar() tron parents: diff changeset	2
6447 3b71e57fd22b (svn r8857) -Documentation: Added some doxygen @file tags, repaired others (the @file tag MUST be found before any line of code, that includes preprocessor directives). celestar parents: 6443 diff changeset	3	/** @file aircraft.h */
6443 b8f06d8eb7be (svn r8853) -Cleanup: doxygen changes. Correct forgotten c files to cpp files with the @file tag as well as a few general comments style belugas parents: 6413 diff changeset	4
3987 96b119a9fb94 (svn r5186) - NewGRF: show default aircraft cargo type and the purchase list (mart3p) peter1138 parents: 3963 diff changeset	5	#ifndef AIRCRAFT_H
96b119a9fb94 (svn r5186) - NewGRF: show default aircraft cargo type and the purchase list (mart3p) peter1138 parents: 3963 diff changeset	6	#define AIRCRAFT_H
96b119a9fb94 (svn r5186) - NewGRF: show default aircraft cargo type and the purchase list (mart3p) peter1138 parents: 3963 diff changeset	7
3963 d7d284c2f1f7 (svn r5124) Add IsAircraftInHangar{Stopped,}(), which supersedes CheckStoppedInHangar() tron parents: diff changeset	8	#include "station_map.h"
d7d284c2f1f7 (svn r5124) Add IsAircraftInHangar{Stopped,}(), which supersedes CheckStoppedInHangar() tron parents: diff changeset	9	#include "vehicle.h"
d7d284c2f1f7 (svn r5124) Add IsAircraftInHangar{Stopped,}(), which supersedes CheckStoppedInHangar() tron parents: diff changeset	10
9895 7bd07f43b0e3 (svn r9321) [gamebalance] -Sync: r9025:9314 from trunk celestar parents: 6447 diff changeset	11	enum AircraftSubType {
6105 761d393829d6 (svn r8428) -Codechange: Add proper names to aircraft subtypes instead of magic numbers and add a function IsNormalAircraft() which tells us whether the aircraft is in fact some flying device or a rotor/shadow. Darkvater parents: 6031 diff changeset	12	AIR_HELICOPTER = 0,
761d393829d6 (svn r8428) -Codechange: Add proper names to aircraft subtypes instead of magic numbers and add a function IsNormalAircraft() which tells us whether the aircraft is in fact some flying device or a rotor/shadow. Darkvater parents: 6031 diff changeset	13	AIR_AIRCRAFT = 2,
761d393829d6 (svn r8428) -Codechange: Add proper names to aircraft subtypes instead of magic numbers and add a function IsNormalAircraft() which tells us whether the aircraft is in fact some flying device or a rotor/shadow. Darkvater parents: 6031 diff changeset	14	AIR_SHADOW = 4,
761d393829d6 (svn r8428) -Codechange: Add proper names to aircraft subtypes instead of magic numbers and add a function IsNormalAircraft() which tells us whether the aircraft is in fact some flying device or a rotor/shadow. Darkvater parents: 6031 diff changeset	15	AIR_ROTOR = 6
9895 7bd07f43b0e3 (svn r9321) [gamebalance] -Sync: r9025:9314 from trunk celestar parents: 6447 diff changeset	16	};
6105 761d393829d6 (svn r8428) -Codechange: Add proper names to aircraft subtypes instead of magic numbers and add a function IsNormalAircraft() which tells us whether the aircraft is in fact some flying device or a rotor/shadow. Darkvater parents: 6031 diff changeset	17
761d393829d6 (svn r8428) -Codechange: Add proper names to aircraft subtypes instead of magic numbers and add a function IsNormalAircraft() which tells us whether the aircraft is in fact some flying device or a rotor/shadow. Darkvater parents: 6031 diff changeset	18
761d393829d6 (svn r8428) -Codechange: Add proper names to aircraft subtypes instead of magic numbers and add a function IsNormalAircraft() which tells us whether the aircraft is in fact some flying device or a rotor/shadow. Darkvater parents: 6031 diff changeset	19	/** Check if the aircraft type is a normal flying device; eg
761d393829d6 (svn r8428) -Codechange: Add proper names to aircraft subtypes instead of magic numbers and add a function IsNormalAircraft() which tells us whether the aircraft is in fact some flying device or a rotor/shadow. Darkvater parents: 6031 diff changeset	20	* not a rotor or a shadow
761d393829d6 (svn r8428) -Codechange: Add proper names to aircraft subtypes instead of magic numbers and add a function IsNormalAircraft() which tells us whether the aircraft is in fact some flying device or a rotor/shadow. Darkvater parents: 6031 diff changeset	21	* @param v vehicle to check
761d393829d6 (svn r8428) -Codechange: Add proper names to aircraft subtypes instead of magic numbers and add a function IsNormalAircraft() which tells us whether the aircraft is in fact some flying device or a rotor/shadow. Darkvater parents: 6031 diff changeset	22	* @return Returns true if the aircraft is a helicopter/airplane and
761d393829d6 (svn r8428) -Codechange: Add proper names to aircraft subtypes instead of magic numbers and add a function IsNormalAircraft() which tells us whether the aircraft is in fact some flying device or a rotor/shadow. Darkvater parents: 6031 diff changeset	23	* false if it is a shadow or a rotor) */
761d393829d6 (svn r8428) -Codechange: Add proper names to aircraft subtypes instead of magic numbers and add a function IsNormalAircraft() which tells us whether the aircraft is in fact some flying device or a rotor/shadow. Darkvater parents: 6031 diff changeset	24	static inline bool IsNormalAircraft(const Vehicle *v)
761d393829d6 (svn r8428) -Codechange: Add proper names to aircraft subtypes instead of magic numbers and add a function IsNormalAircraft() which tells us whether the aircraft is in fact some flying device or a rotor/shadow. Darkvater parents: 6031 diff changeset	25	{
9895 7bd07f43b0e3 (svn r9321) [gamebalance] -Sync: r9025:9314 from trunk celestar parents: 6447 diff changeset	26	assert(v->type == VEH_AIRCRAFT);
6105 761d393829d6 (svn r8428) -Codechange: Add proper names to aircraft subtypes instead of magic numbers and add a function IsNormalAircraft() which tells us whether the aircraft is in fact some flying device or a rotor/shadow. Darkvater parents: 6031 diff changeset	27	/* To be fully correct the commented out functionality is the proper one,
761d393829d6 (svn r8428) -Codechange: Add proper names to aircraft subtypes instead of magic numbers and add a function IsNormalAircraft() which tells us whether the aircraft is in fact some flying device or a rotor/shadow. Darkvater parents: 6031 diff changeset	28	* but since value can only be 0 or 2, it is sufficient to only check <= 2
761d393829d6 (svn r8428) -Codechange: Add proper names to aircraft subtypes instead of magic numbers and add a function IsNormalAircraft() which tells us whether the aircraft is in fact some flying device or a rotor/shadow. Darkvater parents: 6031 diff changeset	29	* return (v->subtype == AIR_HELICOPTER) \|\| (v->subtype == AIR_AIRCRAFT); */
761d393829d6 (svn r8428) -Codechange: Add proper names to aircraft subtypes instead of magic numbers and add a function IsNormalAircraft() which tells us whether the aircraft is in fact some flying device or a rotor/shadow. Darkvater parents: 6031 diff changeset	30	return v->subtype <= AIR_AIRCRAFT;
761d393829d6 (svn r8428) -Codechange: Add proper names to aircraft subtypes instead of magic numbers and add a function IsNormalAircraft() which tells us whether the aircraft is in fact some flying device or a rotor/shadow. Darkvater parents: 6031 diff changeset	31	}
761d393829d6 (svn r8428) -Codechange: Add proper names to aircraft subtypes instead of magic numbers and add a function IsNormalAircraft() which tells us whether the aircraft is in fact some flying device or a rotor/shadow. Darkvater parents: 6031 diff changeset	32
3963 d7d284c2f1f7 (svn r5124) Add IsAircraftInHangar{Stopped,}(), which supersedes CheckStoppedInHangar() tron parents: diff changeset	33
d7d284c2f1f7 (svn r5124) Add IsAircraftInHangar{Stopped,}(), which supersedes CheckStoppedInHangar() tron parents: diff changeset	34	static inline bool IsAircraftInHangar(const Vehicle* v)
d7d284c2f1f7 (svn r5124) Add IsAircraftInHangar{Stopped,}(), which supersedes CheckStoppedInHangar() tron parents: diff changeset	35	{
9895 7bd07f43b0e3 (svn r9321) [gamebalance] -Sync: r9025:9314 from trunk celestar parents: 6447 diff changeset	36	assert(v->type == VEH_AIRCRAFT);
3963 d7d284c2f1f7 (svn r5124) Add IsAircraftInHangar{Stopped,}(), which supersedes CheckStoppedInHangar() tron parents: diff changeset	37	return v->vehstatus & VS_HIDDEN && IsHangarTile(v->tile);
d7d284c2f1f7 (svn r5124) Add IsAircraftInHangar{Stopped,}(), which supersedes CheckStoppedInHangar() tron parents: diff changeset	38	}
d7d284c2f1f7 (svn r5124) Add IsAircraftInHangar{Stopped,}(), which supersedes CheckStoppedInHangar() tron parents: diff changeset	39
d7d284c2f1f7 (svn r5124) Add IsAircraftInHangar{Stopped,}(), which supersedes CheckStoppedInHangar() tron parents: diff changeset	40	static inline bool IsAircraftInHangarStopped(const Vehicle* v)
d7d284c2f1f7 (svn r5124) Add IsAircraftInHangar{Stopped,}(), which supersedes CheckStoppedInHangar() tron parents: diff changeset	41	{
d7d284c2f1f7 (svn r5124) Add IsAircraftInHangar{Stopped,}(), which supersedes CheckStoppedInHangar() tron parents: diff changeset	42	return IsAircraftInHangar(v) && v->vehstatus & VS_STOPPED;
d7d284c2f1f7 (svn r5124) Add IsAircraftInHangar{Stopped,}(), which supersedes CheckStoppedInHangar() tron parents: diff changeset	43	}
3987 96b119a9fb94 (svn r5186) - NewGRF: show default aircraft cargo type and the purchase list (mart3p) peter1138 parents: 3963 diff changeset	44
9895 7bd07f43b0e3 (svn r9321) [gamebalance] -Sync: r9025:9314 from trunk celestar parents: 6447 diff changeset	45	/** Checks if an aircraft is buildable at the tile in question
7bd07f43b0e3 (svn r9321) [gamebalance] -Sync: r9025:9314 from trunk celestar parents: 6447 diff changeset	46	* @param engine The engine to test
7bd07f43b0e3 (svn r9321) [gamebalance] -Sync: r9025:9314 from trunk celestar parents: 6447 diff changeset	47	* @param tile The tile where the hangar is
7bd07f43b0e3 (svn r9321) [gamebalance] -Sync: r9025:9314 from trunk celestar parents: 6447 diff changeset	48	* @return true if the aircraft can be build
7bd07f43b0e3 (svn r9321) [gamebalance] -Sync: r9025:9314 from trunk celestar parents: 6447 diff changeset	49	*/
7bd07f43b0e3 (svn r9321) [gamebalance] -Sync: r9025:9314 from trunk celestar parents: 6447 diff changeset	50	static inline bool IsAircraftBuildableAtStation(EngineID engine, TileIndex tile)
7bd07f43b0e3 (svn r9321) [gamebalance] -Sync: r9025:9314 from trunk celestar parents: 6447 diff changeset	51	{
7bd07f43b0e3 (svn r9321) [gamebalance] -Sync: r9025:9314 from trunk celestar parents: 6447 diff changeset	52	const Station *st = GetStationByTile(tile);
7bd07f43b0e3 (svn r9321) [gamebalance] -Sync: r9025:9314 from trunk celestar parents: 6447 diff changeset	53	const AirportFTAClass *apc = st->Airport();
7bd07f43b0e3 (svn r9321) [gamebalance] -Sync: r9025:9314 from trunk celestar parents: 6447 diff changeset	54	const AircraftVehicleInfo *avi = AircraftVehInfo(engine);
7bd07f43b0e3 (svn r9321) [gamebalance] -Sync: r9025:9314 from trunk celestar parents: 6447 diff changeset	55
7bd07f43b0e3 (svn r9321) [gamebalance] -Sync: r9025:9314 from trunk celestar parents: 6447 diff changeset	56	return (apc->flags & (avi->subtype & AIR_CTOL ? AirportFTAClass::AIRPLANES : AirportFTAClass::HELICOPTERS)) != 0;
7bd07f43b0e3 (svn r9321) [gamebalance] -Sync: r9025:9314 from trunk celestar parents: 6447 diff changeset	57	}
7bd07f43b0e3 (svn r9321) [gamebalance] -Sync: r9025:9314 from trunk celestar parents: 6447 diff changeset	58
6413 3d660a812fbd (svn r8822) -Fix tron parents: 6223 diff changeset	59	uint16 AircraftDefaultCargoCapacity(CargoID cid, const AircraftVehicleInfo*);
3987 96b119a9fb94 (svn r5186) - NewGRF: show default aircraft cargo type and the purchase list (mart3p) peter1138 parents: 3963 diff changeset	60
6031 f6d1eef3fa24 (svn r8332) -Codechange: moved DrawAircraftImage() and CcBuildAircraft() from build_vehicle_gui.cpp to aircraft_gui.cpp bjarni parents: 5726 diff changeset	61	void CcBuildAircraft(bool success, TileIndex tile, uint32 p1, uint32 p2);
4653 091f530bae28 (svn r6529) -Fix r6513: [depot window] added missing switch in CcCloneVehicle() bjarni parents: 3987 diff changeset	62	void CcCloneAircraft(bool success, TileIndex tile, uint32 p1, uint32 p2);
4732 da9d305d1c94 (svn r6644) -Fix(r6637): remove inline to allow MSVC compilation belugas parents: 4725 diff changeset	63	void HandleAircraftEnterHangar(Vehicle *v);
6223 92d2073c3d7e (svn r8661) -Fix: [depot windows] Enlarge the blocks in the depot window if a sprite is too big to fit (ships and aircraft only) bjarni parents: 6105 diff changeset	64	void GetAircraftSpriteSize(EngineID engine, uint &width, uint &height);
4653 091f530bae28 (svn r6529) -Fix r6513: [depot window] added missing switch in CcCloneVehicle() bjarni parents: 3987 diff changeset	65
6413 3d660a812fbd (svn r8822) -Fix tron parents: 6223 diff changeset	66	void UpdateAirplanesOnNewStation(const Station *st);
3d660a812fbd (svn r8822) -Fix tron parents: 6223 diff changeset	67
3987 96b119a9fb94 (svn r5186) - NewGRF: show default aircraft cargo type and the purchase list (mart3p) peter1138 parents: 3963 diff changeset	68	#endif /* AIRCRAFT_H */

author	celestar
	Mon, 19 Mar 2007 12:38:16 +0000
branch	gamebalance
changeset 9895	7bd07f43b0e3
parent 6447	3b71e57fd22b
child 9908	0fa543611bbe
permissions	-rw-r--r--