mirror of
https://gitea.wildfiregames.com/0ad/0ad.git
synced 2026-06-21 01:04:06 +00:00
wraitii
04549a081d
`Mod` currently modifies 4 global arrays, including some that are 'public'. The logic flow is easier to understand if this becomes a real class with const-correctness and public/private methods. Differential Revision: https://code.wildfiregames.com/D3981 This was SVN commit r25469.
84 lines
2.8 KiB
C++
84 lines
2.8 KiB
C++
/* Copyright (C) 2021 Wildfire Games.
|
|
* This file is part of 0 A.D.
|
|
*
|
|
* 0 A.D. is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation, either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* 0 A.D. is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with 0 A.D. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
#ifndef INCLUDED_MOD
|
|
#define INCLUDED_MOD
|
|
|
|
#include "ps/CStr.h"
|
|
#include "scriptinterface/ScriptForward.h"
|
|
|
|
#include <vector>
|
|
|
|
class CmdLineArgs;
|
|
|
|
extern CmdLineArgs g_CmdLineArgs;
|
|
|
|
#define g_Mods (Mod::Instance())
|
|
|
|
class Mod
|
|
{
|
|
public:
|
|
// Singleton-like interface.
|
|
static Mod& Instance();
|
|
|
|
JS::Value GetAvailableMods(const ScriptInterface& scriptInterface) const;
|
|
const std::vector<CStr>& GetEnabledMods() const;
|
|
const std::vector<CStr>& GetIncompatibleMods() const;
|
|
const std::vector<CStr>& GetFailedMods() const;
|
|
|
|
/**
|
|
* This reads the version numbers from the launched mods.
|
|
* It caches the result, since the reading of zip files is slow and
|
|
* JS pages can request the version numbers too often easily.
|
|
* Make sure this is called after each MountMods call.
|
|
*/
|
|
void CacheEnabledModVersions(const shared_ptr<ScriptContext>& scriptContext);
|
|
|
|
const std::vector<CStr>& GetModsFromArguments(const CmdLineArgs& args, int flags);
|
|
bool AreModsCompatible(const ScriptInterface& scriptInterface, const std::vector<CStr>& mods, const JS::RootedValue& availableMods);
|
|
bool CheckAndEnableMods(const ScriptInterface& scriptInterface, const std::vector<CStr>& mods);
|
|
bool CompareVersionStrings(const CStr& required, const CStr& op, const CStr& version) const;
|
|
void SetDefaultMods();
|
|
void ClearIncompatibleMods();
|
|
|
|
/**
|
|
* Get the loaded mods and their version.
|
|
* "user" mod and "mod" mod are ignored as they are irrelevant for compatibility checks.
|
|
*
|
|
* @param scriptInterface the ScriptInterface in which to create the return data.
|
|
* @return list of loaded mods with the format [[modA, versionA], [modB, versionB], ...]
|
|
*/
|
|
JS::Value GetLoadedModsWithVersions(const ScriptInterface& scriptInterface) const;
|
|
|
|
/**
|
|
* Gets info (version and mods loaded) on the running engine
|
|
*
|
|
* @param scriptInterface the ScriptInterface in which to create the return data.
|
|
* @return list of objects containing data
|
|
*/
|
|
JS::Value GetEngineInfo(const ScriptInterface& scriptInterface) const;
|
|
|
|
private:
|
|
std::vector<CStr> m_ModsLoaded;
|
|
std::vector<CStr> m_IncompatibleMods;
|
|
std::vector<CStr> m_FailedMods;
|
|
|
|
std::vector<std::vector<CStr>> m_LoadedModVersions;
|
|
};
|
|
|
|
#endif // INCLUDED_MOD
|