summaryrefslogtreecommitdiff
path: root/src/script/api/script_cargolist.hpp
diff options
context:
space:
mode:
authortruebrain <truebrain@openttd.org>2011-11-29 23:07:38 +0000
committertruebrain <truebrain@openttd.org>2011-11-29 23:07:38 +0000
commitafdb67a3534f85b4efbd3327ece8137211042d7b (patch)
treeb62375a3846c2089e1c6904331e8f5a3d44851ba /src/script/api/script_cargolist.hpp
parent5f6dc2466318b1275e8b654a260a6c565a0ecc5c (diff)
downloadopenttd-afdb67a3534f85b4efbd3327ece8137211042d7b.tar.xz
(svn r23354) -Codechange: move all src/ai/api/ai_*.[hc]pp files to src/script/api/script_* (Rubidium)
Diffstat (limited to 'src/script/api/script_cargolist.hpp')
-rw-r--r--src/script/api/script_cargolist.hpp64
1 files changed, 64 insertions, 0 deletions
diff --git a/src/script/api/script_cargolist.hpp b/src/script/api/script_cargolist.hpp
new file mode 100644
index 000000000..334792358
--- /dev/null
+++ b/src/script/api/script_cargolist.hpp
@@ -0,0 +1,64 @@
+/* $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_cargolist.hpp List all the cargos. */
+
+#ifndef SCRIPT_CARGOLIST_HPP
+#define SCRIPT_CARGOLIST_HPP
+
+#include "script_list.hpp"
+
+/**
+ * Creates a list of cargos that can be produced in the current game.
+ * @ingroup AIList
+ */
+class AICargoList : public AIList {
+public:
+ AICargoList();
+};
+
+/**
+ * Creates a list of cargos that the given industry accepts.
+ * @note This list also includes cargos that are temporarily not accepted
+ * by this industry, @see AIIndustry::IsCargoAccepted.
+ * @ingroup AIList
+ */
+class AICargoList_IndustryAccepting : public AIList {
+public:
+ /**
+ * @param industry_id The industry to get the list of cargos it accepts from.
+ */
+ AICargoList_IndustryAccepting(IndustryID industry_id);
+};
+
+/**
+ * Creates a list of cargos that the given industry can produce.
+ * @ingroup AIList
+ */
+class AICargoList_IndustryProducing : public AIList {
+public:
+ /**
+ * @param industry_id The industry to get the list of cargos it produces from.
+ */
+ AICargoList_IndustryProducing(IndustryID industry_id);
+};
+
+/**
+ * Creates a list of cargos that the given station accepts.
+ * @ingroup AIList
+ */
+class AICargoList_StationAccepting : public AIList {
+public:
+ /**
+ * @param station_id The station to get the list of cargos it accepts from.
+ */
+ AICargoList_StationAccepting(StationID station_id);
+};
+
+#endif /* SCRIPT_CARGOLIST_HPP */