script_waypoint.hpp

Go to the documentation of this file.
00001 /* $Id$ */
00002 
00003 /*
00004  * This file is part of OpenTTD.
00005  * 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.
00006  * 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.
00007  * 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/>.
00008  */
00009 
00012 #ifndef SCRIPT_WAYPOINT_HPP
00013 #define SCRIPT_WAYPOINT_HPP
00014 
00015 #include "script_basestation.hpp"
00016 
00021 class ScriptWaypoint : public ScriptBaseStation {
00022 public:
00026   enum WaypointType {
00027     /* Values are important, as they represent the internal state of the game. */
00028     WAYPOINT_RAIL      = 0x01, 
00029     WAYPOINT_BUOY      = 0x10, 
00030     WAYPOINT_ANY       = 0x11, 
00031   };
00032 
00036   enum ErrorMessages {
00038     ERR_WAYPOINT_BASE = ScriptError::ERR_CAT_WAYPOINT << ScriptError::ERR_CAT_BIT_SIZE,
00039 
00041     ERR_WAYPOINT_TOO_CLOSE_TO_ANOTHER_WAYPOINT, // [STR_ERROR_TOO_CLOSE_TO_ANOTHER_WAYPOINT]
00042 
00044     ERR_WAYPOINT_ADJOINS_MULTIPLE_WAYPOINTS,    // [STR_ERROR_WAYPOINT_ADJOINS_MORE_THAN_ONE_EXISTING]
00045   };
00046 
00052   static bool IsValidWaypoint(StationID waypoint_id);
00053 
00060   static StationID GetWaypointID(TileIndex tile);
00061 
00068   static bool HasWaypointType(StationID waypoint_id, WaypointType waypoint_type);
00069 };
00070 
00071 DECLARE_ENUM_AS_BIT_SET(ScriptWaypoint::WaypointType)
00072 
00073 #endif /* SCRIPT_WAYPOINT_HPP */