mirror of
https://gitea.wildfiregames.com/0ad/0ad.git
synced 2026-06-21 01:04:06 +00:00
wraitii
3bcf360107
- Non-visual replays now automatically try to load the replay mods. This
removes the annoyance that -mod=public usually had to be passed.
- MountMods is no longer called in InitVfs but later, making it possible
to load the game in one pass & simplifying things considerably.
- Explicitly ignore duplicates when loading mods
- Interface cleanup: failed mods and incompatible mods were redundant,
only incompatible mods is kept.
- Interface cleanup: `AreModsCompatible`becomes
`CheckForIncompatibleMods`, which becomes a private pure function,
simplifying the control flow somewhat.
- Interface cleanup: `CheckAndEnableMods` is just `EnableMods`, which
explicitly updates loaded & incompatible mods.
- `CacheEnabledModVersions` becomes private and is called on behalf of
the user, removing the need to be careful about updating that (fixes my
concern at 44ec2e324e)
Overall, the logic around mounting & enabled mods should be easier to
understand.
Differential Revision: https://code.wildfiregames.com/D3982
This was SVN commit r25474.
92 lines
3.3 KiB
C++
92 lines
3.3 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>
|
|
|
|
#define g_Mods (Mod::Instance())
|
|
|
|
class Mod
|
|
{
|
|
friend class TestMod;
|
|
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;
|
|
|
|
/**
|
|
* Enable the default mods. De-activates any non-default mod currently enabled.
|
|
*/
|
|
void EnableDefaultMods(const ScriptInterface& scriptInterface);
|
|
|
|
/**
|
|
* Enables specified mods (& mods required by the engine).
|
|
* @param addPublic - if true, enable the public mod.
|
|
* @return whether the mods were enabled successfully. This can fail if e.g. mods are incompatible.
|
|
* If true, GetEnabledMods() should be non-empty, GetIncompatibleMods() empty. Otherwise, GetIncompatibleMods() is non-empty.
|
|
*/
|
|
bool EnableMods(const ScriptInterface& scriptInterface, const std::vector<CStr>& mods, const bool addPublic);
|
|
|
|
/**
|
|
* 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:
|
|
/**
|
|
* 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 ScriptInterface& scriptInterface);
|
|
|
|
/**
|
|
* Checks a list of @a mods and returns the incompatible mods, if any.
|
|
*/
|
|
std::vector<CStr> CheckForIncompatibleMods(const ScriptInterface& scriptInterface, const std::vector<CStr>& mods, const JS::RootedValue& availableMods) const;
|
|
bool CompareVersionStrings(const CStr& required, const CStr& op, const CStr& version) const;
|
|
|
|
std::vector<CStr> m_ModsLoaded;
|
|
// Of the currently loaded mods, these are the incompatible with the engine and cannot be loaded.
|
|
std::vector<CStr> m_IncompatibleMods;
|
|
|
|
std::vector<std::vector<CStr>> m_LoadedModVersions;
|
|
};
|
|
|
|
#endif // INCLUDED_MOD
|