src/script/api/script_cargolist.hpp

   1 /*
   2  * This file is part of OpenTTD.
   3  * 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.
   4  * 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.
   5  * 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/>.
   6  */
   7
   8 /** @file script_cargolist.hpp List all the cargoes. */
   9
  10 #ifndef SCRIPT_CARGOLIST_HPP
  11 #define SCRIPT_CARGOLIST_HPP
  12
  13 #include "script_list.hpp"
  14
  15 /**
  16  * Creates a list of cargoes that can be produced in the current game.
  17  * @api ai game
  18  * @ingroup ScriptList
  19  */
  20 class ScriptCargoList : public ScriptList {
  21 public:
  22         ScriptCargoList();
  23 };
  24
  25 /**
  26  * Creates a list of cargoes that the given industry accepts.
  27  * @note This list also includes cargoes that are temporarily not accepted
  28  *   by this industry, @see ScriptIndustry::IsCargoAccepted.
  29  * @api ai game
  30  * @ingroup ScriptList
  31  */
  32 class ScriptCargoList_IndustryAccepting : public ScriptList {
  33 public:
  34         /**
  35          * @param industry_id The industry to get the list of cargoes it accepts from.
  36          */
  37         ScriptCargoList_IndustryAccepting(IndustryID industry_id);
  38 };
  39
  40 /**
  41  * Creates a list of cargoes that the given industry can produce.
  42  * @api ai game
  43  * @ingroup ScriptList
  44  */
  45 class ScriptCargoList_IndustryProducing : public ScriptList {
  46 public:
  47         /**
  48          * @param industry_id The industry to get the list of cargoes it produces from.
  49          */
  50         ScriptCargoList_IndustryProducing(IndustryID industry_id);
  51 };
  52
  53 /**
  54  * Creates a list of cargoes that the given station accepts.
  55  * @api ai game
  56  * @ingroup ScriptList
  57  */
  58 class ScriptCargoList_StationAccepting : public ScriptList {
  59 public:
  60         /**
  61          * @param station_id The station to get the list of cargoes it accepts from.
  62          */
  63         ScriptCargoList_StationAccepting(StationID station_id);
  64 };
  65
  66 #endif /* SCRIPT_CARGOLIST_HPP */