dave/openttd
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

(svn r23628) -Add: ScriptSubsidy::Create, to create subsidies (GameScript only)

Browse Source
This commit is contained in:
truebrain
2011-12-19 21:01:12 +00:00
parent 09ef12ab03
commit 2fc120d4d1
6 changed files with 96 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
src/script/api/script_subsidy.hpp
View File

@@ -25,6 +25,9 @@ public:
* @note The list of values may grow in future.
*/
enum SubsidyParticipantType {
/* Values are important, as they represent the internal state of the game.
* It is orignally named SourceType. ST_HEADQUARTERS is intentionally
* left out, as it cannot be used for Subsidies. */
SPT_INDUSTRY = 0, ///< Subsidy participant is an industry
SPT_TOWN = 1, ///< Subsidy participant is a town
SPT_INVALID = 0xFF, ///< Invalid/unknown participant type
@@ -45,6 +48,23 @@ public:
*/
static bool IsAwarded(SubsidyID subsidy_id);
/**
* Create a new subsidy.
* @param cargo_type The type of cargo to cary for the subsidy.
* @param from_type The type of the subsidy on the 'from' side.
* @param from_id The ID of the 'from' side.
* @param to_type The type of the subsidy on the 'to' side.
* @param to_id The ID of the 'to' side.
* @return True if the action succeeded.
* @pre ScriptCargo::IsValidCargo(cargo_type)
* @pre from_type == SPT_INDUSTRY || from_type == SPT_TOWN.
* @pre to_type == SPT_INDUSTRY || to_type == SPT_TOWN.
* @pre (from_type == SPT_INDUSTRY && ScriptIndustry::IsValidIndustry(from_id)) || (from_type == SPT_TOWN && ScriptTown::IsValidTown(from_id))
* @pre (to_type == SPT_INDUSTRY && ScriptIndustry::IsValidIndustry(to_id)) || (to_type == SPT_TOWN && ScriptTown::IsValidTown(to_id))
* @api -ai
*/
static bool Create(CargoID cargo_type, SubsidyParticipantType from_type, uint16 from_id, SubsidyParticipantType to_type, uint16 to_id);
/**
* Get the company index of the company this subsidy is awarded to.
* @param subsidy_id The SubsidyID to check.