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

Feature: GS method to control engine availability for a specific company (#7791)

Browse Source 
* Feature: GS method to allow company to use an engine before its introduction date

* Feature: GS method to retire an engine early for a specific company
This commit is contained in:
Pavel Stupnikov
2020-01-15 20:46:26 +03:00
committed by Niels Martin Hansen
parent 4366f8e46a
commit d7a928a08b
7 changed files with 122 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
src/script/api/game/game_engine.hpp.sq
View File

@@ -46,6 +46,8 @@ void SQGSEngine_Register(Squirrel *engine)
SQGSEngine.DefSQStaticMethod(engine, &ScriptEngine::IsArticulated, "IsArticulated", 2, ".i");
SQGSEngine.DefSQStaticMethod(engine, &ScriptEngine::GetPlaneType, "GetPlaneType", 2, ".i");
SQGSEngine.DefSQStaticMethod(engine, &ScriptEngine::GetMaximumOrderDistance, "GetMaximumOrderDistance", 2, ".i");
SQGSEngine.DefSQStaticMethod(engine, &ScriptEngine::EnableForCompany, "EnableForCompany", 3, ".ii");
SQGSEngine.DefSQStaticMethod(engine, &ScriptEngine::DisableForCompany, "DisableForCompany", 3, ".ii");
SQGSEngine.PostRegister(engine);
}

2
src/script/api/game_changelog.hpp
View File

@@ -25,6 +25,8 @@
* \li GSRoad::RoadVehHasPowerOnRoad
* \li GSRoad::ConvertRoadType
* \li GSRoad::GetMaxSpeed
* \li GSEngine::EnableForCompany
* \li GSEngine::DisableForCompany
*
* \b 1.9.0
*

22
src/script/api/script_engine.cpp
View File

@@ -276,3 +276,25 @@
return 0;
}
}
/* static */ bool ScriptEngine::EnableForCompany(EngineID engine_id, ScriptCompany::CompanyID company)
{
company = ScriptCompany::ResolveCompanyID(company);
EnforcePrecondition(false, ScriptObject::GetCompany() == OWNER_DEITY);
EnforcePrecondition(false, IsValidEngine(engine_id));
EnforcePrecondition(false, company != ScriptCompany::COMPANY_INVALID);
return ScriptObject::DoCommand(0, engine_id, (uint32)company | (1 << 31), CMD_ENGINE_CTRL);
}
/* static */ bool ScriptEngine::DisableForCompany(EngineID engine_id, ScriptCompany::CompanyID company)
{
company = ScriptCompany::ResolveCompanyID(company);
EnforcePrecondition(false, ScriptObject::GetCompany() == OWNER_DEITY);
EnforcePrecondition(false, IsValidEngine(engine_id));
EnforcePrecondition(false, company != ScriptCompany::COMPANY_INVALID);
return ScriptObject::DoCommand(0, engine_id, company, CMD_ENGINE_CTRL);
}

23
src/script/api/script_engine.hpp
View File

@@ -287,6 +287,29 @@ public:
* @see ScriptOrder::GetOrderDistance
*/
static uint GetMaximumOrderDistance(EngineID engine_id);
/**
* Allows a company to use an engine before its intro date or after retirement.
* @param engine_id The engine to enable.
* @param company_id The company to allow using the engine.
* @pre IsValidEngine(engine_id).
* @pre ScriptCompany.ResolveCompanyID(company_id) != ScriptCompany::COMPANY_INVALID.
* @return True if the action succeeded.
* @api -ai
*/
static bool EnableForCompany(EngineID engine_id, ScriptCompany::CompanyID company_id);
/**
* Forbids a company to use an engine before its natural retirement.
* @param engine_id The engine to disable.
* @param company_id The company to forbid using the engine.
* @pre IsValidEngine(engine_id).
* @pre ScriptCompany.ResolveCompanyID(company_id) != ScriptCompany::COMPANY_INVALID.
* @return True if the action succeeded.
* @api -ai
*/
static bool DisableForCompany(EngineID engine_id, ScriptCompany::CompanyID company_id);
};
#endif /* SCRIPT_ENGINE_HPP */