cpp/openttd-patchpack/source Changeset - r26800:bc2df8c09f6b

Changeset - r26800:bc2df8c09f6b

Parent rev.

Child rev.

[Not reviewed]

master

0 1 0

Rubidium - 17 months ago 2023-01-25 20:40:38
rubidium@openttd.org

Fix: scripts cannot call constructors of ScriptEvents, so remove from the documentation

1 file changed with 67 insertions and 3 deletions:

src/script/api/script_event_types.hpp

0 comments (0 inline, 0 general)

src/script/api/script_event_types.hpp

➞

Show inline comments

@@ @@ -24,35 +24,37 @@ public: @@
 	/**
 	 * The reasons for vehicle crashes
 	 */
 	enum CrashReason {
 		CRASH_TRAIN,                ///< Two trains collided
 		CRASH_RV_LEVEL_CROSSING,    ///< Road vehicle got under a train
 		CRASH_RV_UFO,               ///< Road vehicle got under a landing ufo
 		CRASH_PLANE_LANDING,        ///< Plane crashed on landing
 		CRASH_AIRCRAFT_NO_AIRPORT,  ///< Aircraft crashed after it found not a single airport for landing
 		CRASH_FLOODED,              ///< Vehicle was flooded
 	};
 #ifndef DOXYGEN_API
 	/**
 	 * @param vehicle The vehicle that crashed.
 	 * @param crash_site Where the vehicle crashed.
 	 * @param crash_reason The reason why the vehicle crashed.
 	 */
 	ScriptEventVehicleCrashed(VehicleID vehicle, TileIndex crash_site, CrashReason crash_reason) :
 		ScriptEvent(ET_VEHICLE_CRASHED),
 		crash_site(crash_site),
 		vehicle(vehicle),
 		crash_reason(crash_reason)
 	{}
 #endif /* DOXYGEN_API */
 	/**
 	 * Convert an ScriptEvent to the real instance.
 	 * @param instance The instance to convert.
 	 * @return The converted instance.
 	 */
 	static ScriptEventVehicleCrashed *Convert(ScriptEvent *instance) { return (ScriptEventVehicleCrashed *)instance; }
 	/**
 	 * Get the VehicleID of the crashed vehicle.
 	 * @return The crashed vehicle.
 	 */
