From afdb67a3534f85b4efbd3327ece8137211042d7b Mon Sep 17 00:00:00 2001
From: truebrain <truebrain@openttd.org>
Date: Tue, 29 Nov 2011 23:07:38 +0000
Subject: (svn r23354) -Codechange: move all src/ai/api/ai_*.[hc]pp files to
 src/script/api/script_* (Rubidium)

---
 src/script/api/script_vehiclelist.hpp | 92 +++++++++++++++++++++++++++++++++++
 1 file changed, 92 insertions(+)
 create mode 100644 src/script/api/script_vehiclelist.hpp

(limited to 'src/script/api/script_vehiclelist.hpp')

diff --git a/src/script/api/script_vehiclelist.hpp b/src/script/api/script_vehiclelist.hpp
new file mode 100644
index 000000000..059041f3b
--- /dev/null
+++ b/src/script/api/script_vehiclelist.hpp
@@ -0,0 +1,92 @@
+/* $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 script_vehiclelist.hpp List all the vehicles (you own). */
+
+#ifndef SCRIPT_VEHICLELIST_HPP
+#define SCRIPT_VEHICLELIST_HPP
+
+#include "script_list.hpp"
+#include "script_vehicle.hpp"
+
+/**
+ * Creates a list of vehicles of which you are the owner.
+ * @ingroup AIList
+ */
+class AIVehicleList : public AIList {
+public:
+	AIVehicleList();
+};
+
+/**
+ * Creates a list of vehicles that have orders to a given station.
+ * @ingroup AIList
+ */
+class AIVehicleList_Station : public AIList {
+public:
+	/**
+	 * @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 AIList {
+public:
+	/**
+	 * @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 AIList {
+public:
+	/**
+	 * @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 AIList {
+public:
+	/**
+	 * @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 AIList {
+public:
+	/**
+	 * @param vehicle_type The VehicleType to get the list of vehicles for.
+	 */
+	AIVehicleList_DefaultGroup(AIVehicle::VehicleType vehicle_type);
+};
+
+#endif /* SCRIPT_VEHICLELIST_HPP */
-- 
cgit v1.2.3-54-g00ecf