Files
@ r15837:0edeb7d262a5
Branch filter:
Location: cpp/openttd-patchpack/source/src/ai/api/ai_vehiclelist.hpp
r15837:0edeb7d262a5
3.5 KiB
text/x-c++hdr
(svn r20529) -Codechange: simplify UpdateAirplanesOnNewStation by removing code for situations that don't happen
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 | /* $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 ai_vehiclelist.hpp List all the vehicles (you own). */
#ifndef AI_VEHICLELIST_HPP
#define AI_VEHICLELIST_HPP
#include "ai_abstractlist.hpp"
#include "ai_vehicle.hpp"
/**
* Creates a list of vehicles of which you are the owner.
* @ingroup AIList
*/
class AIVehicleList : public AIAbstractList {
public:
/** Get the name of this class to identify it towards squirrel. */
static const char *GetClassName() { return "AIVehicleList"; }
AIVehicleList();
};
/**
* Creates a list of vehicles that have orders to a given station.
* @ingroup AIList
*/
class AIVehicleList_Station : public AIAbstractList {
public:
/** Get the name of this class to identify it towards squirrel. */
static const char *GetClassName() { return "AIVehicleList_Station"; }
/**
* @param station_id The station to get the list of vehicles from, which have orders to it.
* @pre AIBaseStation::IsValidBaseStation(station_id)
*/
AIVehicleList_Station(StationID station_id);
};
/**
* Creates a list of vehicles that have orders to a given depot.
* The list is created with a tile. If the tile is part of an airport all
* aircraft having a depot order on a hangar of that airport will be
* returned. For all other vehicle types the tile has to be a depot or
* an empty list will be returned.
* @ingroup AIList
*/
class AIVehicleList_Depot : public AIAbstractList {
public:
/** Get the name of this class to identify it towards squirrel. */
static const char *GetClassName() { return "AIVehicleList_Depot"; }
/**
* @param tile The tile of the depot to get the list of vehicles from, which have orders to it.
*/
AIVehicleList_Depot(TileIndex tile);
};
/**
* Creates a list of vehicles that share orders.
* @ingroup AIList
*/
class AIVehicleList_SharedOrders : public AIAbstractList {
public:
/** Get the name of this class to identify it towards squirrel. */
static const char *GetClassName() { return "AIVehicleList_SharedOrders"; }
/**
* @param vehicle_id The vehicle that the rest shared orders with.
*/
AIVehicleList_SharedOrders(VehicleID vehicle_id);
};
/**
* Creates a list of vehicles that are in a group.
* @ingroup AIList
*/
class AIVehicleList_Group : public AIAbstractList {
public:
/** Get the name of this class to identify it towards squirrel. */
static const char *GetClassName() { return "AIVehicleList_Group"; }
/**
* @param group_id The ID of the group the vehicles are in.
*/
AIVehicleList_Group(GroupID group_id);
};
/**
* Creates a list of vehicles that are in the default group.
* @ingroup AIList
*/
class AIVehicleList_DefaultGroup : public AIAbstractList {
public:
/** Get the name of this class to identify it towards squirrel. */
static const char *GetClassName() { return "AIVehicleList_DefaultGroup"; }
/**
* @param vehicle_type The VehicleType to get the list of vehicles for.
*/
AIVehicleList_DefaultGroup(AIVehicle::VehicleType vehicle_type);
};
#endif /* AI_VEHICLELIST_HPP */
|