src/script/api/script_waypointlist.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_waypointlist.hpp List all the waypoints (you own). */
  11
  12 #ifndef SCRIPT_WAYPOINTLIST_HPP
  13 #define SCRIPT_WAYPOINTLIST_HPP
  14
  15 #include "script_list.hpp"
  16 #include "script_waypoint.hpp"
  17
  18 /**
  19  * Creates a list of waypoints of which you are the owner.
  20  * @api ai game
  21  * @ingroup ScriptList
  22  */
  23 class ScriptWaypointList : public ScriptList {
  24 public:
  25         /**
  26          * @param waypoint_type The type of waypoint to make a list of waypoints for.
  27          */
  28         ScriptWaypointList(ScriptWaypoint::WaypointType waypoint_type);
  29 };
  30
  31 /**
  32  * Creates a list of waypoints which the vehicle has in its orders.
  33  * @api ai game
  34  * @ingroup ScriptList
  35  */
  36 class ScriptWaypointList_Vehicle : public ScriptList {
  37 public:
  38         /**
  39          * @param vehicle_id The vehicle to get the list of waypoints he has in its orders from.
  40          */
  41         ScriptWaypointList_Vehicle(VehicleID vehicle_id);
  42 };
  43
  44 #endif /* SCRIPT_WAYPOINTLIST_HPP */