mirrors/0ad
1
0
Fork 2
mirror of https://gitea.wildfiregames.com/0ad/0ad.git synced 2026-06-25 08:44:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

Allow mods to say they should be ignored in replay/MP compatibility checks

Browse Source 
Since it is very non-trivial to determine which mods change checksums
and which don't, this relies on modder goodwill (and on verification on
our end for signed mods).

The declaration is an optional "ignoreInCompatibilityChecks" boolean in
mod.json

Also rework slightly the MP lobby mod display to always show the host
mods in a clear manner.

Differential Revision: https://code.wildfiregames.com/D3968
This was SVN commit r25634.
This commit is contained in:
wraitii
2021-06-02 06:50:16 +00:00
parent 693f296e71
commit 07e44a75a1
10 changed files with 409 additions and 238 deletions
Download Patch File Download Diff File Expand all files Collapse all files
source/ps/scripting/JSInterface_Mod.cpp
+113 -2
View File
@@ -20,10 +20,73 @@
#include "JSInterface_Mod.h"
#include "ps/Mod.h"
#include "ps/Pyrogenesis.h"
#include "scriptinterface/FunctionWrapper.h"
#include "scriptinterface/JSON.h"
#include "scriptinterface/ScriptConversions.h"
extern void RestartEngine();
// To avoid copying data needlessly in GetEngineInfo, implement a ToJSVal for pointer types.
using ModDataCPtr = const Mod::ModData*;
template<>
void Script::ToJSVal(const ScriptRequest& rq, JS::MutableHandleValue ret, const ModDataCPtr& data)
{
ret.set(Script::CreateObject(rq));
Script::SetProperty(rq, ret, "mod", data->m_Pathname);
Script::SetProperty(rq, ret, "name", data->m_Name);
Script::SetProperty(rq, ret, "version", data->m_Version);
Script::SetProperty(rq, ret, "ignoreInCompatibilityChecks", data->m_IgnoreInCompatibilityChecks);
}
// Required by JSVAL_VECTOR, but can't be implemented.
template<>
bool Script::FromJSVal(const ScriptRequest &, const JS::HandleValue, ModDataCPtr&)
{
LOGERROR("Not implemented");
return false;
}
JSVAL_VECTOR(const Mod::ModData*);
// Implement FromJSVal as a non-pointer type.
template<>
void Script::ToJSVal(const ScriptRequest& rq, JS::MutableHandleValue ret, const Mod::ModData& data)
{
ret.set(Script::CreateObject(rq));
Script::SetProperty(rq, ret, "mod", data.m_Pathname);
Script::SetProperty(rq, ret, "name", data.m_Name);
Script::SetProperty(rq, ret, "version", data.m_Version);
Script::SetProperty(rq, ret, "ignoreInCompatibilityChecks", data.m_IgnoreInCompatibilityChecks);
}
template<>
bool Script::FromJSVal(const ScriptRequest& rq, const JS::HandleValue val, Mod::ModData& data)
{
// This property is not set in mod.json files, so don't fail if it's not there.
if (Script::HasProperty(rq, val, "mod") && !Script::GetProperty(rq, val, "mod", data.m_Pathname))
return false;
if (!Script::GetProperty(rq, val, "version", data.m_Version))
return false;
if (!Script::GetProperty(rq, val, "name", data.m_Name))
return false;
// Optional - this makes the mod 'GUI-only'.
if (Script::HasProperty(rq, val, "ignoreInCompatibilityChecks"))
{
if (!Script::GetProperty(rq, val, "ignoreInCompatibilityChecks", data.m_IgnoreInCompatibilityChecks))
return false;
}
else
data.m_IgnoreInCompatibilityChecks = false;
return true;
}
JSVAL_VECTOR(Mod::ModData);
namespace JSI_Mod
{
Mod* ModGetter(const ScriptRequest&, JS::CallArgs&)
@@ -31,6 +94,53 @@ Mod* ModGetter(const ScriptRequest&, JS::CallArgs&)
return &g_Mods;
}
JS::Value GetEngineInfo(const ScriptInterface& scriptInterface)
{
ScriptRequest rq(scriptInterface);
JS::RootedValue mods(rq.cx);
Script::ToJSVal(rq, &mods, g_Mods.GetEnabledModsData());
JS::RootedValue metainfo(rq.cx);
Script::CreateObject(
rq,
&metainfo,
"engine_version", engine_version,
"mods", mods);
Script::FreezeObject(rq, metainfo, true);
return metainfo;
}
JS::Value GetAvailableMods(const ScriptRequest& rq)
{
JS::RootedValue ret(rq.cx, Script::CreateObject(rq));
for (const Mod::ModData& data : g_Mods.GetAvailableMods())
{
JS::RootedValue json(rq.cx);
if (!Script::ParseJSON(rq, data.m_Text, &json))
{
ScriptException::Raise(rq, "Error parsing mod.json of '%s'", data.m_Pathname.c_str());
continue;
}
Script::SetProperty(rq, ret, data.m_Pathname.c_str(), json);
}
return ret.get();
}
bool AreModsPlayCompatible(const std::vector<Mod::ModData>& a, const std::vector<Mod::ModData>& b)
{
std::vector<const Mod::ModData*> modsA, modsB;
modsA.reserve(a.size());
for (const Mod::ModData& mod : a)
modsA.push_back(&mod);
modsB.reserve(b.size());
for (const Mod::ModData& mod : b)
modsB.push_back(&mod);
return Mod::AreModsPlayCompatible(modsA, modsB);
}
bool SetModsAndRestartEngine(const ScriptInterface& scriptInterface, const std::vector<CStr>& mods)
{
if (!g_Mods.EnableMods(scriptInterface, mods, false))
@@ -47,9 +157,10 @@ bool HasIncompatibleMods()
void RegisterScriptFunctions(const ScriptRequest& rq)
{
ScriptFunction::Register<&Mod::GetEngineInfo, ModGetter>(rq, "GetEngineInfo");
ScriptFunction::Register<&Mod::GetAvailableMods, ModGetter>(rq, "GetAvailableMods");
ScriptFunction::Register<GetEngineInfo>(rq, "GetEngineInfo");
ScriptFunction::Register<GetAvailableMods>(rq, "GetAvailableMods");
ScriptFunction::Register<&Mod::GetEnabledMods, ModGetter>(rq, "GetEnabledMods");
ScriptFunction::Register<AreModsPlayCompatible>(rq, "AreModsPlayCompatible");
ScriptFunction::Register<HasIncompatibleMods> (rq, "HasIncompatibleMods");
ScriptFunction::Register<&Mod::GetIncompatibleMods, ModGetter>(rq, "GetIncompatibleMods");
ScriptFunction::Register<&SetModsAndRestartEngine>(rq, "SetModsAndRestartEngine");