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 e0ffe4faf2
commit 5858c53420
6 changed files with 96 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
src/script/api/game/game_subsidy.hpp.sq
View File

@@ -27,6 +27,7 @@ void SQGSSubsidy_Register(Squirrel *engine)
SQGSSubsidy.DefSQStaticMethod(engine, &ScriptSubsidy::IsValidSubsidy, "IsValidSubsidy", 2, ".i");
SQGSSubsidy.DefSQStaticMethod(engine, &ScriptSubsidy::IsAwarded, "IsAwarded", 2, ".i");
SQGSSubsidy.DefSQStaticMethod(engine, &ScriptSubsidy::Create, "Create", 6, ".iiiii");
SQGSSubsidy.DefSQStaticMethod(engine, &ScriptSubsidy::GetAwardedTo, "GetAwardedTo", 2, ".i");
SQGSSubsidy.DefSQStaticMethod(engine, &ScriptSubsidy::GetExpireDate, "GetExpireDate", 2, ".i");
SQGSSubsidy.DefSQStaticMethod(engine, &ScriptSubsidy::GetCargoType, "GetCargoType", 2, ".i");

14
src/script/api/script_subsidy.cpp
View File

@@ -12,6 +12,9 @@
#include "../../stdafx.h"
#include "script_subsidy.hpp"
#include "script_date.hpp"
#include "script_industry.hpp"
#include "script_town.hpp"
#include "script_error.hpp"
#include "../../subsidy_base.h"
#include "../../station_base.h"
@@ -27,6 +30,17 @@
return ::Subsidy::Get(subsidy_id)->IsAwarded();
}
/* static */ bool ScriptSubsidy::Create(CargoID cargo_type, SubsidyParticipantType from_type, uint16 from_id, SubsidyParticipantType to_type, uint16 to_id)
{
EnforcePrecondition(false, ScriptCargo::IsValidCargo(cargo_type));
EnforcePrecondition(false, from_type == SPT_INDUSTRY || from_type == SPT_TOWN);
EnforcePrecondition(false, to_type == SPT_INDUSTRY || to_type == SPT_TOWN);
EnforcePrecondition(false, (from_type == SPT_INDUSTRY && ScriptIndustry::IsValidIndustry(from_id)) || (from_type == SPT_TOWN && ScriptTown::IsValidTown(from_id)));
EnforcePrecondition(false, (to_type == SPT_INDUSTRY && ScriptIndustry::IsValidIndustry(to_id)) || (to_type == SPT_TOWN && ScriptTown::IsValidTown(to_id)));
return ScriptObject::DoCommand(0, from_type | (from_id << 8) | (cargo_type << 24), to_type | (to_id << 8), CMD_CREATE_SUBSIDY);
}
/* static */ ScriptCompany::CompanyID ScriptSubsidy::GetAwardedTo(SubsidyID subsidy_id)
{
if (!IsAwarded(subsidy_id)) return ScriptCompany::COMPANY_INVALID;

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.