src/script/api/script_subsidylist.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_subsidylist.hpp List all the subsidies. */
   9
  10 #ifndef SCRIPT_SUBSIDYLIST_HPP
  11 #define SCRIPT_SUBSIDYLIST_HPP
  12
  13 #include "script_list.hpp"
  14
  15 /**
  16  * Creates a list of all current subsidies.
  17  * @api ai game
  18  * @ingroup ScriptList
  19  */
  20 class ScriptSubsidyList : public ScriptList {
  21 public:
  22 #ifdef DOXYGEN_API
  23         ScriptSubsidyList();
  24
  25         /**
  26          * Apply a filter when building the list.
  27          * @param filter_function The function which will be doing the filtering.
  28          * @param ... The params to give to the filters (minus the first param,
  29          *  which is always the index-value).
  30          * @note You can write your own filters and use them. Just remember that
  31          *  the first parameter should be the index-value, and it should return
  32          *  a bool.
  33          * @note Example:
  34          * @code
  35          *  function IsType(subsidy_id, type)
  36          *  {
  37          *    return ScriptSubsidy.GetSourceType(subsidy_id) == type;
  38          *  }
  39          *  local town_subs = ScriptSubsidyList(IsType, ScriptSubsidy.SPT_TOWN);
  40          * @endcode
  41          */
  42         ScriptSubsidyList(function filter_function, ...);
  43 #else
  44         ScriptSubsidyList(HSQUIRRELVM vm);
  45 #endif /* DOXYGEN_API */
  46 };
  47
  48 #endif /* SCRIPT_SUBSIDYLIST_HPP */