Package ch.njol.skript

Class ScriptLoader

java.lang.Object

ch.njol.skript.ScriptLoader

public class ScriptLoader
extends Object

The main class for loading, unloading and reloading scripts.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ScriptLoader.LoaderEvent	Used for listening to events involving a ScriptLoader.
static class	ScriptLoader.ScriptInfo	A class for keeping track of the general content of a script: The amount of files The amount of structures
static interface	ScriptLoader.ScriptInitEvent	Called when a Script is created and preloaded in the ScriptLoader.
static interface	ScriptLoader.ScriptLoadEvent	Called when a Script is loaded in the ScriptLoader.
static interface	ScriptLoader.ScriptPreInitEvent	Called when ScriptLoader is preparing to load Configs into Scripts.
static interface	ScriptLoader.ScriptUnloadEvent	Called when a Script is unloaded in the ScriptLoader.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DISABLED_SCRIPT_PREFIX
static final int	DISABLED_SCRIPT_PREFIX_LENGTH

Constructor Summary

Constructors

Constructor	Description
ScriptLoader()

Method Summary

Modifier and Type	Method	Description
static void	deleteCurrentEvent()	Deprecated. Use ParserInstance.deleteCurrentEvent().
static EventRegistry<ScriptLoader.LoaderEvent>	eventRegistry()
static @Nullable String	getCurrentEventName()	Deprecated. Use ParserInstance.getCurrentEventName().
static @Nullable Class<? extends Event>[]	getCurrentEvents()	Deprecated. Use ParserInstance.getCurrentEvents().
static List<ch.njol.skript.sections.SecLoop>	getCurrentLoops()	Deprecated. Use ParserInstance.getCurrentSections(Class).
static @Nullable Config	getCurrentScript()	Deprecated. Use ParserInstance.getCurrentScript().
static List<TriggerSection>	getCurrentSections()	Deprecated. Use ParserInstance.getCurrentSections().
static Set<File>	getDisabledScripts()
static FileFilter	getDisabledScriptsFilter()
static Kleenean	getHasDelayBefore()	Deprecated. Use ParserInstance.getHasDelayBefore().
static Set<Script>	getLoadedScripts()
static FileFilter	getLoadedScriptsFilter()
static @Nullable Script	getScript(File file)	Searches through the loaded scripts to find the script loaded from the provided file.
static Set<Script>	getScripts(File directory)	Searches through the loaded scripts to find all scripts loaded from the files contained within the provided directory.
static boolean	isAsync()	Checks if scripts are loaded in separate thread.
static boolean	isCurrentEvent(@Nullable Class<? extends Event> event)	Deprecated. Use ParserInstance.isCurrentEvent(Class)
static boolean	isCurrentEvent(Class<? extends Event>... events)	Deprecated. Use ParserInstance.isCurrentEvent(Class[]).
static boolean	isParallel()	Checks if scripts are loaded in multiple threads instead of one thread.
static int	loadedScripts()	Deprecated. Use getLoadedScripts().size().
static int	loadedTriggers()	Deprecated. Use getLoadedScripts() and Script.getStructures().size().
static ArrayList<TriggerItem>	loadItems(SectionNode node)	Loads a section by converting it to TriggerItems.
static ScriptLoader.ScriptInfo	loadScripts(Config... configs)	Deprecated. Callers should not be using configs.
static CompletableFuture<ScriptLoader.ScriptInfo>	loadScripts(File file, OpenCloseable openCloseable)	Loads the Script present at the file using loadScripts(List, OpenCloseable), sending info/error messages when done.
static ScriptLoader.ScriptInfo	loadScripts(List<Config> configs)	Deprecated. Callers should not be using configs.
static ScriptLoader.ScriptInfo	loadScripts(List<Config> configs, List<LogEntry> logOut)	Deprecated. Callers should not be using configs.
static CompletableFuture<ScriptLoader.ScriptInfo>	loadScripts(Set<File> files, OpenCloseable openCloseable)	Loads the Scripts present at the files using loadScripts(List, OpenCloseable), sending info/error messages when done.
static Config	loadStructure(Config config)	Deprecated. This method has no functionality, it just returns its input.
static ScriptLoader.ScriptInfo	reloadScript(File script)	Deprecated. Use reloadScript(Script, OpenCloseable).
static CompletableFuture<ScriptLoader.ScriptInfo>	reloadScript(File scriptFile, OpenCloseable openCloseable)	Deprecated. Use reloadScript(Script, OpenCloseable).
static CompletableFuture<ScriptLoader.ScriptInfo>	reloadScript(Script script, OpenCloseable openCloseable)	Reloads a single Script.
static ScriptLoader.ScriptInfo	reloadScripts(File folder)	Deprecated. Use reloadScripts(Set, OpenCloseable).
static CompletableFuture<ScriptLoader.ScriptInfo>	reloadScripts(File folder, OpenCloseable openCloseable)	Deprecated. Use reloadScripts(java.util.Set<org.skriptlang.skript.lang.script.Script>, ch.njol.util.OpenCloseable).
static CompletableFuture<ScriptLoader.ScriptInfo>	reloadScripts(Set<Script> scripts, OpenCloseable openCloseable)	Reloads all provided Scripts.
static String	replaceOptions(String string)	Replaces options in a string.
static void	setAsyncLoaderSize(int size)	Sets the amount of async loaders, by updating asyncLoaderSize and loaderThreads.
static void	setCurrentEvent(String name, @Nullable Class<? extends Event>... events)	Deprecated. Use ParserInstance.setCurrentEvent(String, Class[]).
static void	setCurrentLoops(List<ch.njol.skript.sections.SecLoop> currentLoops)	Deprecated. Never use this method, it has no effect.
static void	setCurrentScript(@Nullable Config currentScript)	Deprecated. Addons should no longer be modifying this.
static void	setCurrentSections(List<TriggerSection> currentSections)	Deprecated. Use ParserInstance.setCurrentSections(List).
static void	setHasDelayBefore(Kleenean hasDelayBefore)	Deprecated. Use ParserInstance.setHasDelayBefore(Kleenean).
static ScriptLoader.ScriptInfo	unloadScript(File scriptFile)	Deprecated. Use unloadScript(Script).
static ScriptLoader.ScriptInfo	unloadScript(Script script)	Unloads the provided script.
static ScriptLoader.ScriptInfo	unloadScripts(Set<Script> scripts)	Unloads all scripts present in the provided collection.

