# ai_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 AI_WAYPOINT_HPP
    00013 #define AI_WAYPOINT_HPP
    00014
    00015 #include "ai_basestation.hpp"
    00016
    00020 class AIWaypoint : public AIBaseStation {
    00021 public:
    00023   static const char *GetClassName() { return "AIWaypoint"; }
    00024
    00028   enum WaypointType {
    00029     /* Values are important, as they represent the internal state of the game. */
    00030     WAYPOINT_RAIL      = 0x01,
    00031     WAYPOINT_BUOY      = 0x10,
    00032     WAYPOINT_ANY       = 0x11,
    00033   };
    00034
    00038   enum ErrorMessages {
    00040     ERR_WAYPOINT_BASE = AIError::ERR_CAT_WAYPOINT << AIError::ERR_CAT_BIT_SIZE,
    00041
    00043     ERR_WAYPOINT_TOO_CLOSE_TO_ANOTHER_WAYPOINT, // [STR_ERROR_TOO_CLOSE_TO_ANOTHER_WAYPOINT]
    00044
    00046     ERR_WAYPOINT_ADJOINS_MULTIPLE_WAYPOINTS,    // [STR_ERROR_WAYPOINT_ADJOINS_MORE_THAN_ONE_EXISTING]
    00047   };
    00048
    00054   static bool IsValidWaypoint(StationID waypoint_id);
    00055
    00062   static StationID GetWaypointID(TileIndex tile);
    00063
    00070   static bool HasWaypointType(StationID waypoint_id, WaypointType waypoint_type);
    00071 };
    00072
    00073 DECLARE_ENUM_AS_BIT_SET(AIWaypoint::WaypointType)
    00074
    00075 #endif /* AI_WAYPOINT_HPP */