dave/openttd
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

(svn r17011) -Change [NoAI]: Add AIBaseStation as a parentclass for AIStation and AIWaypoint, and move GetName, SetName and GetLocation to AIBaseStation

Browse Source 
Remove (nearly) all references to WaypointID and replace them with StationID
This commit is contained in:
yexo
2009-07-31 22:30:54 +00:00
parent b129184d57
commit 8c05194c02
14 changed files with 182 additions and 163 deletions
Download Patch File Download Diff File Expand all files Collapse all files

48
src/ai/api/ai_waypoint.hpp
View File

@@ -7,63 +7,29 @@
#include "ai_object.hpp"
#include "ai_error.hpp"
#include "ai_basestation.hpp"
/**
* Class that handles all waypoint related functions.
*/
class AIWaypoint : public AIObject {
class AIWaypoint : public AIBaseStation {
public:
static const char *GetClassName() { return "AIWaypoint"; }
/**
* Special waypoint IDs signalling different kinds of waypoints.
*/
enum SpecialWaypointIDs {
WAYPOINT_INVALID = 0xFFFF, //!< An invalid WaypointID.
};
/**
* Checks whether the given waypoint is valid and owned by you.
* @param waypoint_id The waypoint to check.
* @return True if and only if the waypoint is valid.
*/
static bool IsValidWaypoint(WaypointID waypoint_id);
static bool IsValidWaypoint(StationID waypoint_id);
/**
* Get the WaypointID of a tile.
* @param tile The tile to find the WaypointID of.
* Get the StationID of a tile.
* @param tile The tile to find the StationID of.
* @pre AIRail::IsRailWaypointTile(tile).
* @return WaypointID of the waypoint.
* @return StationID of the waypoint.
*/
static WaypointID GetWaypointID(TileIndex tile);
/**
* Get the name of a waypoint.
* @param waypoint_id The waypoint to get the name of.
* @pre IsValidWaypoint(waypoint_id).
* @return The name of the waypoint.
*/
static char *GetName(WaypointID waypoint_id);
/**
* Set the name this waypoint.
* @param waypoint_id The waypoint to set the name of.
* @param name The new name of the waypoint.
* @pre IsValidWaypointwaypoint_id).
* @pre 'name' must have at least one character.
* @pre 'name' must have at most 30 characters.
* @exception AIError::ERR_NAME_IS_NOT_UNIQUE
* @return True if the name was changed.
*/
static bool SetName(WaypointID waypoint_id, const char *name);
/**
* Get the current location of a waypoint.
* @param waypoint_id The waypoint to get the location of.
* @pre IsValidWaypoint(waypoint_id).
* @return The tile the waypoint is currently on.
*/
static TileIndex GetLocation(WaypointID waypoint_id);
static StationID GetWaypointID(TileIndex tile);
};
#endif /* AI_WAYPOINT_HPP */