Methods inherited from class java.lang.Object

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

Field Details

DISABLED_SCRIPT_PREFIX

public static final String DISABLED_SCRIPT_PREFIX

See Also:

• Constant Field Values

DISABLED_SCRIPT_PREFIX_LENGTH

public static final int DISABLED_SCRIPT_PREFIX_LENGTH

Constructor Details

ScriptLoader

public ScriptLoader()

Method Details

getScript

@Nullable
public static @Nullable Script getScript(File file)

Searches through the loaded scripts to find the script loaded from the provided file.

Parameters:

file - The file containing the script to find. Must not be a directory.

Returns:

The script loaded from the provided file, or null if no script was found.

getScripts

public static Set<Script> getScripts(File directory)

Searches through the loaded scripts to find all scripts loaded from the files contained within the provided directory.

Parameters:

directory - The directory containing scripts to find.

Returns:

The scripts loaded from the files of the provided directory. Empty if no scripts were found.

isAsync

public static boolean isAsync()

Checks if scripts are loaded in separate thread. If true, following behavior should be expected:

• Scripts are still unloaded and enabled in server thread
• When reloading a script, old version is unloaded after it has been parsed, immediately before it has been loaded
• When reloading all scripts, scripts that were removed are disabled after everything has been reloaded
• Script infos returned by most methods are inaccurate

Returns:

If main thread is not blocked when loading.

isParallel

public static boolean isParallel()

Checks if scripts are loaded in multiple threads instead of one thread. If true, isAsync() will also be true.

Returns:

if parallel loading is enabled.

setAsyncLoaderSize

public static void setAsyncLoaderSize(int size)
                               throws IllegalStateException

Sets the amount of async loaders, by updating asyncLoaderSize and loaderThreads.
If size <= 0, async and parallel loading are disabled.
If size == 1, async loading is enabled but parallel loading is disabled.
If size >= 2, async and parallel loading are enabled.

Parameters:

size - the amount of async loaders to use.

Throws:

IllegalStateException

loadScripts

