Class ScriptManager

java.lang.Object

de.luckymcdev.foundryengine.script.common.ScriptManager

public final class ScriptManager
extends Object

MANAGER: creates and owns everything else (definitions, runtimes, editor state, compiler, thread pools).

Compilation is parallel across bundles on a bounded daemon pool. To get that parallelism call prepareAll(Map) once with all bundles before the first load(String, BundleFiles, ScriptEnv); a lone load(String, BundleFiles, ScriptEnv) compiles just its bundle. Entry code (constructors, onLoad, onUnload) runs on the calling thread's behalf under the sandbox timeout, in load order.

Constructor Summary

Constructors

Constructor	Description
ScriptManager(Set<ScriptEnv> activeEnvs)

Method Summary

Modifier and Type	Method	Description
Map<String, List<Throwable>>	drainErrors()
List<BundleEntrypoint>	load(String bundleId, BundleFiles files, ScriptEnv env)	Waits for the bundle's compilation, then loads the entrypoints of one environment.
CompletableFuture<Void>	prepare(String bundleId, BundleFiles files)	Starts compiling a bundle if it is not known yet.
CompletableFuture<Void>	prepareAll(Map<String, BundleFiles> bundles)	Starts compiling all given bundles in parallel.
CompletableFuture<Void>	reload(String bundleId)	Unloads, recompiles and reloads the environments that were loaded before.
Optional<ScriptRuntime>	runtime(String bundleId)
Collection<ScriptRuntime>	runtimes()
CompletableFuture<Void>	setBundleEnabled(String bundleId, boolean enabled)
CompletableFuture<Void>	setScriptEnabled(String bundleId, String script, boolean enabled)
void	shutdown()
void	unloadAll()	Unloads every bundle (calling onUnload) and forgets it.
void	unloadBundle(String bundleId)	Unloads a single bundle: fires onUnload on its entrypoints and closes its class loader.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ScriptManager

public ScriptManager(Set<ScriptEnv> activeEnvs)

Parameters:

activeEnvs - environments this JVM runs: all three on a client, COMMON and SERVER on a dedicated server. Scripts of other environments are never compiled.

Method Details

prepare

public CompletableFuture<Void> prepare(String bundleId,
 BundleFiles files)

Starts compiling a bundle if it is not known yet. The future completes when it is compiled.

prepareAll

public CompletableFuture<Void> prepareAll(Map<String, BundleFiles> bundles)

Starts compiling all given bundles in parallel.

load

public List<BundleEntrypoint> load(String bundleId,
 BundleFiles files,
 ScriptEnv env)

Waits for the bundle's compilation, then loads the entrypoints of one environment.

reload

public CompletableFuture<Void> reload(String bundleId)

Unloads, recompiles and reloads the environments that were loaded before.

setBundleEnabled

public CompletableFuture<Void> setBundleEnabled(String bundleId,
 boolean enabled)

setScriptEnabled

public CompletableFuture<Void> setScriptEnabled(String bundleId,
 String script,
 boolean enabled)

unloadBundle

public void unloadBundle(String bundleId)

Unloads a single bundle: fires onUnload on its entrypoints and closes its class loader. The bundle is then forgotten so the next load(String, BundleFiles, ScriptEnv) recompiles.

unloadAll

public void unloadAll()

Unloads every bundle (calling onUnload) and forgets it. Next load recompiles.

shutdown

public void shutdown()

runtimes

public Collection<ScriptRuntime> runtimes()

runtime

public Optional<ScriptRuntime> runtime(String bundleId)

drainErrors

public Map<String, List<Throwable>> drainErrors()