@@ @@ -73,124 +75,132 @@ public: @@
 private:
 	TileIndex crash_site;     ///< The location of the crash.
 	VehicleID vehicle;        ///< The crashed vehicle.
 	CrashReason crash_reason; ///< The reason for crashing.
 };
 /**
  * Event Subsidy Offered, indicating someone offered a subsidy.
  * @api ai game
  */
 class ScriptEventSubsidyOffer : public ScriptEvent {
 public:
 #ifndef DOXYGEN_API
 	/**
 	 * @param subsidy_id The index of this subsidy in the _subsidies array.
 	 */
 	ScriptEventSubsidyOffer(SubsidyID subsidy_id) :
 		ScriptEvent(ET_SUBSIDY_OFFER),
 		subsidy_id(subsidy_id)
 	{}
 #endif /* DOXYGEN_API */
 	/**
 	 * Convert an ScriptEvent to the real instance.
 	 * @param instance The instance to convert.
 	 * @return The converted instance.
 	 */
 	static ScriptEventSubsidyOffer *Convert(ScriptEvent *instance) { return (ScriptEventSubsidyOffer *)instance; }
 	/**
 	 * Get the SubsidyID of the subsidy.
 	 * @return The subsidy id.
 	 */
 	SubsidyID GetSubsidyID() { return this->subsidy_id; }
 private:
 	SubsidyID subsidy_id; ///< The subsidy that got offered.
 };
 /**
  * Event Subsidy Offer Expired, indicating a subsidy will no longer be awarded.
  * @api ai game
  */
 class ScriptEventSubsidyOfferExpired : public ScriptEvent {
 public:
 #ifndef DOXYGEN_API
 	/**
 	 * @param subsidy_id The index of this subsidy in the _subsidies array.
 	 */
 	ScriptEventSubsidyOfferExpired(SubsidyID subsidy_id) :
 		ScriptEvent(ET_SUBSIDY_OFFER_EXPIRED),
 		subsidy_id(subsidy_id)
 	{}
 #endif /* DOXYGEN_API */
 	/**
 	 * Convert an ScriptEvent to the real instance.
 	 * @param instance The instance to convert.
 	 * @return The converted instance.
 	 */
 	static ScriptEventSubsidyOfferExpired *Convert(ScriptEvent *instance) { return (ScriptEventSubsidyOfferExpired *)instance; }
 	/**
 	 * Get the SubsidyID of the subsidy.
 	 * @return The subsidy id.
 	 */
 	SubsidyID GetSubsidyID() { return this->subsidy_id; }
 private:
 	SubsidyID subsidy_id; ///< The subsidy offer that expired.
 };
 /**
  * Event Subsidy Awarded, indicating a subsidy is awarded to some company.
  * @api ai game
  */
 class ScriptEventSubsidyAwarded : public ScriptEvent {
 public:
 #ifndef DOXYGEN_API
 	/**
 	 * @param subsidy_id The index of this subsidy in the _subsidies array.
 	 */
 	ScriptEventSubsidyAwarded(SubsidyID subsidy_id) :
 		ScriptEvent(ET_SUBSIDY_AWARDED),
 		subsidy_id(subsidy_id)
 	{}
 #endif /* DOXYGEN_API */
 	/**
 	 * Convert an ScriptEvent to the real instance.
 	 * @param instance The instance to convert.
 	 * @return The converted instance.
 	 */
 	static ScriptEventSubsidyAwarded *Convert(ScriptEvent *instance) { return (ScriptEventSubsidyAwarded *)instance; }
 	/**
 	 * Get the SubsidyID of the subsidy.
 	 * @return The subsidy id.
 	 */
 	SubsidyID GetSubsidyID() { return this->subsidy_id; }
 private:
 	SubsidyID subsidy_id; ///< The subsidy that was awarded.
 };
 /**
  * Event Subsidy Expired, indicating a route that was once subsidized no longer is.
  * @api ai game
  */
 class ScriptEventSubsidyExpired : public ScriptEvent {
 public:
 #ifndef DOXYGEN_API
 	/**
 	 * @param subsidy_id The index of this subsidy in the _subsidies array.
 	 */
 	ScriptEventSubsidyExpired(SubsidyID subsidy_id) :
 		ScriptEvent(ET_SUBSIDY_EXPIRED),
 		subsidy_id(subsidy_id)
 	{}
 #endif /* DOXYGEN_API */
 	/**
 	 * Convert an ScriptEvent to the real instance.
 	 * @param instance The instance to convert.
 	 * @return The converted instance.
 	 */
 	static ScriptEventSubsidyExpired *Convert(ScriptEvent *instance) { return (ScriptEventSubsidyExpired *)instance; }
 	/**
 	 * Get the SubsidyID of the subsidy.
 	 * @return The subsidy id.
 	 */
@@ @@ -199,31 +209,33 @@ public: @@
 private:
 	SubsidyID subsidy_id; ///< The subsidy that expired.
 };
 /**
  * Event Engine Preview, indicating a manufacturer offer you to test a new engine.
  *  You can get the same information about the offered engine as a real user
  *  would see in the offer window. And you can also accept the offer.
  * @api ai
  */
 class ScriptEventEnginePreview : public ScriptEvent {
 public:
 #ifndef DOXYGEN_API
 	/**
 	 * @param engine The engine offered to test.
 	 */
 	ScriptEventEnginePreview(EngineID engine) :
 		ScriptEvent(ET_ENGINE_PREVIEW),
 		engine(engine)
 	{}
 #endif /* DOXYGEN_API */
 	/**
 	 * Convert an ScriptEvent to the real instance.
 	 * @param instance The instance to convert.
 	 * @return The converted instance.
 	 */
 	static ScriptEventEnginePreview *Convert(ScriptEvent *instance) { return (ScriptEventEnginePreview *)instance; }
 	/**
 	 * Get the name of the offered engine.
 	 * @return The name the engine has.
 	 */
@@ @@ -288,31 +300,33 @@ private: @@
 	 * Check whether the engine from this preview is still valid.
 	 * @return True iff the engine is still valid.
 	 */
 	bool IsEngineValid() const;
 };
 /**
  * Event Company New, indicating a new company has been created.
  * @api ai game
  */
 class ScriptEventCompanyNew : public ScriptEvent {
 public:
 #ifndef DOXYGEN_API
 	/**
 	 * @param owner The new company.
 	 */
 	ScriptEventCompanyNew(Owner owner) :
 		ScriptEvent(ET_COMPANY_NEW),
 		owner((ScriptCompany::CompanyID)owner)
 	{}
 #endif /* DOXYGEN_API */
 	/**
 	 * Convert an ScriptEvent to the real instance.
 	 * @param instance The instance to convert.
 	 * @return The converted instance.
 	 */
 	static ScriptEventCompanyNew *Convert(ScriptEvent *instance) { return (ScriptEventCompanyNew *)instance; }
 	/**
 	 * Get the CompanyID of the company that has been created.
 	 * @return The CompanyID of the company.
 	 */
@@ @@ -320,64 +334,68 @@ public: @@
 private:
 	ScriptCompany::CompanyID owner; ///< The new company.
 };
 /**
  * Event Company In Trouble, indicating a company is in trouble and might go
  *  bankrupt soon.
  * @api ai game
  */
 class ScriptEventCompanyInTrouble : public ScriptEvent {
 public:
 #ifndef DOXYGEN_API
 	/**
 	 * @param owner The company that is in trouble.
 	 */
 	ScriptEventCompanyInTrouble(Owner owner) :
 		ScriptEvent(ET_COMPANY_IN_TROUBLE),
 		owner((ScriptCompany::CompanyID)owner)
 	{}
 #endif /* DOXYGEN_API */
 	/**
 	 * Convert an ScriptEvent to the real instance.
 	 * @param instance The instance to convert.
 	 * @return The converted instance.
 	 */
 	static ScriptEventCompanyInTrouble *Convert(ScriptEvent *instance) { return (ScriptEventCompanyInTrouble *)instance; }
 	/**
 	 * Get the CompanyID of the company that is in trouble.
 	 * @return The CompanyID of the company in trouble.
 	 */
 	ScriptCompany::CompanyID GetCompanyID() { return this->owner; }
 private:
 	ScriptCompany::CompanyID owner; ///< The company that is in trouble.
 };
 /**
  * Event Company Ask Merger, indicating a company can be bought (cheaply) by you.
  * @api ai
  */
 class ScriptEventCompanyAskMerger : public ScriptEvent {
 public:
 #ifndef DOXYGEN_API
 	/**
 	 * @param owner The company that can be bought.
 	 * @param value The value/costs of buying the company.
 	 */
 	ScriptEventCompanyAskMerger(Owner owner, int32 value) :
 		ScriptEvent(ET_COMPANY_ASK_MERGER),
 		owner((ScriptCompany::CompanyID)owner),
 		value(value)
 	{}
 #endif /* DOXYGEN_API */
 	/**
 	 * Convert an ScriptEvent to the real instance.
 	 * @param instance The instance to convert.
 	 * @return The converted instance.
 	 */
 	static ScriptEventCompanyAskMerger *Convert(ScriptEvent *instance) { return (ScriptEventCompanyAskMerger *)instance; }
 	/**
 	 * Get the CompanyID of the company that can be bought.
 	 * @return The CompanyID of the company that can be bought.
 	 * @note If the company is bought this will become invalid.
@@ @@ -399,33 +417,35 @@ public: @@
 private:
 	ScriptCompany::CompanyID owner; ///< The company that is in trouble.
 	int32 value;                ///< The value of the company, i.e. the amount you would pay.
 };
 /**
  * Event Company Merger, indicating a company has been bought by another
  *  company.
  * @api ai game
  */
 class ScriptEventCompanyMerger : public ScriptEvent {
 public:
 #ifndef DOXYGEN_API
 	/**
 	 * @param old_owner The company bought off.
 	 * @param new_owner The company that bought owner.
 	 */
 	ScriptEventCompanyMerger(Owner old_owner, Owner new_owner) :
 		ScriptEvent(ET_COMPANY_MERGER),
 		old_owner((ScriptCompany::CompanyID)old_owner),
 		new_owner((ScriptCompany::CompanyID)new_owner)
 	{}
 #endif /* DOXYGEN_API */
 	/**
 	 * Convert an ScriptEvent to the real instance.
 	 * @param instance The instance to convert.
 	 * @return The converted instance.
 	 */
 	static ScriptEventCompanyMerger *Convert(ScriptEvent *instance) { return (ScriptEventCompanyMerger *)instance; }
 	/**
 	 * Get the CompanyID of the company that has been bought.
 	 * @return The CompanyID of the company that has been bought.
 	 * @note: The value below is not valid anymore as CompanyID, and
@@ @@ -442,250 +462,266 @@ public: @@
 private:
 	ScriptCompany::CompanyID old_owner; ///< The company that ended to exist.
 	ScriptCompany::CompanyID new_owner; ///< The company that's the end result of the merger.
 };
 /**
  * Event Company Bankrupt, indicating a company has gone bankrupt.
  * @api ai game
  */
 class ScriptEventCompanyBankrupt : public ScriptEvent {
 public:
 #ifndef DOXYGEN_API
 	/**
 	 * @param owner The company that has gone bankrupt.
 	 */
 	ScriptEventCompanyBankrupt(Owner owner) :
 		ScriptEvent(ET_COMPANY_BANKRUPT),
 		owner((ScriptCompany::CompanyID)owner)
 	{}
 #endif /* DOXYGEN_API */
 	/**
 	 * Convert an ScriptEvent to the real instance.
 	 * @param instance The instance to convert.
 	 * @return The converted instance.
 	 */
 	static ScriptEventCompanyBankrupt *Convert(ScriptEvent *instance) { return (ScriptEventCompanyBankrupt *)instance; }
 	/**
 	 * Get the CompanyID of the company that has gone bankrupt.
 	 * @return The CompanyID of the company that has gone bankrupt.
 	 */
 	ScriptCompany::CompanyID GetCompanyID() { return this->owner; }
 private:
 	ScriptCompany::CompanyID owner; ///< The company that has gone bankrupt.
 };
 /**
  * Event Vehicle Lost, indicating a vehicle can't find its way to its destination.
  * @api ai
  */
 class ScriptEventVehicleLost : public ScriptEvent {
 public:
 #ifndef DOXYGEN_API
 	/**
 	 * @param vehicle_id The vehicle that is lost.
 	 */
 	ScriptEventVehicleLost(VehicleID vehicle_id) :
 		ScriptEvent(ET_VEHICLE_LOST),
 		vehicle_id(vehicle_id)
 	{}
 #endif /* DOXYGEN_API */
 	/**
 	 * Convert an ScriptEvent to the real instance.
 	 * @param instance The instance to convert.
 	 * @return The converted instance.
 	 */
 	static ScriptEventVehicleLost *Convert(ScriptEvent *instance) { return (ScriptEventVehicleLost *)instance; }
 	/**
 	 * Get the VehicleID of the vehicle that is lost.
 	 * @return The VehicleID of the vehicle that is lost.
 	 */
 	VehicleID GetVehicleID() { return this->vehicle_id; }
 private:
 	VehicleID vehicle_id; ///< The vehicle that is lost.
 };
 /**
  * Event VehicleWaitingInDepot, indicating a vehicle has arrived a depot and is now waiting there.
  * @api ai
  */
 class ScriptEventVehicleWaitingInDepot : public ScriptEvent {
 public:
 #ifndef DOXYGEN_API
 	/**
 	 * @param vehicle_id The vehicle that is waiting in a depot.
 	 */
 	ScriptEventVehicleWaitingInDepot(VehicleID vehicle_id) :
 		ScriptEvent(ET_VEHICLE_WAITING_IN_DEPOT),
 		vehicle_id(vehicle_id)
 	{}
 #endif /* DOXYGEN_API */
 	/**
 	 * Convert an ScriptEvent to the real instance.
 	 * @param instance The instance to convert.
 	 * @return The converted instance.
 	 */
 	static ScriptEventVehicleWaitingInDepot *Convert(ScriptEvent *instance) { return (ScriptEventVehicleWaitingInDepot *)instance; }
 	/**
 	 * Get the VehicleID of the vehicle that is waiting in a depot.
 	 * @return The VehicleID of the vehicle that is waiting in a depot.
 	 */
 	VehicleID GetVehicleID() { return this->vehicle_id; }
 private:
 	VehicleID vehicle_id; ///< The vehicle that is waiting in the depot.
 };
 /**
  * Event Vehicle Unprofitable, indicating a vehicle lost money last year.
  * @api ai
  */
 class ScriptEventVehicleUnprofitable : public ScriptEvent {
 public:
 #ifndef DOXYGEN_API
 	/**
 	 * @param vehicle_id The vehicle that was unprofitable.
 	 */
 	ScriptEventVehicleUnprofitable(VehicleID vehicle_id) :
 		ScriptEvent(ET_VEHICLE_UNPROFITABLE),
 		vehicle_id(vehicle_id)
 	{}
 #endif /* DOXYGEN_API */
 	/**
 	 * Convert an ScriptEvent to the real instance.
 	 * @param instance The instance to convert.
 	 * @return The converted instance.
 	 */
 	static ScriptEventVehicleUnprofitable *Convert(ScriptEvent *instance) { return (ScriptEventVehicleUnprofitable *)instance; }
 	/**
 	 * Get the VehicleID of the vehicle that lost money.
 	 * @return The VehicleID of the vehicle that lost money.
 	 */
 	VehicleID GetVehicleID() { return this->vehicle_id; }
 private:
 	VehicleID vehicle_id; ///< The vehicle that is unprofitable.
 };
 /**
  * Event Industry Open, indicating a new industry has been created.
  * @api ai game
  */
 class ScriptEventIndustryOpen : public ScriptEvent {
 public:
 #ifndef DOXYGEN_API
 	/**
 	 * @param industry_id The new industry.
 	 */
 	ScriptEventIndustryOpen(IndustryID industry_id) :
 		ScriptEvent(ET_INDUSTRY_OPEN),
 		industry_id(industry_id)
 	{}
 #endif /* DOXYGEN_API */
 	/**
 	 * Convert an ScriptEvent to the real instance.
 	 * @param instance The instance to convert.
 	 * @return The converted instance.
 	 */
 	static ScriptEventIndustryOpen *Convert(ScriptEvent *instance) { return (ScriptEventIndustryOpen *)instance; }
 	/**
 	 * Get the IndustryID of the new industry.
 	 * @return The IndustryID of the industry.
 	 */
 	IndustryID GetIndustryID() { return this->industry_id; }
 private:
 	IndustryID industry_id; ///< The industry that opened.
 };
 /**
  * Event Industry Close, indicating an industry is going to be closed.
  * @api ai game
  */
 class ScriptEventIndustryClose : public ScriptEvent {
 public:
 #ifndef DOXYGEN_API
 	/**
 	 * @param industry_id The new industry.
 	 */
 	ScriptEventIndustryClose(IndustryID industry_id) :
 		ScriptEvent(ET_INDUSTRY_CLOSE),
 		industry_id(industry_id)
 	{}
 #endif /* DOXYGEN_API */
 	/**
 	 * Convert an ScriptEvent to the real instance.
 	 * @param instance The instance to convert.
 	 * @return The converted instance.
 	 */
 	static ScriptEventIndustryClose *Convert(ScriptEvent *instance) { return (ScriptEventIndustryClose *)instance; }
 	/**
 	 * Get the IndustryID of the closing industry.
 	 * @return The IndustryID of the industry.
 	 */
 	IndustryID GetIndustryID() { return this->industry_id; }
 private:
 	IndustryID industry_id; ///< The industry that closed.
 };
 /**
  * Event Engine Available, indicating a new engine is available.
  * @api ai
  */
 class ScriptEventEngineAvailable : public ScriptEvent {
 public:
 #ifndef DOXYGEN_API
 	/**
 	 * @param engine The engine that is available.
 	 */
 	ScriptEventEngineAvailable(EngineID engine) :
 		ScriptEvent(ET_ENGINE_AVAILABLE),
 		engine(engine)
 	{}
 #endif /* DOXYGEN_API */
 	/**
 	 * Convert an ScriptEvent to the real instance.
 	 * @param instance The instance to convert.
 	 * @return The converted instance.
 	 */
 	static ScriptEventEngineAvailable *Convert(ScriptEvent *instance) { return (ScriptEventEngineAvailable *)instance; }
 	/**
 	 * Get the EngineID of the new engine.
 	 * @return The EngineID of the new engine.
 	 */
 	EngineID GetEngineID() { return this->engine; }
 private:
 	EngineID engine; ///< The engine that became available.
 };
 /**
  * Event Station First Vehicle, indicating a station has been visited by a vehicle for the first time.
  * @api ai game
  */
 class ScriptEventStationFirstVehicle : public ScriptEvent {
 public:
 #ifndef DOXYGEN_API
 	/**
 	 * @param station The station visited for the first time.
 	 * @param vehicle The vehicle visiting the station.
 	 */
 	ScriptEventStationFirstVehicle(StationID station, VehicleID vehicle) :
 		ScriptEvent(ET_STATION_FIRST_VEHICLE),
 		station(station),
 		vehicle(vehicle)
 	{}
 #endif /* DOXYGEN_API */
 	/**
 	 * Convert an ScriptEvent to the real instance.
 	 * @param instance The instance to convert.
 	 * @return The converted instance.
 	 */
 	static ScriptEventStationFirstVehicle *Convert(ScriptEvent *instance) { return (ScriptEventStationFirstVehicle *)instance; }
 	/**
 	 * Get the StationID of the visited station.
 	 * @return The StationID of the visited station.
 	 */
@@ @@ -699,93 +735,99 @@ public: @@
 private:
 	StationID station; ///< The station the vehicle arrived at.
 	VehicleID vehicle; ///< The vehicle that arrived at the station.
 };
 /**
  * Event Disaster Zeppeliner Crashed, indicating a zeppeliner has crashed on an airport and is blocking the runway.
  * @api ai
  */
 class ScriptEventDisasterZeppelinerCrashed : public ScriptEvent {
 public:
 #ifndef DOXYGEN_API
 	/**
 	 * @param station The station containing the affected airport
 	 */
 	ScriptEventDisasterZeppelinerCrashed(StationID station) :
 		ScriptEvent(ET_DISASTER_ZEPPELINER_CRASHED),
 		station(station)
 	{}
 #endif /* DOXYGEN_API */
 	/**
 	 * Convert an ScriptEvent to the real instance.
 	 * @param instance The instance to convert.
 	 * @return The converted instance.
 	 */
 	static ScriptEventDisasterZeppelinerCrashed *Convert(ScriptEvent *instance) { return (ScriptEventDisasterZeppelinerCrashed *)instance; }
 	/**
 	 * Get the StationID of the station containing the affected airport.
 	 * @return The StationID of the station containing the affected airport.
 	 */
 	StationID GetStationID() { return this->station; }
 private:
 	StationID station; ///< The station the zeppeliner crashed.
 };
 /**
  * Event Disaster Zeppeliner Cleared, indicating a previously crashed zeppeliner has been removed, and the airport is operating again.
  * @api ai
  */
 class ScriptEventDisasterZeppelinerCleared : public ScriptEvent {
 public:
 #ifndef DOXYGEN_API
 	/**
 	 * @param station The station containing the affected airport
 	 */
 	ScriptEventDisasterZeppelinerCleared(StationID station) :
 		ScriptEvent(ET_DISASTER_ZEPPELINER_CLEARED),
 		station(station)
 	{}
 #endif /* DOXYGEN_API */
 	/**
 	 * Convert an ScriptEvent to the real instance.
 	 * @param instance The instance to convert.
 	 * @return The converted instance.
 	 */
 	static ScriptEventDisasterZeppelinerCleared *Convert(ScriptEvent *instance) { return (ScriptEventDisasterZeppelinerCleared *)instance; }
 	/**
 	 * Get the StationID of the station containing the affected airport.
 	 * @return The StationID of the station containing the affected airport.
 	 */
 	StationID GetStationID() { return this->station; }
 private:
 	StationID station; ///< The station the zeppeliner crashed.
 };
 /**
  * Event Town Founded, indicating a new town has been created.
  * @api ai game
  */
 class ScriptEventTownFounded : public ScriptEvent {
 public:
 #ifndef DOXYGEN_API
 	/**
 	 * @param town The town that was created.
 	 */
 	ScriptEventTownFounded(TownID town) :
 		ScriptEvent(ET_TOWN_FOUNDED),
 		town(town)
 	{}
 #endif /* DOXYGEN_API */
 	/**
 	 * Convert an ScriptEvent to the real instance.
 	 * @param instance The instance to convert.
 	 * @return The converted instance.
 	 */
 	static ScriptEventTownFounded *Convert(ScriptEvent *instance) { return (ScriptEventTownFounded *)instance; }
 	/**
 	 * Get the TownID of the town.
 	 * @return The TownID of the town that was created.
 	 */
@@ @@ -794,59 +836,63 @@ public: @@
 private:
 	TownID town; ///< The town that got founded.
 };
 /**
  * Event AircraftDestTooFar, indicating the next destination of an aircraft is too far away.
  * This event can be triggered when the current order of an aircraft changes, usually either when
  * loading is done or when switched manually.
  * @api ai
  */
 class ScriptEventAircraftDestTooFar : public ScriptEvent {
 public:
 #ifndef DOXYGEN_API
 	/**
 	 * @param vehicle_id The aircraft whose destination is too far away.
 	 */
 	ScriptEventAircraftDestTooFar(VehicleID vehicle_id) :
 		ScriptEvent(ET_AIRCRAFT_DEST_TOO_FAR),
 		vehicle_id(vehicle_id)
 	{}
 #endif /* DOXYGEN_API */
 	/**
 	 * Convert an ScriptEvent to the real instance.
 	 * @param instance The instance to convert.
 	 * @return The converted instance.
 	 */
 	static ScriptEventAircraftDestTooFar *Convert(ScriptEvent *instance) { return (ScriptEventAircraftDestTooFar *)instance; }
 	/**
 	 * Get the VehicleID of the aircraft whose destination is too far away.
 	 * @return The VehicleID of the aircraft whose destination is too far away.
 	 */
 	VehicleID GetVehicleID() { return this->vehicle_id; }
 private:
 	VehicleID vehicle_id; ///< The vehicle aircraft whose destination is too far away.
 };
 /**
  * Event Admin Port, indicating the admin port is sending you information.
  * @api game
  */
 class ScriptEventAdminPort : public ScriptEvent {
 public:
 #ifndef DOXYGEN_API
 	/**
 	 * @param json The JSON string which got sent.
 	 */
 	ScriptEventAdminPort(const std::string &json);
 #endif /* DOXYGEN_API */
 	/**
 	 * Convert an ScriptEvent to the real instance.
 	 * @param instance The instance to convert.
 	 * @return The converted instance.
 	 */
 	static ScriptEventAdminPort *Convert(ScriptEvent *instance) { return (ScriptEventAdminPort *)instance; }
 	/**
 	 * Get the information that was sent to you back as Squirrel object.
 	 */
 	SQInteger GetObject(HSQUIRRELVM vm);
@@ @@ -873,35 +919,37 @@ private: @@
 	 * @param vm The VM used.
 	 * @param p The (part of the) JSON string reading.
 	 */
 	const char *ReadString(HSQUIRRELVM vm, const char *p);
 };
 /**
  * Event Window Widget Click, when a user clicks on a highlighted widget.
  * @api game
  */
 class ScriptEventWindowWidgetClick : public ScriptEvent {
 public:
 #ifndef DOXYGEN_API
 	/**
 	 * @param window The windowclass that was clicked.
 	 * @param number The windownumber that was clicked.
 	 * @param widget The widget in the window that was clicked.
 	 */
 	ScriptEventWindowWidgetClick(ScriptWindow::WindowClass window, uint32 number, uint8 widget) :
 		ScriptEvent(ET_WINDOW_WIDGET_CLICK),
 		window(window),
 		number(number),
 		widget(widget)
 	{}
 #endif /* DOXYGEN_API */
 	/**
 	 * Convert an ScriptEvent to the real instance.
 	 * @param instance The instance to convert.
 	 * @return The converted instance.
 	 */
 	static ScriptEventWindowWidgetClick *Convert(ScriptEvent *instance) { return (ScriptEventWindowWidgetClick *)instance; }
 	/**
 	 * Get the class of the window that was clicked.
 	 */
 	ScriptWindow::WindowClass GetWindowClass() { return this->window; }
@@ @@ -921,35 +969,37 @@ private: @@
 	uint32 number;                    ///< Number of the click.
 	uint8 widget;                     ///< Widget of the click.
 };
 /**
  * Event Goal Question Answer, where you receive the answer given to your questions.
  * @note It is possible that you get more than 1 answer from the same company
  *  (due to lag). Please keep this in mind while handling this event.
  * @api game
  */
 class ScriptEventGoalQuestionAnswer : public ScriptEvent {
 public:
 #ifndef DOXYGEN_API
 	/**
 	 * @param uniqueid The uniqueID you have given this question.
 	 * @param company The company that is replying.
 	 * @param button The button the company pressed.
 	 */
 	ScriptEventGoalQuestionAnswer(uint16 uniqueid, ScriptCompany::CompanyID company, ScriptGoal::QuestionButton button) :
 		ScriptEvent(ET_GOAL_QUESTION_ANSWER),
 		uniqueid(uniqueid),
 		company(company),
 		button(button)
 	{}
 #endif /* DOXYGEN_API */
 	/**
 	 * Convert an ScriptEvent to the real instance.
 	 * @param instance The instance to convert.
 	 * @return The converted instance.
 	 */
 	static ScriptEventGoalQuestionAnswer *Convert(ScriptEvent *instance) { return (ScriptEventGoalQuestionAnswer *)instance; }
 	/**
 	 * Get the unique id of the question.
 	 */
 	uint16 GetUniqueID() { return this->uniqueid; }
@@ @@ -967,34 +1017,36 @@ public: @@
 private:
 	uint16 uniqueid;                   ///< The uniqueid of the question.
 	ScriptCompany::CompanyID company;  ///< The company given the answer.
 	ScriptGoal::QuestionButton button; ///< The button that was pressed.
 };
 /**
  * Base class for events involving a town and a company.
  * @api ai game
  */
 class ScriptEventCompanyTown : public ScriptEvent {
 public:
 #ifndef DOXYGEN_API
 	/**
 	 * @param event The eventtype.
 	 * @param company The company.
 	 * @param town The town.
 	 */
 	ScriptEventCompanyTown(ScriptEventType event, ScriptCompany::CompanyID company, TownID town) :
 		ScriptEvent(event),
 		company(company),
 		town(town)
 	{}
 #endif /* DOXYGEN_API */
 	/**
 	 * Convert an ScriptEvent to the real instance.
 	 * @param instance The instance to convert.
 	 * @return The converted instance.
 	 */
 	static ScriptEventCompanyTown *Convert(ScriptEvent *instance) { return (ScriptEventCompanyTown *)instance; }
 	/**
 	 * Get the CompanyID of the company.
 	 * @return The CompanyID of the company involved into the event.
 	 */
@@ @@ -1009,78 +1061,84 @@ public: @@
 private:
 	ScriptCompany::CompanyID company; ///< The company involved into the event.
 	TownID town;                      ///< The town involved into the event.
 };
 /**
  * Event Exclusive Transport Rights, indicating that company bought
  * exclusive transport rights in a town.
  * @api ai game
  */
 class ScriptEventExclusiveTransportRights : public ScriptEventCompanyTown {
 public:
 #ifndef DOXYGEN_API
 	/**
 	 * @param company The company.
 	 * @param town The town.
 	 */
 	ScriptEventExclusiveTransportRights(ScriptCompany::CompanyID company, TownID town) :
 		ScriptEventCompanyTown(ET_EXCLUSIVE_TRANSPORT_RIGHTS, company, town)
 	{}
 #endif /* DOXYGEN_API */
 	/**
 	 * Convert an ScriptEvent to the real instance.
 	 * @param instance The instance to convert.
 	 * @return The converted instance.
 	 */
 	static ScriptEventExclusiveTransportRights *Convert(ScriptEventCompanyTown *instance) { return (ScriptEventExclusiveTransportRights *)instance; }
 };
 /**
  * Event Road Reconstruction, indicating that company triggered
  * road reconstructions in a town.
  * @api ai game
  */
 class ScriptEventRoadReconstruction : public ScriptEventCompanyTown {
 public:
 #ifndef DOXYGEN_API
 	/**
 	 * @param company The company.
 	 * @param town The town.
 	 */
 	ScriptEventRoadReconstruction(ScriptCompany::CompanyID company, TownID town) :
 		ScriptEventCompanyTown(ET_ROAD_RECONSTRUCTION, company, town)
 	{}
 #endif /* DOXYGEN_API */
 	/**
 	 * Convert an ScriptEvent to the real instance.
 	 * @param instance The instance to convert.
 	 * @return The converted instance.
 	 */
 	static ScriptEventRoadReconstruction *Convert(ScriptEventCompanyTown *instance) { return (ScriptEventRoadReconstruction *)instance; }
 };
 /**
  * Event VehicleAutoReplaced, indicating a vehicle has been auto replaced.
  * @api ai
  */
 class ScriptEventVehicleAutoReplaced : public ScriptEvent {
 public:
 #ifndef DOXYGEN_API
 	/**
 	 * @param old_id The vehicle that has been replaced.
 	 * @param new_id The vehicle that has been created in replacement.
 	 */
 	ScriptEventVehicleAutoReplaced(VehicleID old_id, VehicleID new_id) :
 		ScriptEvent(ET_VEHICLE_AUTOREPLACED),
 		old_id(old_id),
 		new_id(new_id)
 	{}
 #endif /* DOXYGEN_API */
 	/**
 	 * Convert an ScriptEvent to the real instance.
 	 * @param instance The instance to convert.
 	 * @return The converted instance.
 	 */
 	static ScriptEventVehicleAutoReplaced *Convert(ScriptEvent *instance) { return (ScriptEventVehicleAutoReplaced *)instance; }
 	/**
 	 * Get the VehicleID of the vehicle that has been replaced.
 	 * @return The VehicleID of the vehicle that has been replaced. This ID is no longer valid for referencing the vehicle.
 	 */
@@ @@ -1094,35 +1152,37 @@ public: @@
 private:
 	VehicleID old_id; ///< The vehicle that has been replaced.
 	VehicleID new_id; ///< The vehicle that has been created in replacement.
 };
 /**
  * Event StoryPageButtonClick, indicating a player clicked a push button on a storybook page.
  * @api game
  */
 class ScriptEventStoryPageButtonClick : public ScriptEvent {
 public:
 #ifndef DOXYGEN_API
 	/**
 	 * @param company_id  Which company triggered the event.
 	 * @param page_id     Which page was the clicked button on.
 	 * @param element_id  Which button element was clicked.
 	 */
 	ScriptEventStoryPageButtonClick(CompanyID company_id, StoryPageID page_id, StoryPageElementID element_id) :
 		ScriptEvent(ET_STORYPAGE_BUTTON_CLICK),
 		company_id((ScriptCompany::CompanyID)company_id),
 		page_id(page_id),
 		element_id(element_id)
 	{ }
 	{}
 #endif /* DOXYGEN_API */
 	/**
 	 * Convert an ScriptEvent to the real instance.
 	 * @param instance The instance to convert.
 	 * @return The converted instance.
 	 */
 	static ScriptEventStoryPageButtonClick *Convert(ScriptEvent *instance) { return (ScriptEventStoryPageButtonClick *)instance; }
 	/** Get the CompanyID of the player that selected a tile. */
 	ScriptCompany::CompanyID GetCompanyID() { return this->company_id; }
 	/** Get the StoryPageID of the storybook page the clicked button is located on. */
@@ @@ -1134,37 +1194,39 @@ public: @@
 private:
 	ScriptCompany::CompanyID company_id;
 	StoryPageID page_id;
 	StoryPageElementID element_id;
 };
 /**
  * Event StoryPageTileSelect, indicating a player clicked a tile selection button on a storybook page, and selected a tile.
  * @api game
  */
 class ScriptEventStoryPageTileSelect : public ScriptEvent {
 public:
 #ifndef DOXYGEN_API
 	/**
 	 * @param company_id  Which company triggered the event.
 	 * @param page_id     Which page is the used selection button on.
 	 * @param element_id  Which button element was used to select the tile.
 	 * @param tile_index  Which tile was selected by the player.
 	 */
 	ScriptEventStoryPageTileSelect(CompanyID company_id, StoryPageID page_id, StoryPageElementID element_id, TileIndex tile_index) :
 		ScriptEvent(ET_STORYPAGE_TILE_SELECT),
 		company_id((ScriptCompany::CompanyID)company_id),
 		page_id(page_id),
 		element_id(element_id),
 		tile_index(tile_index)
 	{ }
 	{}
 #endif /* DOXYGEN_API */
 	/**
 	 * Convert an ScriptEvent to the real instance.
 	 * @param instance The instance to convert.
 	 * @return The converted instance.
 	 */
 	static ScriptEventStoryPageTileSelect *Convert(ScriptEvent *instance) { return (ScriptEventStoryPageTileSelect *)instance; }
 	/** Get the CompanyID of the player that selected a tile. */
 	ScriptCompany::CompanyID GetCompanyID() { return this->company_id; }
 	/** Get the StoryPageID of the storybook page the used selection button is located on. */
@@ @@ -1180,37 +1242,39 @@ private: @@
 	ScriptCompany::CompanyID company_id;
 	StoryPageID page_id;
 	StoryPageElementID element_id;
 	TileIndex tile_index;
 };
 /**
  * Event StoryPageTileSelect, indicating a player clicked a tile selection button on a storybook page, and selected a tile.
  * @api game
  */
 class ScriptEventStoryPageVehicleSelect : public ScriptEvent {
 public:
 #ifndef DOXYGEN_API
 	/**
 	 * @param company_id  Which company triggered the event.
 	 * @param page_id     Which page is the used selection button on.
 	 * @param element_id  Which button element was used to select the tile.
 	 * @param vehicle_id  Which vehicle was selected by the player.
 	 */
 	ScriptEventStoryPageVehicleSelect(CompanyID company_id, StoryPageID page_id, StoryPageElementID element_id, VehicleID vehicle_id) :
 		ScriptEvent(ET_STORYPAGE_VEHICLE_SELECT),
 		company_id((ScriptCompany::CompanyID)company_id),
 		page_id(page_id),
 		element_id(element_id),
 		vehicle_id(vehicle_id)
 	{ }
 	{}
 #endif /* DOXYGEN_API */
 	/**
 	 * Convert an ScriptEvent to the real instance.
 	 * @param instance The instance to convert.
 	 * @return The converted instance.
 	 */
 	static ScriptEventStoryPageVehicleSelect *Convert(ScriptEvent *instance) { return (ScriptEventStoryPageVehicleSelect *)instance; }
 	/** Get the CompanyID of the player that selected a tile. */
 	ScriptCompany::CompanyID GetCompanyID() { return this->company_id; }
 	/** Get the StoryPageID of the storybook page the used selection button is located on. */

0 comments (0 inline, 0 general)