src/script/api/script_industrylist.hpp

   1 /* $Id: script_industrylist.hpp 23614 2011-12-19 20:57:23Z truebrain $ */
   2
   3 /*
   4  * This file is part of OpenTTD.
   5  * 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.
   6  * 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.
   7  * 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/>.
   8  */
   9
  10 /** @file script_industrylist.hpp List all the industries. */
  11
  12 #ifndef SCRIPT_INDUSTRYLIST_HPP
  13 #define SCRIPT_INDUSTRYLIST_HPP
  14
  15 #include "script_list.hpp"
  16
  17 /**
  18  * Creates a list of industries that are currently on the map.
  19  * @api ai game
  20  * @ingroup ScriptList
  21  */
  22 class ScriptIndustryList : public ScriptList {
  23 public:
  24         ScriptIndustryList();
  25 };
  26
  27 /**
  28  * Creates a list of industries that accepts a given cargo.
  29  * @api ai game
  30  * @ingroup ScriptList
  31  */
  32 class ScriptIndustryList_CargoAccepting : public ScriptList {
  33 public:
  34         /**
  35          * @param cargo_id The cargo this industry should accept.
  36          */
  37         ScriptIndustryList_CargoAccepting(CargoID cargo_id);
  38 };
  39
  40 /**
  41  * Creates a list of industries that can produce a given cargo.
  42  * @note It also contains industries that currently produces 0 units of the cargo.
  43  * @api ai game
  44  * @ingroup ScriptList
  45  */
  46 class ScriptIndustryList_CargoProducing : public ScriptList {
  47 public:
  48         /**
  49          * @param cargo_id The cargo this industry should produce.
  50          */
  51         ScriptIndustryList_CargoProducing(CargoID cargo_id);
  52 };
  53
  54 #endif /* SCRIPT_INDUSTRYLIST_HPP */