summaryrefslogtreecommitdiff
path: root/src/ai/api/ai_subsidy.hpp
diff options
context:
space:
mode:
authorsmatz <smatz@openttd.org>2009-08-08 16:42:55 +0000
committersmatz <smatz@openttd.org>2009-08-08 16:42:55 +0000
commit2a430d981f680485b9d4f9e5fab8bc642952b9bf (patch)
treee37f617ae610677d7c92aad77b5f184545599102 /src/ai/api/ai_subsidy.hpp
parenteff8cb839072c3aa80d1e54b189810061160669a (diff)
downloadopenttd-2a430d981f680485b9d4f9e5fab8bc642952b9bf.tar.xz
(svn r17113) -Change [FS#265][FS#2094][FS#2589]: apply the subsidy when subsidy's destination is in station's catchment area and cargo packets originate from subsidy's source
-Change [FS#1134]: subsidies aren't bound to stations after awarding anymore, they still apply to town or industry, no matter what station is used for loading and unloading. Awarded subsidies from older savegames are lost -Change [NoAI]: due to these changes, AISubsidy::GetSource and AISubsidy::GetDestination now return STATION_INVALID for awarded subsidies
Diffstat (limited to 'src/ai/api/ai_subsidy.hpp')
-rw-r--r--src/ai/api/ai_subsidy.hpp16
1 files changed, 8 insertions, 8 deletions
diff --git a/src/ai/api/ai_subsidy.hpp b/src/ai/api/ai_subsidy.hpp
index 7be86b0e8..96ad92c31 100644
--- a/src/ai/api/ai_subsidy.hpp
+++ b/src/ai/api/ai_subsidy.hpp
@@ -69,12 +69,12 @@ public:
/**
* Return the source TownID/IndustryID/StationID the subsidy is for.
- * 1) IsAwarded(subsidy_id) -> return the StationID the subsidy is awarded to.
- * 2) !IsAwarded(subsidy_id) && SourceIsTown(subsidy_id) -> return the TownID.
- * 3) !IsAwarded(subsidy_id) && !SourceIsTown(subsidy_id) -> return the IndustryID.
+ * \li IsAwarded(subsidy_id) -> return INVALID_STATION.
+ * \li !IsAwarded(subsidy_id) && SourceIsTown(subsidy_id) -> return the TownID.
+ * \li !IsAwarded(subsidy_id) && !SourceIsTown(subsidy_id) -> return the IndustryID.
* @param subsidy_id The SubsidyID to check.
* @pre IsValidSubsidy(subsidy_id).
- * @return One of TownID/IndustryID/StationID.
+ * @return One of TownID/IndustryID/INVALID_STATION.
*/
static int32 GetSource(SubsidyID subsidy_id);
@@ -88,12 +88,12 @@ public:
/**
* Return the destination TownID/IndustryID/StationID the subsidy is for.
- * 1) IsAwarded(subsidy_id) -> return the StationID the subsidy is awarded to.
- * 2) !IsAwarded(subsidy_id) && SourceIsTown(subsidy_id) -> return the TownID.
- * 3) !IsAwarded(subsidy_id) && !SourceIsTown(subsidy_id) -> return the IndustryID.
+ * \li IsAwarded(subsidy_id) -> return INVALID_STATION.
+ * \li !IsAwarded(subsidy_id) && DestinationIsTown(subsidy_id) -> return the TownID.
+ * \li !IsAwarded(subsidy_id) && !DestinationIsTown(subsidy_id) -> return the IndustryID.
* @param subsidy_id the SubsidyID to check.
* @pre IsValidSubsidy(subsidy_id).
- * @return One of TownID/IndustryID/StationID.
+ * @return One of TownID/IndustryID/INVALID_STATION.
*/
static int32 GetDestination(SubsidyID subsidy_id);
};