You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
OpenTTD-patches/src/script/api/game_changelog.hpp

196 lines
5.8 KiB
C++

/*
* This file is part of OpenTTD.
* 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.
* 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.
* 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/>.
*/
/**
* @file game_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. Note that removed API
* functions may still be available if you return an older API version
* in GetAPIVersion() in info.nut.
*
* \b 12.0
*
* This version is not yet released. The following changes are not set in stone yet.
*
* API additions:
* \li GSNewGRF
* \li GSNewGRFList
*
* \b 1.11.0
*
* API additions:
* \li GSCargo::GetName
* \li GSEventStoryPageButtonClick
* \li GSEventStoryPageTileSelect
* \li GSEventStoryPageVehicleSelect
* \li GSIndustry::GetCargoLastAcceptedDate
* \li GSIndustry::GetControlFlags
* \li GSIndustry::GetExclusiveConsumer
* \li GSIndustry::GetExclusiveSupplier
* \li GSIndustry::GetLastProductionYear
* \li GSIndustry::SetControlFlags
* \li GSIndustry::SetExclusiveConsumer
* \li GSIndustry::SetExclusiveSupplier
* \li GSIndustry::SetText
* \li GSStoryPage::MakePushButtonReference
* \li GSStoryPage::MakeTileButtonReference
* \li GSStoryPage::MakeVehicleButtonReference
* \li GSPriorityQueue
*
* Other changes:
* \li GSCompany::ChangeBankBalance takes one extra parameter to refer to a location to show text effect on
* \li GSGoal::Question and GSGoal::QuestionClient no longer require to have any buttons except for the window type GSGoal.QT_QUESTION
*
* \b 1.10.0
*
* API additions:
* \li GSVehicle::BuildVehicleWithRefit
* \li GSVehicle::GetBuildWithRefitCapacity
* \li GSRoad::GetName
* \li GSRoad::RoadVehCanRunOnRoad
* \li GSRoad::RoadVehHasPowerOnRoad
* \li GSRoad::ConvertRoadType
* \li GSRoad::GetMaxSpeed
* \li GSEngine::EnableForCompany
* \li GSEngine::DisableForCompany
*
* \b 1.9.0
*
* API additions:
* \li GSAirport::GetMonthlyMaintenanceCost
* \li GSClient
* \li GSClientList
* \li GSClientList_Company
* \li GSViewport::ScrollEveryoneTo
* \li GSViewport::ScrollCompanyClientsTo
* \li GSViewport::ScrollClientTo
* \li GSGoal::QuestionClient
*
* Other changes:
* \li GSBridge::GetName takes one extra parameter to refer the vehicle type
*
* \b 1.8.0
*
* No changes
*
* API additions:
* \li GSRoad::ERR_ROADTYPE_DISALLOWS_CROSSING
*
* \b 1.7.0 - 1.7.2
*
* No changes
*
* \b 1.6.1 - 1.6.0
*
* No changes
*
* \b 1.5.3 - 1.5.1
*
* No changes
*
* \b 1.5.0
*
* API additions:
* \li GSList::SwapList
* \li GSStation::GetCargoPlanned
* \li GSStation::GetCargoPlannedFrom
* \li GSStation::GetCargoPlannedFromVia
* \li GSStation::GetCargoPlannedVia
* \li GSStation::GetCargoWaitingFromVia
* \li GSStationList_CargoPlannedByFrom
* \li GSStationList_CargoPlannedByVia
* \li GSStationList_CargoPlannedFromByVia
* \li GSStationList_CargoPlannedViaByFrom
* \li GSStationList_CargoWaitingByFrom
* \li GSStationList_CargoWaitingByVia
* \li GSStationList_CargoWaitingFromByVia
* \li GSStationList_CargoWaitingViaByFrom
*
* Other changes:
* \li GSNews::Create takes two extra parameters to refer to a location, station,
* industry, or town. The user can click at the news message to jump to the
* referred location.
*
* \b 1.4.4 - 1.4.3
*
* No changes
*
* \b 1.4.2
*
* Other changes:
* \li GSCargoMonitor delivery and pickup monitor functions have improved boundary checking for
* their parameters, and return \c -1 if they are found out of bounds.
*
* \b 1.4.1
*
* No changes
*
* \b 1.4.0
*
* API additions:
* \li AICargo::GetDistributionType
* \li GSCompany::ChangeBankBalance
* \li GSDate::DATE_INVALID
* \li GSDate::IsValidDate
* \li GSGoal::GT_STORY_PAGE
* \li GSGoal::IsCompleted
* \li GSGoal::SetCompleted
* \li GSGoal::SetProgress
* \li GSGoal::SetText
* \li GSStation::HasCargoRating
* \li GSStation::GetCargoWaitingFrom
* \li GSStation::GetCargoWaitingVia
* \li GSStoryPage
* \li GSStoryPageList
* \li GSStoryPageElementList
* \li GSTile::GetTerrainType
* \li GSTown::FoundTown
* \li GSTown::GetFundBuildingsDuration
* \li GSTown::SetName
* \li GSTown::TOWN_GROWTH_NONE
* \li GSTown::TOWN_GROWTH_NORMAL
*
* Other changes:
* \li GSGoal::New can now create up to 64000 concurrent goals. The old limit was 256 goals.
* \li GSStation::GetCargoRating does return -1 for cargo-station combinations that
* do not have a rating yet instead of returning 69.
*
* \b 1.3.3 - 1.3.2
*
* No changes
*
* \b 1.3.1
*
* API additions:
* \li GSTile::GetTerrainType
*
* \b 1.3.0
*
* API additions:
* \li GSCargoMonitor
* \li GSEngine::IsValidEngine and GSEngine::IsBuildable when outside GSCompanyMode scope
* \li GSEventExclusiveTransportRights
* \li GSEventRoadReconstruction
* \li GSNews::NT_ACCIDENT, GSNews::NT_COMPANY_INFO, GSNews::NT_ADVICE, GSNews::NT_ACCEPTANCE
* \li GSIndustryType::IsProcessingIndustry
* \li GSStation::IsAirportClosed
* \li GSStation::OpenCloseAirport
* \li GSController::Break
* \li GSIndustryType::BuildIndustry, GSIndustryType::CanBuildIndustry, GSIndustryType::ProspectIndustry and GSIndustryType::CanProspectIndustry when outside GSCompanyMode scope
*
* Other changes:
* \li Company specific goals are now removed when a company goes bankrupt or is taken over.
*
* \b 1.2.3 - 1.2.1
*
* No changes
*
* \b 1.2.0
* \li First stable release with the NoGo framework.
*/