diff options
Diffstat (limited to 'src/ai/api/ai_industry.hpp')
| -rw-r--r-- | src/ai/api/ai_industry.hpp | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/src/ai/api/ai_industry.hpp b/src/ai/api/ai_industry.hpp index ed44cada5..501b06087 100644 --- a/src/ai/api/ai_industry.hpp +++ b/src/ai/api/ai_industry.hpp @@ -47,6 +47,10 @@ public: /** * Gets the production of a cargo of the industry. + * WARNING This function does not neccessarily return useful values for newindustries. + * An industry produces at least the returned amount per month, + * but the function can also return 0, when the industry produces lots of cargo. + * GetLastMonthProduction() is more robust. * @param industry_id The index of the industry. * @param cargo_id The index of the cargo. * @pre IsValidIndustry(industry_id). @@ -62,7 +66,7 @@ public: * @param cargo_id The index of the cargo. * @pre IsValidIndustry(industry_id). * @pre AICargo::IsValidCargo(cargo_id). - * @return The production of the cargo for this industry. + * @return True if and only if the industry accepts the cargo. */ static bool IsCargoAccepted(IndustryID industry_id, CargoID cargo_id); |