diff options
author | yexo <yexo@openttd.org> | 2009-02-19 09:01:34 +0000 |
---|---|---|
committer | yexo <yexo@openttd.org> | 2009-02-19 09:01:34 +0000 |
commit | 459a855e6074bca02a7aca174ab37778acc9f55d (patch) | |
tree | 6aae9b77e5e75e74e7759c8d491e82f67ffbc901 /src/ai/api/ai_vehicle.hpp | |
parent | c0e7ddeb9ee8892103a1314dac25e0d7250e6af4 (diff) | |
download | openttd-459a855e6074bca02a7aca174ab37778acc9f55d.tar.xz |
(svn r15520) -Cleanup [NoAI]: Fix some typos, unify the comment style and update some documentation since a few enums have been renamed.
Diffstat (limited to 'src/ai/api/ai_vehicle.hpp')
-rw-r--r-- | src/ai/api/ai_vehicle.hpp | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/src/ai/api/ai_vehicle.hpp b/src/ai/api/ai_vehicle.hpp index 5c363e4f4..43c993637 100644 --- a/src/ai/api/ai_vehicle.hpp +++ b/src/ai/api/ai_vehicle.hpp @@ -268,7 +268,7 @@ public: * Get the RoadType of the vehicle. * @param vehicle_id The vehicle to get the RoadType of. * @pre IsValidVehicle(vehicle_id). - * @pre GetVehicleType(vehicle_id) == VEHICLE_ROAD. + * @pre GetVehicleType(vehicle_id) == VT_ROAD. * @return The RoadType the vehicle has. */ static AIRoad::RoadType GetRoadType(VehicleID vehicle_id); @@ -333,8 +333,8 @@ public: * @pre IsValidVehicle(source_vehicle_id). * @pre source_wagon < GetNumWagons(source_vehicle_id). * @pre dest_vehicle_id == -1 || (IsValidVehicle(dest_vehicle_id) && dest_wagon < GetNumWagons(dest_vehicle_id)). - * @pre GetVehicleType(source_vehicle_id) == VEHICLE_RAIL. - * @pre dest_vehicle_id == -1 || GetVehicleType(dest_vehicle_id) == VEHICLE_RAIL. + * @pre GetVehicleType(source_vehicle_id) == VT_RAIL. + * @pre dest_vehicle_id == -1 || GetVehicleType(dest_vehicle_id) == VT_RAIL. * @return Whether or not moving the wagon succeeded. */ static bool MoveWagon(VehicleID source_vehicle_id, int source_wagon, int dest_vehicle_id, int dest_wagon); @@ -348,8 +348,8 @@ public: * @pre IsValidVehicle(source_vehicle_id). * @pre source_wagon < GetNumWagons(source_vehicle_id). * @pre dest_vehicle_id == -1 || (IsValidVehicle(dest_vehicle_id) && dest_wagon < GetNumWagons(dest_vehicle_id)). - * @pre GetVehicleType(source_vehicle_id) == VEHICLE_RAIL. - * @pre dest_vehicle_id == -1 || GetVehicleType(dest_vehicle_id) == VEHICLE_RAIL. + * @pre GetVehicleType(source_vehicle_id) == VT_RAIL. + * @pre dest_vehicle_id == -1 || GetVehicleType(dest_vehicle_id) == VT_RAIL. * @return Whether or not moving the wagons succeeded. */ static bool MoveWagonChain(VehicleID source_vehicle_id, int source_wagon, int dest_vehicle_id, int dest_wagon); @@ -454,7 +454,7 @@ public: * Turn the given vehicle so it'll drive the other way. * @param vehicle_id The vehicle to turn. * @pre IsValidVehicle(vehicle_id). - * @pre GetVehicleType(vehicle_id) == VEHICLE_ROAD || GetVehicleType(vehicle_id) == VEHICLE_RAIL. + * @pre GetVehicleType(vehicle_id) == VT_ROAD || GetVehicleType(vehicle_id) == VT_RAIL. * @return True if and only if the vehicle has started to turn. * @note Vehicles cannot always be reversed. For example busses and trucks need to be running * and not be inside a depot. @@ -475,7 +475,7 @@ public: * Get the length of a the total vehicle in 1/16's of a tile. * @param vehicle_id The vehicle to get the length of. * @pre IsValidVehicle(vehicle_id). - * @pre GetVehicleType(vehicle_id) == AIVehicle.VEHICLE_ROAD || GetVehicleType(vehicle_id) == AIVehicle.VEHICLE_RAIL. + * @pre GetVehicleType(vehicle_id) == VT_ROAD || GetVehicleType(vehicle_id) == VT_RAIL. * @return The length of the engine. */ static int GetLength(VehicleID vehicle_id); @@ -501,7 +501,7 @@ public: * Check if the vehicle is articulated. * @param vehicle_id The vehicle to check. * @pre IsValidVehicle(vehicle_id). - * @pre GetVehicleType(vehicle_id) == VEHICLE_ROAD || GetVehicleType(vehicle_id) == VEHICLE_RAIL. + * @pre GetVehicleType(vehicle_id) == VT_ROAD || GetVehicleType(vehicle_id) == VT_RAIL. * @return True if the vehicle is articulated. */ static bool IsArticulated(VehicleID vehicle_id); |