annotate src/script/api/ai_changelog.hpp @ 18658:227eb97ed2f6 draft

(svn r23506) -Add: [NoAI] Support for dealing with aircraft range.
author michi_cc <michi_cc@openttd.org>
date Tue, 13 Dec 2011 00:43:59 +0000
parents 820ed7ca5fcc
children 5604c42fa1ce
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
18530
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
1 /* $Id$ */
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
2
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
3 /*
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
4 * This file is part of OpenTTD.
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
5 * 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.
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
6 * 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.
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
7 * 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/>.
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
8 */
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
9
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
10 /**
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
11 * @file ai_changelog.hpp Lists all changes / additions to the API.
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
12 *
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
13 * Only new / renamed / deleted api functions will be listed here. A list of
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
14 * bug fixes can be found in the normal changelog. Note that removed API
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
15 * functions may still be available if you return an older API version
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
16 * in GetAPIVersion() in info.nut.
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
17 *
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
18 * \b 1.2.0
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
19 *
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
20 * 1.2.0 is not yet released. The following changes are not set in stone yet.
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
21 *
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
22 * API additions:
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
23 *
18571
820ed7ca5fcc (svn r23416) -Add: [NoAI] API for querying infrastructure costs.
michi_cc <michi_cc@openttd.org>
parents: 18553
diff changeset
24 * \li AIAirport::GetMaintenanceCostFactor
18530
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
25 * \li AICargo::CT_AUTO_REFIT
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
26 * \li AICargo::CT_NO_REFIT
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
27 * \li AICargo::IsValidTownEffect
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
28 * \li AICargoList_StationAccepting
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
29 * \li AICompany::GetQuarterlyIncome
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
30 * \li AICompany::GetQuarterlyExpenses
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
31 * \li AICompany::GetQuarterlyCargoDelivered
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
32 * \li AICompany::GetQuarterlyPerformanceRating
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
33 * \li AICompany::GetQuarterlyCompanyValue
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
34 * \li AIController::GetOpsTillSuspend
18658
227eb97ed2f6 (svn r23506) -Add: [NoAI] Support for dealing with aircraft range.
michi_cc <michi_cc@openttd.org>
parents: 18571
diff changeset
35 * \li AIEngine::GetMaximumOrderDistance
227eb97ed2f6 (svn r23506) -Add: [NoAI] Support for dealing with aircraft range.
michi_cc <michi_cc@openttd.org>
parents: 18571
diff changeset
36 * \li AIEventAircraftDestTooFar
18530
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
37 * \li AIInfo::CONFIG_DEVELOPER
18571
820ed7ca5fcc (svn r23416) -Add: [NoAI] API for querying infrastructure costs.
michi_cc <michi_cc@openttd.org>
parents: 18553
diff changeset
38 * \li AIInfrastructure
18658
227eb97ed2f6 (svn r23506) -Add: [NoAI] Support for dealing with aircraft range.
michi_cc <michi_cc@openttd.org>
parents: 18571
diff changeset
39 * \li AIOrder::ERR_ORDER_AIRCRAFT_NOT_ENOUGH_RANGE
227eb97ed2f6 (svn r23506) -Add: [NoAI] Support for dealing with aircraft range.
michi_cc <michi_cc@openttd.org>
parents: 18571
diff changeset
40 * \li AIOrder::GetOrderDistance
18530
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
41 * \li AIOrder::GetOrderRefit
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
42 * \li AIOrder::IsRefitOrder
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
43 * \li AIOrder::SetOrderRefit
18571
820ed7ca5fcc (svn r23416) -Add: [NoAI] API for querying infrastructure costs.
michi_cc <michi_cc@openttd.org>
parents: 18553
diff changeset
44 * \li AIRail::GetMaintenanceCostFactor
820ed7ca5fcc (svn r23416) -Add: [NoAI] API for querying infrastructure costs.
michi_cc <michi_cc@openttd.org>
parents: 18553
diff changeset
45 * \li AIRoad::GetMaintenanceCostFactor
18530
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
46 * \li AITown::GetCargoGoal
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
47 * \li AITown::GetGrowthRate
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
48 * \li AITown::GetLastMonthReceived
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
49 * \li AITown::GetTownAuthority
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
50 * \li AITownEffectList (to walk over all available town effects)
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
51 * \li AIVehicle::ERR_VEHICLE_TOO_LONG in case vehicle length limit is reached
18658
227eb97ed2f6 (svn r23506) -Add: [NoAI] Support for dealing with aircraft range.
michi_cc <michi_cc@openttd.org>
parents: 18571
diff changeset
52 * \li AIVehicle::GetMaximumOrderDistance
18530
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
53 *
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
54 * API renames:
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
55 * \li AITown::GetLastMonthTransported to AITown::GetLastMonthSupplied to better
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
56 * reflect what it does.
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
57 * \li AIInfo has all its configure settings renamed from AICONFIG to just CONFIG
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
58 * like CONFIG_RANDOM.
18553
ad8b29abd4d7 (svn r23397) -Change: remove the AI_ prefix from all AIEvent enums
truebrain <truebrain@openttd.org>
parents: 18530
diff changeset
59 * \li AIEvent has all its types renamed from AI_ET_ prefix to just ET_ prefix,
ad8b29abd4d7 (svn r23397) -Change: remove the AI_ prefix from all AIEvent enums
truebrain <truebrain@openttd.org>
parents: 18530
diff changeset
60 * like ET_SUBSIDY_OFFER.
18530
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
61 *
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
62 * API removals:
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
63 * \li AICompany::GetCompanyValue, use AICompany::GetQuarterlyCompanyValue instead.
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
64 *
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
65 * Other changes:
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
66 * \li AITown::GetLastMonthProduction no longer has prerequisites based on town
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
67 * effects.
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
68 * \li AITown::GetLastMonthTransported no longer has prerequisites based on
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
69 * town effects.
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
70 * \li AITown::GetLastMonthTransportedPercentage no longer has prerequisites
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
71 * based on town effects.
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
72 *
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
73 * \b 1.1.2
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
74 *
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
75 * No changes
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
76 *
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
77 * \b 1.1.1
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
78 *
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
79 * No changes
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
80 *
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
81 * \b 1.1.0
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
82 *
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
83 * API additions:
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
84 * \li IsEnd for all lists.
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
85 * \li AIEventTownFounded
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
86 * \li AIIndustry::GetIndustryID
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
87 * \li AIIndustryType::INDUSTRYTYPE_TOWN
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
88 * \li AIIndustryType::INDUSTRYTYPE_UNKNOWN
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
89 * \li AIOrder::IsVoidOrder
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
90 * \li AIRail::GetName
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
91 * \li AITown::IsCity
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
92 *
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
93 * API removals:
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
94 * \li HasNext for all lists.
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
95 * \li AIAbstractList, use AIList instead.
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
96 * \li AIList::ChangeItem, use AIList::SetValue instead.
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
97 * \li AIRail::ERR_NONUNIFORM_STATIONS_DISABLED, that error is never returned anymore.
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
98 *
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
99 * Other changes:
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
100 * \li AIEngine::GetMaxTractiveEffort can be used for road vehicles.
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
101 * \li AIEngine::GetPower can be used for road vehicles.
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
102 * \li AIEngine::GetWeight can be used for road vehicles.
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
103 * \li AIIndustry::IsCargoAccepted now returns CargoAcceptState instead of a boolean.
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
104 * \li AIOrder::GetOrderFlags returns AIOrder::AIOF_INVALID for void orders as well.
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
105 * \li AIRoad::BuildDriveThroughRoadStation now allows overbuilding.
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
106 * \li AIRoad::BuildRoadStation now allows overbuilding.
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
107 *
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
108 * \b 1.0.5
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
109 *
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
110 * No changes
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
111 *
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
112 * \b 1.0.4
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
113 *
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
114 * No changes
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
115 *
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
116 * \b 1.0.3
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
117 *
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
118 * API additions:
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
119 * \li AIRail::ERR_RAILTYPE_DISALLOWS_CROSSING
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
120 *
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
121 * \b 1.0.2
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
122 *
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
123 * Other changes:
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
124 * \li AIBridge::GetPrice now returns the price of the bridge without the cost for the rail or road.
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
125 *
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
126 * \b 1.0.1
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
127 *
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
128 * API additions:
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
129 * \li AIRail::GetMaxSpeed
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
130 *
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
131 * \b 1.0.0
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
132 *
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
133 * API additions:
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
134 * \li AIBaseStation
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
135 * \li AIEngine::IsBuildable
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
136 * \li AIEventCompanyAskMerger
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
137 * \li AIIndustry::GetLastMonthTransportedPercentage
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
138 * \li AIInfo::AICONFIG_INGAME
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
139 * \li AIMarine::GetBuildCost
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
140 * \li AIOrder::AIOF_GOTO_NEAREST_DEPOT
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
141 * \li AIOrder::GetStopLocation
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
142 * \li AIOrder::SetStopLocation
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
143 * \li AIRail::RemoveRailStationTileRectangle
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
144 * \li AIRail::RemoveRailWaypointTileRectangle
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
145 * \li AIRail::GetBuildCost
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
146 * \li AIRoad::GetBuildCost
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
147 * \li AISubsidy::SubsidyParticipantType
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
148 * \li AISubsidy::GetSourceType
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
149 * \li AISubsidy::GetSourceIndex
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
150 * \li AISubsidy::GetDestinationType
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
151 * \li AISubsidy::GetDestinationIndex
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
152 * \li AITile::GetBuildCost
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
153 * \li AITown::GetLastMonthTransportedPercentage
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
154 * \li AIVehicleList_Depot
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
155 * \li AIWaypoint::WaypointType
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
156 * \li AIWaypoint::HasWaypointType
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
157 * \li Some error messages to AIWaypoint
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
158 *
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
159 * API removals:
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
160 * \li AIOrder::ChangeOrder, use AIOrder::SetOrderFlags instead
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
161 * \li AIRail::RemoveRailStationTileRect, use AIRail::RemoveRailStationTileRectangle instead
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
162 * \li AIRail::RemoveRailWaypoint, use AIRail::RemoveRailWaypointTileRectangle instead
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
163 * \li AISign::GetMaxSignID, use AISignList instead
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
164 * \li AIStation::ERR_STATION_TOO_LARGE, use AIError::ERR_STATION_TOO_SPREAD_OUT instead
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
165 * \li AISubsidy::SourceIsTown, use AISubsidy::GetSourceType instead
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
166 * \li AISubsidy::GetSource, use AISubsidy::GetSourceIndex instead
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
167 * \li AISubsidy::DestinationIsTown, use AISubsidy::GetDestinationType instead
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
168 * \li AISubsidy::GetDestination, use AISubsidy::GetDestinationIndex instead
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
169 * \li AITile::GetHeight, use AITile::GetMinHeight/GetMaxHeight/GetCornerHeight instead
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
170 * \li AITown::GetMaxProduction, use AITown::GetLastMonthProduction instead
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
171 * \li AIVehicle::SkipToVehicleOrder, use AIOrder::SkipToOrder instead
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
172 * \li AIWaypoint::WAYPOINT_INVALID, use AIBaseStation::STATION_INVALID instead
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
173 *
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
174 * Other changes:
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
175 * \li The GetName / SetName / GetLocation functions were moved from AIStation
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
176 * and AIWaypoint to AIBaseStation, but you can still use AIStation.GetName
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
177 * as before
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
178 * \li The GetConstructionDate function was moved from AIStation to
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
179 * AIBaseStation, but can still be used as AIStation.GetConstructionDate
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
180 * \li WaypointID was replaced by StationID. All WaypointIDs from previous
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
181 * savegames are invalid. Use STATION_INVALID instead of WAYPOINT_INVALID
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
182 * \li AIWaypointList constructor now needs a WaypointType similiar to AIStationList,
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
183 * it can also handle buoys.
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
184 * \li AIVehicleList_Station now also works for waypoints
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
185 * \li Stations can be build over rail without signals that is in the right
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
186 * direction for the to-be built station. It will also convert the rail if
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
187 * the station's rail type supports the old type.
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
188 * \li GetAPIVersion() was added as function to info.nut. If it does not exist
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
189 * API version 0.7 is assumed. This function should return the major and
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
190 * minor number of the stable version of the API the AI is written against.
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
191 * For 0.7.2 that would be 0.7, for 1.1.3 it would be 1.1, etc.
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
192 * \li The subsidy logic has changed. Subsidy is now awarded when cargo
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
193 * originating from subsidy source is delivered to station that has subsidy
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
194 * destination it its catchment area. One industry tile or one town house
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
195 * is enough as long as station accepts the cargo. Awarded subsidies are no
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
196 * longer bound to stations used for first delivery, any station can be
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
197 * used for loading and unloading as long as cargo is transfered from
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
198 * source to destination.
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
199 * \li Make AIEngine:CanRefitCargo() not report refittability to mail by
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
200 * default for aircraft. It is not necessarily true. This means that even
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
201 * if the aircraft can carry mail (as secondary cargo) it does not return
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
202 * true if the aircraft cannot carry it as its only cargo.
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
203 * \li Improve behaviour of AIEngine::GetCargoType(), AIEventEnginePreview::GetCargoType()
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
204 * and AIEngine::CanRefitCargo() for articulated vehicles. For
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
205 * CanRefitCargo true is returned if at least one part can be refitted.
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
206 * For GetCargoType the first most used cargo type is returned.
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
207 * \li AIIndustryType::GetConstructionCost() now returns -1 if the industry is
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
208 * neither buildable nor prospectable.
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
209 * \li AIEngine::IsValidEngine will now return true if you have at least one
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
210 * vehicle of that type in your company, regardless if it's still buildable
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
211 * or not. AIEngine::IsBuildable returns only true when you can actually
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
212 * build an engine.
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
213 * \li AITile::GetCargoProduction will now return the number of producers,
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
214 * including houses instead the number of producing tiles. This means that
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
215 * also industries that do not have a tile within the radius, but where
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
216 * the search bounding box and the industry's bounding box intersect, are
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
217 * counted. Previously these industries (and their cargos), although they
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
218 * produced cargo for a station at the given location, were not returned.
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
219 * \li AIRail::BuildRail will now fail completely if there is an obstacle
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
220 * between the begin and end, instead of building up to the obstacle and
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
221 * returning that everything went okay.
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
222 * \li Orders for buoys are now waypoint orders, i.e. instead of using the
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
223 * station orders for buoys one has to use waypoint orders.
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
224 * \li Autoreplaces can now also be set for the default group via AIGroup.
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
225 *
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
226 * \b 0.7.5
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
227 *
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
228 * No changes
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
229 *
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
230 * \b 0.7.4
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
231 *
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
232 * No changes
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
233 *
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
234 * \b 0.7.3
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
235 *
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
236 * API additions:
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
237 * \li AIAbstractList::SORT_ASCENDING
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
238 * \li AIAbstractList::SORT_DESCENDING
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
239 * \li AIAirport::IsAirportInformationAvailable
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
240 * \li AICompany::GetPresidentGender
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
241 * \li AICompany::SetPresidentGender
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
242 * \li AIEngine::GetDesignDate
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
243 * \li AIStation::GetConstructionDate
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
244 *
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
245 * Other changes:
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
246 * \li AIs are now killed when they execute a DoCommand or Sleep at a time
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
247 * they are not allowed to do so.
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
248 * \li When the API requests a string as parameter you can give every squirrel
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
249 * type and it will be converted to a string
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
250 * \li AIs can create subclasses of API classes and use API constants as part
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
251 * of their own constants
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
252 *
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
253 * \b 0.7.2
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
254 *
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
255 * API additions:
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
256 * \li AIVehicle::GetReliability
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
257 *
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
258 * Other changes:
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
259 * \li DoCommands and sleeps in call, acall, pcall and valuators are disallowed
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
260 *
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
261 * \b 0.7.1
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
262 *
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
263 * API additions:
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
264 * \li AIAirport::GetPrice
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
265 * \li AIController::GetVersion
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
266 * \li AIOrder::AIOF_DEPOT_FLAGS
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
267 * \li AIOrder::AIOF_STOP_IN_DEPOT
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
268 * \li AIOrder::IsCurrentOrderPartOfOrderList
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
269 * \li AIOrder::IsGotoDepotOrder
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
270 * \li AIOrder::IsGotoStationOrder
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
271 * \li AIOrder::IsGotoWaypointOrder
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
272 * \li AISignList
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
273 * \li AITile::CORNER_[WSEN]
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
274 * \li AITile::ERR_AREA_ALREADY_FLAT
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
275 * \li AITile::ERR_EXCAVATION_WOULD_DAMAGE
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
276 * \li AITile::GetCornerHeight
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
277 * \li AITile::GetMaxHeight
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
278 * \li AITile::GetMinHeight
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
279 * \li AIVehicle::SendVehicleToDepotForServicing
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
280 *
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
281 * Other changes:
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
282 * \li GetURL() was added as optional function to info.nut
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
283 * \li UseAsRandomAI() was added as optional function to info.nut
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
284 * \li A limit was introduced on the time the AI spends in the constructor and Load function
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
285 *
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
286 * \b 0.7.0
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
287 * \li First stable release with the NoAI framework.
9b6f5e29506d (svn r23374) -Add: Doxygen files for the NoAI API (Yexo)
truebrain <truebrain@openttd.org>
parents:
diff changeset
288 */