src/script/api/game_changelog.hpp

   1 /* $Id$ */
   2
   3 /*
   4  * This file is part of OpenTTD.
   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.
   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.
   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/>.
   8  */
   9
  10 /**
  11  * @file game_changelog.hpp Lists all changes / additions to the API.
  12  *
  13  * Only new / renamed / deleted api functions will be listed here. A list of
  14  * bug fixes can be found in the normal changelog. Note that removed API
  15  * functions may still be available if you return an older API version
  16  * in GetAPIVersion() in info.nut.
  17  *
  18  * \b 1.7.0
  19  *
  20  * 1.7.0 is not yet released. The following changes are not set in stone yet.
  21  *
  22  * \b 1.6.1 - 1.6.0
  23  *
  24  * No changes
  25  *
  26  * \b 1.5.3 - 1.5.1
  27  *
  28  * No changes
  29  *
  30  * \b 1.5.0
  31  *
  32  * API additions:
  33  * \li GSList::SwapList
  34  * \li GSStation::GetCargoPlanned
  35  * \li GSStation::GetCargoPlannedFrom
  36  * \li GSStation::GetCargoPlannedFromVia
  37  * \li GSStation::GetCargoPlannedVia
  38  * \li GSStation::GetCargoWaitingFromVia
  39  * \li GSStationList_CargoPlannedByFrom
  40  * \li GSStationList_CargoPlannedByVia
  41  * \li GSStationList_CargoPlannedFromByVia
  42  * \li GSStationList_CargoPlannedViaByFrom
  43  * \li GSStationList_CargoWaitingByFrom
  44  * \li GSStationList_CargoWaitingByVia
  45  * \li GSStationList_CargoWaitingFromByVia
  46  * \li GSStationList_CargoWaitingViaByFrom
  47  *
  48  * Other changes:
  49  * \li GSNews::Create takes two extra parameters to refer to a location, station,
  50  *     industry, or town. The user can click at the news message to jump to the
  51  *     referred location.
  52  *
  53  * \b 1.4.4 - 1.4.3
  54  *
  55  * No changes
  56  *
  57  * \b 1.4.2
  58  *
  59  * Other changes:
  60  * \li GSCargoMonitor delivery and pickup monitor functions have improved boundary checking for
  61  *     their parameters, and return \c -1 if they are found out of bounds.
  62  *
  63  * \b 1.4.1
  64  *
  65  * No changes
  66  *
  67  * \b 1.4.0
  68  *
  69  * API additions:
  70  * \li AICargo::GetDistributionType
  71  * \li GSCompany::ChangeBankBalance
  72  * \li GSDate::DATE_INVALID
  73  * \li GSDate::IsValidDate
  74  * \li GSGoal::GT_STORY_PAGE
  75  * \li GSGoal::IsCompleted
  76  * \li GSGoal::SetCompleted
  77  * \li GSGoal::SetProgress
  78  * \li GSGoal::SetText
  79  * \li GSStation::HasCargoRating
  80  * \li GSStation::GetCargoWaitingFrom
  81  * \li GSStation::GetCargoWaitingVia
  82  * \li GSStoryPage
  83  * \li GSStoryPageList
  84  * \li GSStoryPageElementList
  85  * \li GSTile::GetTerrainType
  86  * \li GSTown::FoundTown
  87  * \li GSTown::GetFundBuildingsDuration
  88  * \li GSTown::SetName
  89  * \li GSTown::TOWN_GROWTH_NONE
  90  * \li GSTown::TOWN_GROWTH_NORMAL
  91  *
  92  * Other changes:
  93  * \li GSGoal::New can now create up to 64000 concurrent goals. The old limit was 256 goals.
  94  * \li GSStation::GetCargoRating does return -1 for cargo-station combinations that
  95  *     do not have a rating yet instead of returning 69.
  96  *
  97  * \b 1.3.3 - 1.3.2
  98  *
  99  * No changes
 100  *
 101  * \b 1.3.1
 102  *
 103  * API additions:
 104  * \li GSTile::GetTerrainType
 105  *
 106  * \b 1.3.0
 107  *
 108  * API additions:
 109  * \li GSCargoMonitor
 110  * \li GSEngine::IsValidEngine and GSEngine::IsBuildable when outside GSCompanyMode scope
 111  * \li GSEventExclusiveTransportRights
 112  * \li GSEventRoadReconstruction
 113  * \li GSNews::NT_ACCIDENT, GSNews::NT_COMPANY_INFO, GSNews::NT_ADVICE, GSNews::NT_ACCEPTANCE
 114  * \li GSIndustryType::IsProcessingIndustry
 115  * \li GSStation::IsAirportClosed
 116  * \li GSStation::OpenCloseAirport
 117  * \li GSController::Break
 118  * \li GSIndustryType::BuildIndustry, GSIndustryType::CanBuildIndustry, GSIndustryType::ProspectIndustry and GSIndustryType::CanProspectIndustry when outside GSCompanyMode scope
 119  *
 120  * Other changes:
 121  * \li Company specific goals are now removed when a company goes bankrupt or is taken over.
 122  *
 123  * \b 1.2.3 - 1.2.1
 124  *
 125  * No changes
 126  *
 127  * \b 1.2.0
 128  * \li First stable release with the NoGo framework.
 129  */