src/script/api/script_enginelist.hpp

   1 /* $Id$ */
   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_enginelist.hpp List all the engines. */
  11
  12 #ifndef SCRIPT_ENGINELIST_HPP
  13 #define SCRIPT_ENGINELIST_HPP
  14
  15 #include "script_list.hpp"
  16 #include "script_vehicle.hpp"
  17
  18 /**
  19  * Create a list of engines based on a vehicle type.
  20  * @api ai game
  21  * @ingroup ScriptList
  22  */
  23 class ScriptEngineList : public ScriptList {
  24 public:
  25         /**
  26          * @param vehicle_type The type of vehicle to make a list of engines for.
  27          */
  28         ScriptEngineList(ScriptVehicle::VehicleType vehicle_type);
  29 };
  30
  31 #endif /* SCRIPT_ENGINELIST_HPP */