public static CompletableFuture<ScriptLoader.ScriptInfo> loadScripts(File file,
 OpenCloseable openCloseable)

Loads the Script present at the file using loadScripts(List, OpenCloseable), sending info/error messages when done.

Parameters:

file - The file to load. If this is a directory, all scripts within the directory and any subdirectories will be loaded.

openCloseable - An OpenCloseable that will be called before and after each individual script load (see makeFuture(Supplier, OpenCloseable)).

loadScripts

public static CompletableFuture<ScriptLoader.ScriptInfo> loadScripts(Set<File> files,
 OpenCloseable openCloseable)

Loads the Scripts present at the files using loadScripts(List, OpenCloseable), sending info/error messages when done.

Parameters:

files - The files to load. If any file is a directory, all scripts within the directory and any subdirectories will be loaded.

openCloseable - An OpenCloseable that will be called before and after each individual script load (see makeFuture(Supplier, OpenCloseable)).

unloadScripts

public static ScriptLoader.ScriptInfo unloadScripts(Set<Script> scripts)

Unloads all scripts present in the provided collection.

Parameters:

scripts - The scripts to unload.

Returns:

Combined statistics for the unloaded scripts. This data is calculated by using ScriptLoader.ScriptInfo.add(ScriptInfo).

unloadScript

public static ScriptLoader.ScriptInfo unloadScript(Script script)

Unloads the provided script.

Parameters:

script - The script to unload.

Returns:

Statistics for the unloaded script.

reloadScript

public static CompletableFuture<ScriptLoader.ScriptInfo> reloadScript(Script script,
 OpenCloseable openCloseable)

Reloads a single Script.

Parameters:

script - The Script to reload.

Returns:

Info on the loaded Script.

reloadScripts

public static CompletableFuture<ScriptLoader.ScriptInfo> reloadScripts(Set<Script> scripts,
 OpenCloseable openCloseable)

Reloads all provided Scripts.

Parameters:

scripts - The Scripts to reload.

openCloseable - An OpenCloseable that will be called before and after each individual Script load (see makeFuture(Supplier, OpenCloseable)).

Returns:

Info on the loaded Scripts.

replaceOptions

public static String replaceOptions(String string)

Replaces options in a string. Options are obtained from a Script's StructOptions.OptionsData. Example: script.getData(OptionsData.class)

loadItems

public static ArrayList<TriggerItem> loadItems(SectionNode node)

Loads a section by converting it to TriggerItems.

getLoadedScripts

public static Set<Script> getLoadedScripts()

Returns:

An unmodifiable set containing a snapshot of the currently loaded scripts. Any changes to loaded scripts will not be reflected in the returned set.

getDisabledScripts

public static Set<File> getDisabledScripts()

Returns:

An unmodifiable set containing a snapshot of the currently disabled scripts. Any changes to disabled scripts will not be reflected in the returned set.

getLoadedScriptsFilter

public static FileFilter getLoadedScriptsFilter()

Returns:

A FileFilter defining the naming conditions of a loaded script.

getDisabledScriptsFilter

public static FileFilter getDisabledScriptsFilter()

Returns:

A FileFilter defining the naming conditions of a disabled script.

eventRegistry

public static EventRegistry<ScriptLoader.LoaderEvent> eventRegistry()

Returns:

An EventRegistry for the ScriptLoader's events.

unloadScript

@Deprecated
public static ScriptLoader.ScriptInfo unloadScript(File scriptFile)

Deprecated.

Use unloadScript(Script).

Unloads the provided script.

Parameters:

scriptFile - The file representing the script to unload.

Returns:

Statistics for the unloaded script.

reloadScript

@Deprecated
public static CompletableFuture<ScriptLoader.ScriptInfo> reloadScript(File scriptFile,
 OpenCloseable openCloseable)

Deprecated.

Use reloadScript(Script, OpenCloseable).

Reloads a single script.

Parameters:

scriptFile - The file representing the script to reload.

Returns:

Future of statistics of the newly loaded script.

reloadScripts

@Deprecated
public static CompletableFuture<ScriptLoader.ScriptInfo> reloadScripts(File folder,
 OpenCloseable openCloseable)

Deprecated.

Use reloadScripts(java.util.Set<org.skriptlang.skript.lang.script.Script>, ch.njol.util.OpenCloseable).

