ai_waypoint.hpp

Go to the documentation of this file.
00001 /* $Id: ai_waypoint.hpp 18725 2010-01-04 19:42:29Z frosch $ */
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 AI_WAYPOINT_HPP
00013 #define AI_WAYPOINT_HPP
00014 
00015 #include "ai_object.hpp"
00016 #include "ai_error.hpp"
00017 #include "ai_basestation.hpp"
00018 
00022 class AIWaypoint : public AIBaseStation {
00023 public:
00024   static const char *GetClassName() { return "AIWaypoint"; }
00025 
00029   enum WaypointType {
00030     /* Values are important, as they represent the internal state of the game. */
00031     WAYPOINT_RAIL      = 0x01, 
00032     WAYPOINT_BUOY      = 0x10, 
00033     WAYPOINT_ANY       = 0x11, 
00034   };
00035 
00039   enum ErrorMessages {
00041     ERR_WAYPOINT_BASE = AIError::ERR_CAT_WAYPOINT << AIError::ERR_CAT_BIT_SIZE,
00042 
00044     ERR_WAYPOINT_TOO_CLOSE_TO_ANOTHER_WAYPOINT, // [STR_ERROR_TOO_CLOSE_TO_ANOTHER_WAYPOINT]
00045 
00047     ERR_WAYPOINT_ADJOINS_MULTIPLE_WAYPOINTS,    // [STR_ERROR_WAYPOINT_ADJOINS_MORE_THAN_ONE_EXISTING]
00048   };
00049 
00055   static bool IsValidWaypoint(StationID waypoint_id);
00056 
00063   static StationID GetWaypointID(TileIndex tile);
00064 
00071   static bool HasWaypointType(StationID waypoint_id, WaypointType waypoint_type);
00072 };
00073 
00074 DECLARE_ENUM_AS_BIT_SET(AIWaypoint::WaypointType);
00075 
00076 #endif /* AI_WAYPOINT_HPP */

Generated on Sat Nov 20 20:59:01 2010 for OpenTTD by  doxygen 1.6.1