File: Mod.h

package info (click to toggle)
0ad 0.0.23.1-2
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 78,292 kB
  • sloc: cpp: 245,166; ansic: 200,249; python: 13,754; sh: 6,104; perl: 4,620; makefile: 977; xml: 810; java: 533; ruby: 229; erlang: 46; pascal: 30; sql: 21; tcl: 4
file content (59 lines) | stat: -rw-r--r-- 2,057 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
/* Copyright (C) 2018 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 "ps/GameSetup/CmdLineArgs.h"
#include "scriptinterface/ScriptInterface.h"

class ScriptRuntime;

extern std::vector<CStr> g_modsLoaded;
extern CmdLineArgs g_args;

namespace Mod
{
	JS::Value GetAvailableMods(const ScriptInterface& scriptInterface);

	/**
	 * 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<ScriptRuntime>& scriptRuntime);

	/**
	 * 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);

	/**
	 * 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);
}
#endif // INCLUDED_MOD