Reloads all scripts in the given folder and its subfolders.

Parameters:

folder - A folder.

Returns:

Future of statistics of newly loaded scripts.

loadedScripts

@Deprecated
public static int loadedScripts()

Deprecated.

Use getLoadedScripts().size().

loadedTriggers

@Deprecated
public static int loadedTriggers()

Deprecated.

Use getLoadedScripts() and Script.getStructures().size(). Please note that a Structure may have multiple triggers, and this is only an estimate.

loadScripts

@Deprecated
public static ScriptLoader.ScriptInfo loadScripts(List<Config> configs)

Deprecated.

Callers should not be using configs. Use loadScripts(Set, OpenCloseable).

loadScripts

@Deprecated
public static ScriptLoader.ScriptInfo loadScripts(List<Config> configs,
 List<LogEntry> logOut)

Deprecated.

Callers should not be using configs. Use loadScripts(Set, OpenCloseable).

See Also:

• RetainingLogHandler

loadScripts

@Deprecated
public static ScriptLoader.ScriptInfo loadScripts(Config... configs)

Deprecated.

Callers should not be using configs. Use loadScripts(Set, OpenCloseable).

reloadScript

@Deprecated
public static ScriptLoader.ScriptInfo reloadScript(File script)

Deprecated.

Use reloadScript(Script, OpenCloseable).

reloadScripts

@Deprecated
public static ScriptLoader.ScriptInfo reloadScripts(File folder)

Deprecated.

Use reloadScripts(Set, OpenCloseable).

getHasDelayBefore

@Deprecated
public static Kleenean getHasDelayBefore()

Deprecated.

Use ParserInstance.getHasDelayBefore().

setHasDelayBefore

@Deprecated
public static void setHasDelayBefore(Kleenean hasDelayBefore)

Deprecated.

Use ParserInstance.setHasDelayBefore(Kleenean).

getCurrentScript

@Nullable
@Deprecated
public static @Nullable Config getCurrentScript()

Deprecated.

Use ParserInstance.getCurrentScript().

setCurrentScript

@Deprecated
public static void setCurrentScript(@Nullable
 @Nullable Config currentScript)

Deprecated.

Addons should no longer be modifying this.

getCurrentSections

@Deprecated
public static List<TriggerSection> getCurrentSections()

Deprecated.

Use ParserInstance.getCurrentSections().

setCurrentSections

@Deprecated
public static void setCurrentSections(List<TriggerSection> currentSections)

Deprecated.

Use ParserInstance.setCurrentSections(List).

getCurrentLoops

@Deprecated
public static List<ch.njol.skript.sections.SecLoop> getCurrentLoops()

Deprecated.

Use ParserInstance.getCurrentSections(Class).

setCurrentLoops

@Deprecated
public static void setCurrentLoops(List<ch.njol.skript.sections.SecLoop> currentLoops)

Deprecated.

Never use this method, it has no effect.

getCurrentEventName

@Nullable
@Deprecated
public static @Nullable String getCurrentEventName()

Deprecated.

Use ParserInstance.getCurrentEventName().

setCurrentEvent

@SafeVarargs
@Deprecated
public static void setCurrentEvent(String name,
 @Nullable
 @Nullable Class<? extends Event>... events)

Deprecated.

Use ParserInstance.setCurrentEvent(String, Class[]).

deleteCurrentEvent

@Deprecated
public static void deleteCurrentEvent()

Deprecated.

Use ParserInstance.deleteCurrentEvent().

isCurrentEvent

@Deprecated
public static boolean isCurrentEvent(@Nullable
 @Nullable Class<? extends Event> event)

Deprecated.

Use ParserInstance.isCurrentEvent(Class)

isCurrentEvent

@SafeVarargs
@Deprecated
public static boolean isCurrentEvent(Class<? extends Event>... events)

Deprecated.

Use ParserInstance.isCurrentEvent(Class[]).

getCurrentEvents

@Nullable
@Deprecated
public static @Nullable Class<? extends Event>[] getCurrentEvents()

Deprecated.

Use ParserInstance.getCurrentEvents().

loadStructure

@Deprecated
public static Config loadStructure(Config config)

Deprecated.

This method has no functionality, it just returns its input.