Add: [Script] GSIndustry.GetConstructionDate() method (#11145)

OpenTTD · Jul 20, 2023 · ce9305a · ce9305a
1 parent 0be2777
commit ce9305a
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 0 deletions.
diff --git a/src/script/api/game_changelog.hpp b/src/script/api/game_changelog.hpp
@@ -18,6 +18,7 @@
  * This version is not yet released. The following changes are not set in stone yet.
  *
  * API additions:
+ * \li GSIndustry::GetConstructionDate
  * \li GSAsyncMode
  * \li GSCompanyMode::IsValid
  * \li GSCompanyMode::IsDeity

diff --git a/src/script/api/script_industry.cpp b/src/script/api/script_industry.cpp
@@ -49,6 +49,13 @@
 	return GetString(STR_INDUSTRY_NAME);
 }
 
+/* static */ ScriptDate::Date ScriptIndustry::GetConstructionDate(IndustryID industry_id)
+{
+	Industry *i = Industry::GetIfValid(industry_id);
+	if (i == nullptr) return ScriptDate::DATE_INVALID;
+	return (ScriptDate::Date)i->construction_date;
+}
+
 /* static */ bool ScriptIndustry::SetText(IndustryID industry_id, Text *text)
 {
 	CCountedPtr<Text> counter(text);

diff --git a/src/script/api/script_industry.hpp b/src/script/api/script_industry.hpp
@@ -81,6 +81,15 @@ class ScriptIndustry : public ScriptObject {
 	 */
 	static std::optional<std::string> GetName(IndustryID industry_id);
 
+	/**
+	 * Get the construction date of an industry.
+	 * @param industry_id The index of the industry.
+	 * @pre IsValidIndustry(industry_id).
+	 * @return Date the industry was constructed.
+	 * @api -ai
+	 */
+	static ScriptDate::Date GetConstructionDate(IndustryID industry_id);
+
 	/**
 	 * Set the custom text of an industry, shown in the GUI.
 	 * @param industry_id The industry to set the custom text of.