summaryrefslogtreecommitdiff
path: root/src/script/api/script_industrylist.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_industrylist.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_industrylist.hpp')
-rw-r--r--src/script/api/script_industrylist.hpp51
1 files changed, 51 insertions, 0 deletions
diff --git a/src/script/api/script_industrylist.hpp b/src/script/api/script_industrylist.hpp
new file mode 100644
index 000000000..41a2e6586
--- /dev/null
+++ b/src/script/api/script_industrylist.hpp
@@ -0,0 +1,51 @@
+/* $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_industrylist.hpp List all the industries. */
+
+#ifndef SCRIPT_INDUSTRYLIST_HPP
+#define SCRIPT_INDUSTRYLIST_HPP
+
+#include "script_list.hpp"
+
+/**
+ * Creates a list of industries that are currently on the map.
+ * @ingroup AIList
+ */
+class AIIndustryList : public AIList {
+public:
+ AIIndustryList();
+};
+
+/**
+ * Creates a list of industries that accepts a given cargo.
+ * @ingroup AIList
+ */
+class AIIndustryList_CargoAccepting : public AIList {
+public:
+ /**
+ * @param cargo_id The cargo this industry should accept.
+ */
+ AIIndustryList_CargoAccepting(CargoID cargo_id);
+};
+
+/**
+ * Creates a list of industries that can produce a given cargo.
+ * @note It also contains industries that currently produces 0 units of the cargo.
+ * @ingroup AIList
+ */
+class AIIndustryList_CargoProducing : public AIList {
+public:
+ /**
+ * @param cargo_id The cargo this industry should produce.
+ */
+ AIIndustryList_CargoProducing(CargoID cargo_id);
+};
+
+#endif /* SCRIPT_INDUSTRYLIST_HPP */