src/script/api/script_vehiclelist.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_vehiclelist.hpp List all the vehicles (you own). */
   9
  10 #ifndef SCRIPT_VEHICLELIST_HPP
  11 #define SCRIPT_VEHICLELIST_HPP
  12
  13 #include "script_list.hpp"
  14 #include "script_vehicle.hpp"
  15
  16 /**
  17  * Creates a list of vehicles of which you are the owner.
  18  * @api ai game
  19  * @ingroup ScriptList
  20  */
  21 class ScriptVehicleList : public ScriptList {
  22 public:
  23 #ifdef DOXYGEN_API
  24         ScriptVehicleList();
  25
  26         /**
  27          * Apply a filter when building the list.
  28          * @param filter_function The function which will be doing the filtering.
  29          * @param ... The params to give to the filters (minus the first param,
  30          *  which is always the index-value).
  31          * @note You can write your own filters and use them. Just remember that
  32          *  the first parameter should be the index-value, and it should return
  33          *  a bool.
  34          * @note Example:
  35          * @code
  36          *  local vehs_in_depot = ScriptVehicleList(ScriptVehicle.IsInDepot);
  37          *
  38          *  function IsType(vehicle_id, type)
  39          *  {
  40          *    return ScriptVehicle.GetVehicleType(vehicle_id) == type;
  41          *  }
  42          *  local road_vehs = ScriptVehicleList(IsType, ScriptVehicle.VT_ROAD);
  43          * @endcode
  44          */
  45         ScriptVehicleList(function filter_function, ...);
  46 #else
  47         /**
  48          * The constructor wrapper from Squirrel.
  49          */
  50         ScriptVehicleList(HSQUIRRELVM vm);
  51 #endif /* DOXYGEN_API */
  52 };
  53
  54 /**
  55  * Creates a list of vehicles that have orders to a given station.
  56  * @api ai game
  57  * @ingroup ScriptList
  58  */
  59 class ScriptVehicleList_Station : public ScriptList {
  60 public:
  61         /**
  62          * @param station_id The station to get the list of vehicles from, which have orders to it.
  63          * @pre ScriptBaseStation::IsValidBaseStation(station_id)
  64          */
  65         ScriptVehicleList_Station(StationID station_id);
  66 };
  67
  68 /**
  69  * Creates a list of vehicles that have orders to a given depot.
  70  * The list is created with a tile. If the tile is part of an airport all
  71  * aircraft having a depot order on a hangar of that airport will be
  72  * returned. For all other vehicle types the tile has to be a depot or
  73  * an empty list will be returned.
  74  * @api ai game
  75  * @ingroup ScriptList
  76  */
  77 class ScriptVehicleList_Depot : public ScriptList {
  78 public:
  79         /**
  80          * @param tile The tile of the depot to get the list of vehicles from, which have orders to it.
  81          */
  82         ScriptVehicleList_Depot(TileIndex tile);
  83 };
  84
  85 /**
  86  * Creates a list of vehicles that share orders.
  87  * @api ai game
  88  * @ingroup ScriptList
  89  */
  90 class ScriptVehicleList_SharedOrders : public ScriptList {
  91 public:
  92         /**
  93          * @param vehicle_id The vehicle that the rest shared orders with.
  94          */
  95         ScriptVehicleList_SharedOrders(VehicleID vehicle_id);
  96 };
  97
  98 /**
  99  * Creates a list of vehicles that are in a group.
 100  * @api ai game
 101  * @ingroup ScriptList
 102  */
 103 class ScriptVehicleList_Group : public ScriptList {
 104 public:
 105         /**
 106          * @param group_id The ID of the group the vehicles are in.
 107          * @game @pre ScriptCompanyMode::IsValid().
 108          */
 109         ScriptVehicleList_Group(GroupID group_id);
 110 };
 111
 112 /**
 113  * Creates a list of vehicles that are in the default group.
 114  * @api ai game
 115  * @ingroup ScriptList
 116  */
 117 class ScriptVehicleList_DefaultGroup : public ScriptList {
 118 public:
 119         /**
 120          * @param vehicle_type The VehicleType to get the list of vehicles for.
 121          * @game @pre ScriptCompanyMode::IsValid().
 122          */
 123         ScriptVehicleList_DefaultGroup(ScriptVehicle::VehicleType vehicle_type);
 124 };
 125
 126 #endif /* SCRIPT_VEHICLELIST_HPP */