changeset 12579:1821acd132ca draft

(svn r17019) -Doc: add AI API changelog
author yexo <yexo@openttd.org>
date Sat, 01 Aug 2009 10:48:22 +0000
parents 8d1801a245ad
children 9dee692bdf1a
files projects/openttd_vs80.vcproj projects/openttd_vs90.vcproj source.list src/ai/api/ai_changelog.hpp
diffstat 4 files changed, 72 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/projects/openttd_vs80.vcproj
+++ b/projects/openttd_vs80.vcproj
@@ -2644,6 +2644,10 @@
 				>
 			</File>
 			<File
+				RelativePath=".\..\src\ai\api\ai_changelog.hpp"
+				>
+			</File>
+			<File
 				RelativePath=".\..\src\ai\api\ai_company.hpp"
 				>
 			</File>
--- a/projects/openttd_vs90.vcproj
+++ b/projects/openttd_vs90.vcproj
@@ -2641,6 +2641,10 @@
 				>
 			</File>
 			<File
+				RelativePath=".\..\src\ai\api\ai_changelog.hpp"
+				>
+			</File>
+			<File
 				RelativePath=".\..\src\ai\api\ai_company.hpp"
 				>
 			</File>
--- a/source.list
+++ b/source.list
@@ -614,6 +614,7 @@
 ai/api/ai_buoylist.hpp
 ai/api/ai_cargo.hpp
 ai/api/ai_cargolist.hpp
+ai/api/ai_changelog.hpp
 ai/api/ai_company.hpp
 ai/api/ai_controller.hpp
 ai/api/ai_date.hpp
new file mode 100644
--- /dev/null
+++ b/src/ai/api/ai_changelog.hpp
@@ -0,0 +1,63 @@
+/* $Id$ */
+
+/** @file ai_changelog.hpp Lists all changes / additions to the API.
+ *
+ * Only new / renamed / deleted api functions will be listed here. A list of
+ * bug fixes can be found in the normal changelog.
+ *
+ * \b 0.9.0
+ *
+ * Scheduled API removals:
+ * \li AIOrder::ChangeOrder
+ * \li AISign::GetMaxSignID
+ * \li AITile::GetHeight
+ * \li AIBaseStation::WAYPOINT_INVALID
+ *
+ * \b 0.8.0
+ *
+ * API additions:
+ * \li AIAbstractList::SORT_ASCENDING
+ * \li AIAbstractList::SORT_DESCENDING
+ * \li AIBaseStation
+ * \li AICompany::GetPresidentGender
+ * \li AICompany::SetPresidentGender
+ * \li AIEngine::GetDesignDate
+ *
+ * Other changes:
+ * \li The GetName / SetName / GetLocation functions were moved from AIStation
+ *     and AIWaypoint to AIBaseStation, but you can still use AIStation.GetName
+ *     as before
+ * \li WaypointID was replaced by StationID. All WaypointIDs from previous
+ *     savegames are invalid
+ * \li WAYPOINT_INVALID is now deprecated, use STATION_INVALID instead
+ *
+ * \b 0.7.2
+ *
+ * API additions:
+ * \li AIVehicle::GetReliability
+ *
+ * \b 0.7.1
+ *
+ * API additions:
+ * \li AIAirport::GetPrice
+ * \li AIController::GetVersion
+ * \li AIOrder::AIOF_STOP_IN_DEPOT
+ * \li AIOrder::IsCurrentOrderPartOfOrderList
+ * \li AIOrder::IsGotoDepotOrder
+ * \li AIOrder::IsGotoStationOrder
+ * \li AIOrder::IsGotoWaypointOrder
+ * \li AISignList
+ * \li AITile::ERR_AREA_ALREADY_FLAT
+ * \li AITile::ERR_EXCAVATION_WOULD_DAMAGE
+ * \li AITile::GetCornerHeight
+ * \li AITile::GetMaxHeight
+ * \li AITile::GetMinHeight
+ *
+ * Other changes:
+ * \li GetURL() was added as optional function to info.nut
+ * \li UseAsRandomAI() was added as optional function to info.nut
+ * \li A limit was introduced on the time the AI spends in the constructor and Load function
+ *
+ * \b 0.7.0
+ * \li First stable release with the NoAI framework.
+ */