From c0e7ddeb9ee8892103a1314dac25e0d7250e6af4 Mon Sep 17 00:00:00 2001 From: yexo Date: Thu, 19 Feb 2009 07:40:08 +0000 Subject: [PATCH] (svn r15519) -Add [NoAI]: support for waypoints by adding AIRail::Build/Remove RailWaypoint, AIWaypoint and AIWaypointList. --- projects/openttd_vs80.vcproj | 16 ++++++++ projects/openttd_vs90.vcproj | 16 ++++++++ source.list | 4 ++ src/ai/ai_instance.cpp | 2 + src/ai/api/ai_rail.cpp | 18 +++++++++ src/ai/api/ai_rail.hpp | 21 ++++++++++ src/ai/api/ai_rail.hpp.sq | 2 + src/ai/api/ai_types.hpp | 1 + src/ai/api/ai_waypoint.cpp | 53 +++++++++++++++++++++++++ src/ai/api/ai_waypoint.hpp | 66 +++++++++++++++++++++++++++++++ src/ai/api/ai_waypoint.hpp.sq | 33 ++++++++++++++++ src/ai/api/ai_waypointlist.cpp | 29 ++++++++++++++ src/ai/api/ai_waypointlist.hpp | 35 ++++++++++++++++ src/ai/api/ai_waypointlist.hpp.sq | 38 ++++++++++++++++++ 14 files changed, 334 insertions(+) create mode 100644 src/ai/api/ai_waypoint.cpp create mode 100644 src/ai/api/ai_waypoint.hpp create mode 100644 src/ai/api/ai_waypoint.hpp.sq create mode 100644 src/ai/api/ai_waypointlist.cpp create mode 100644 src/ai/api/ai_waypointlist.hpp create mode 100644 src/ai/api/ai_waypointlist.hpp.sq diff --git a/projects/openttd_vs80.vcproj b/projects/openttd_vs80.vcproj index 2065749302..c80949e933 100644 --- a/projects/openttd_vs80.vcproj +++ b/projects/openttd_vs80.vcproj @@ -2699,6 +2699,14 @@ RelativePath=".\..\src\ai\api\ai_vehiclelist.hpp" > + + + + + + + + + + + + + + + + owner == _current_company; +} + +/* static */ WaypointID AIWaypoint::GetWaypointID(TileIndex tile) +{ + if (!AIRail::IsRailWaypointTile(tile)) return WAYPOINT_INVALID; + + return ::GetWaypointIndex(tile); +} + +/* static */ char *AIWaypoint::GetName(WaypointID waypoint_id) +{ + if (!IsValidWaypoint(waypoint_id)) return NULL; + + static const int len = 64; + char *waypoint_name = MallocT(len); + + ::SetDParam(0, waypoint_id); + ::GetString(waypoint_name, STR_WAYPOINT_RAW, &waypoint_name[len - 1]); + return waypoint_name; +} + +/* static */ bool AIWaypoint::SetName(WaypointID waypoint_id, const char *name) +{ + EnforcePrecondition(false, IsValidWaypoint(waypoint_id)); + EnforcePrecondition(false, !::StrEmpty(name)); + EnforcePreconditionCustomError(false, ::strlen(name) < MAX_LENGTH_WAYPOINT_NAME_BYTES, AIError::ERR_PRECONDITION_STRING_TOO_LONG); + + return AIObject::DoCommand(0, waypoint_id, 0, CMD_RENAME_WAYPOINT, name); +} + +/* static */ TileIndex AIWaypoint::GetLocation(WaypointID waypoint_id) +{ + if (!IsValidWaypoint(waypoint_id)) return INVALID_TILE; + + return ::GetWaypoint(waypoint_id)->xy; +} diff --git a/src/ai/api/ai_waypoint.hpp b/src/ai/api/ai_waypoint.hpp new file mode 100644 index 0000000000..69eacb10e6 --- /dev/null +++ b/src/ai/api/ai_waypoint.hpp @@ -0,0 +1,66 @@ +/* $Id$ */ + +/** @file ai_waypoint.hpp Everything to query and build waypoints. */ + +#ifndef AI_WAYPOINT_HPP +#define AI_WAYPOINT_HPP + +#include "ai_object.hpp" +#include "ai_error.hpp" + +/** + * Class that handles all waypoint related functions. + */ +class AIWaypoint : public AIObject { +public: + static const char *GetClassName() { return "AIWaypoint"; } + + enum SpecialWaypointIDs { + WAYPOINT_INVALID = -1, //!< 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); + + /** + * Get the WaypointID of a tile. + * @param tile The tile to find the WaypointID of. + * @pre AIRail::IsRailWaypointTile(tile). + * @return WaypointID 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); +}; + +#endif /* AI_WAYPOINT_HPP */ diff --git a/src/ai/api/ai_waypoint.hpp.sq b/src/ai/api/ai_waypoint.hpp.sq new file mode 100644 index 0000000000..4985e745f7 --- /dev/null +++ b/src/ai/api/ai_waypoint.hpp.sq @@ -0,0 +1,33 @@ +/* $Id$ */ +/* THIS FILE IS AUTO-GENERATED; PLEASE DO NOT ALTER MANUALLY */ + +#include "ai_waypoint.hpp" + +namespace SQConvert { + /* Allow enums to be used as Squirrel parameters */ + template <> AIWaypoint::SpecialWaypointIDs GetParam(ForceType, HSQUIRRELVM vm, int index, SQAutoFreePointers *ptr) { SQInteger tmp; sq_getinteger(vm, index, &tmp); return (AIWaypoint::SpecialWaypointIDs)tmp; } + template <> int Return(HSQUIRRELVM vm, AIWaypoint::SpecialWaypointIDs res) { sq_pushinteger(vm, (int32)res); return 1; } + + /* Allow AIWaypoint to be used as Squirrel parameter */ + template <> AIWaypoint *GetParam(ForceType, HSQUIRRELVM vm, int index, SQAutoFreePointers *ptr) { SQUserPointer instance; sq_getinstanceup(vm, index, &instance, 0); return (AIWaypoint *)instance; } + template <> AIWaypoint &GetParam(ForceType, HSQUIRRELVM vm, int index, SQAutoFreePointers *ptr) { SQUserPointer instance; sq_getinstanceup(vm, index, &instance, 0); return *(AIWaypoint *)instance; } + template <> const AIWaypoint *GetParam(ForceType, HSQUIRRELVM vm, int index, SQAutoFreePointers *ptr) { SQUserPointer instance; sq_getinstanceup(vm, index, &instance, 0); return (AIWaypoint *)instance; } + template <> const AIWaypoint &GetParam(ForceType, HSQUIRRELVM vm, int index, SQAutoFreePointers *ptr) { SQUserPointer instance; sq_getinstanceup(vm, index, &instance, 0); return *(AIWaypoint *)instance; } + template <> int Return(HSQUIRRELVM vm, AIWaypoint *res) { if (res == NULL) { sq_pushnull(vm); return 1; } res->AddRef(); Squirrel::CreateClassInstanceVM(vm, "AIWaypoint", res, NULL, DefSQDestructorCallback); return 1; } +}; // namespace SQConvert + +void SQAIWaypoint_Register(Squirrel *engine) { + DefSQClass SQAIWaypoint("AIWaypoint"); + SQAIWaypoint.PreRegister(engine); + SQAIWaypoint.AddConstructor(engine, "x"); + + SQAIWaypoint.DefSQConst(engine, AIWaypoint::WAYPOINT_INVALID, "WAYPOINT_INVALID"); + + SQAIWaypoint.DefSQStaticMethod(engine, &AIWaypoint::IsValidWaypoint, "IsValidWaypoint", 2, "?i"); + SQAIWaypoint.DefSQStaticMethod(engine, &AIWaypoint::GetWaypointID, "GetWaypointID", 2, "?i"); + SQAIWaypoint.DefSQStaticMethod(engine, &AIWaypoint::GetName, "GetName", 2, "?i"); + SQAIWaypoint.DefSQStaticMethod(engine, &AIWaypoint::SetName, "SetName", 3, "?is"); + SQAIWaypoint.DefSQStaticMethod(engine, &AIWaypoint::GetLocation, "GetLocation", 2, "?i"); + + SQAIWaypoint.PostRegister(engine); +} diff --git a/src/ai/api/ai_waypointlist.cpp b/src/ai/api/ai_waypointlist.cpp new file mode 100644 index 0000000000..2b25157a44 --- /dev/null +++ b/src/ai/api/ai_waypointlist.cpp @@ -0,0 +1,29 @@ +/* $Id$ */ + +/** @file ai_waypointlist.cpp Implementation of AIWaypointList and friends. */ + +#include "ai_waypointlist.hpp" +#include "ai_vehicle.hpp" +#include "ai_waypoint.hpp" +#include "../../company_func.h" +#include "../../vehicle_base.h" +#include "../../waypoint.h" + +AIWaypointList::AIWaypointList() +{ + const Waypoint *wp; + FOR_ALL_WAYPOINTS(wp) { + if (wp->owner == _current_company) this->AddItem(wp->index); + } +} + +AIWaypointList_Vehicle::AIWaypointList_Vehicle(VehicleID vehicle_id) +{ + if (!AIVehicle::IsValidVehicle(vehicle_id)) return; + + const Vehicle *v = ::GetVehicle(vehicle_id); + + for (const Order *o = v->GetFirstOrder(); o != NULL; o = o->next) { + if (o->IsType(OT_GOTO_WAYPOINT)) this->AddItem(o->GetDestination()); + } +} diff --git a/src/ai/api/ai_waypointlist.hpp b/src/ai/api/ai_waypointlist.hpp new file mode 100644 index 0000000000..7b67f5382c --- /dev/null +++ b/src/ai/api/ai_waypointlist.hpp @@ -0,0 +1,35 @@ +/* $Id$ */ + +/** @file ai_waypointlist.hpp List all the waypoints (you own). */ + +#ifndef AI_WAYPOINTLIST_HPP +#define AI_WAYPOINTLIST_HPP + +#include "ai_abstractlist.hpp" + +/** + * Creates a list of waypoints of which you are the owner. + * @ingroup AIList + */ +class AIWaypointList : public AIAbstractList { +public: + static const char *GetClassName() { return "AIWaypointList"; } + + AIWaypointList(); +}; + +/** + * Creates a list of waypoints which the vehicle has in its orders. + * @ingroup AIList + */ +class AIWaypointList_Vehicle : public AIAbstractList { +public: + static const char *GetClassName() { return "AIWaypointList_Vehicle"; } + + /** + * @param vehicle_id The vehicle to get the list of waypoints he has in its orders from. + */ + AIWaypointList_Vehicle(VehicleID vehicle_id); +}; + +#endif /* AI_WAYPOINTLIST_HPP */ diff --git a/src/ai/api/ai_waypointlist.hpp.sq b/src/ai/api/ai_waypointlist.hpp.sq new file mode 100644 index 0000000000..f9ea80c65b --- /dev/null +++ b/src/ai/api/ai_waypointlist.hpp.sq @@ -0,0 +1,38 @@ +/* $Id$ */ +/* THIS FILE IS AUTO-GENERATED; PLEASE DO NOT ALTER MANUALLY */ + +#include "ai_waypointlist.hpp" + +namespace SQConvert { + /* Allow AIWaypointList to be used as Squirrel parameter */ + template <> AIWaypointList *GetParam(ForceType, HSQUIRRELVM vm, int index, SQAutoFreePointers *ptr) { SQUserPointer instance; sq_getinstanceup(vm, index, &instance, 0); return (AIWaypointList *)instance; } + template <> AIWaypointList &GetParam(ForceType, HSQUIRRELVM vm, int index, SQAutoFreePointers *ptr) { SQUserPointer instance; sq_getinstanceup(vm, index, &instance, 0); return *(AIWaypointList *)instance; } + template <> const AIWaypointList *GetParam(ForceType, HSQUIRRELVM vm, int index, SQAutoFreePointers *ptr) { SQUserPointer instance; sq_getinstanceup(vm, index, &instance, 0); return (AIWaypointList *)instance; } + template <> const AIWaypointList &GetParam(ForceType, HSQUIRRELVM vm, int index, SQAutoFreePointers *ptr) { SQUserPointer instance; sq_getinstanceup(vm, index, &instance, 0); return *(AIWaypointList *)instance; } + template <> int Return(HSQUIRRELVM vm, AIWaypointList *res) { if (res == NULL) { sq_pushnull(vm); return 1; } res->AddRef(); Squirrel::CreateClassInstanceVM(vm, "AIWaypointList", res, NULL, DefSQDestructorCallback); return 1; } +}; // namespace SQConvert + +void SQAIWaypointList_Register(Squirrel *engine) { + DefSQClass SQAIWaypointList("AIWaypointList"); + SQAIWaypointList.PreRegister(engine, "AIAbstractList"); + SQAIWaypointList.AddConstructor(engine, "x"); + + SQAIWaypointList.PostRegister(engine); +} + +namespace SQConvert { + /* Allow AIWaypointList_Vehicle to be used as Squirrel parameter */ + template <> AIWaypointList_Vehicle *GetParam(ForceType, HSQUIRRELVM vm, int index, SQAutoFreePointers *ptr) { SQUserPointer instance; sq_getinstanceup(vm, index, &instance, 0); return (AIWaypointList_Vehicle *)instance; } + template <> AIWaypointList_Vehicle &GetParam(ForceType, HSQUIRRELVM vm, int index, SQAutoFreePointers *ptr) { SQUserPointer instance; sq_getinstanceup(vm, index, &instance, 0); return *(AIWaypointList_Vehicle *)instance; } + template <> const AIWaypointList_Vehicle *GetParam(ForceType, HSQUIRRELVM vm, int index, SQAutoFreePointers *ptr) { SQUserPointer instance; sq_getinstanceup(vm, index, &instance, 0); return (AIWaypointList_Vehicle *)instance; } + template <> const AIWaypointList_Vehicle &GetParam(ForceType, HSQUIRRELVM vm, int index, SQAutoFreePointers *ptr) { SQUserPointer instance; sq_getinstanceup(vm, index, &instance, 0); return *(AIWaypointList_Vehicle *)instance; } + template <> int Return(HSQUIRRELVM vm, AIWaypointList_Vehicle *res) { if (res == NULL) { sq_pushnull(vm); return 1; } res->AddRef(); Squirrel::CreateClassInstanceVM(vm, "AIWaypointList_Vehicle", res, NULL, DefSQDestructorCallback); return 1; } +}; // namespace SQConvert + +void SQAIWaypointList_Vehicle_Register(Squirrel *engine) { + DefSQClass SQAIWaypointList_Vehicle("AIWaypointList_Vehicle"); + SQAIWaypointList_Vehicle.PreRegister(engine, "AIAbstractList"); + SQAIWaypointList_Vehicle.AddConstructor(engine, "xi"); + + SQAIWaypointList_Vehicle.PostRegister(engine); +}