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 class	ScriptLoader.ScriptInfo	A class for keeping track of a the general content of a script: The amount of files The amount of triggers The amount of commands The amount of functions The names of the declared commands

Constructor Summary

Constructors

Constructor	Description
ScriptLoader()

Method Summary

Modifier and Type	Method	Description
static void	deleteCurrentEvent()	Deprecated.
static @Nullable String	getCurrentEventName()	Deprecated.
static @Nullable Class<? extends org.bukkit.event.Event>[]	getCurrentEvents()	Deprecated.
static List<SecLoop>	getCurrentLoops()	Deprecated.
static @Nullable Config	getCurrentScript()	Deprecated.
static List<TriggerSection>	getCurrentSections()	Deprecated.
static Collection<File>	getDisabledFiles()
static Kleenean	getHasDelayBefore()	Deprecated.
static Collection<File>	getLoadedFiles()
static boolean	isAsync()	Checks if scripts are loaded in separate thread.
static boolean	isCurrentEvent(@Nullable Class<? extends org.bukkit.event.Event> event)	Deprecated.
static boolean	isCurrentEvent(Class<? extends org.bukkit.event.Event>... events)	Deprecated.
static boolean	isParallel()	Checks if scripts are loaded in multiple threads instead of one thread.
static int	loadedCommands()
static int	loadedFunctions()
static int	loadedScripts()
static int	loadedTriggers()
static ArrayList<TriggerItem>	loadItems(SectionNode node)	Loads a section by converting it to TriggerItems.
static ScriptLoader.ScriptInfo	loadScripts(Config... configs)	Deprecated.
static ScriptLoader.ScriptInfo	loadScripts(List<Config> configs)	Deprecated.
static CompletableFuture<ScriptLoader.ScriptInfo>	loadScripts(List<Config> configs, OpenCloseable openCloseable)	Loads the specified scripts.
static ScriptLoader.ScriptInfo	loadScripts(List<Config> configs, List<LogEntry> logOut)	Deprecated.
static @Nullable Config	loadStructure(Config config)	Loads structure of given script, currently only for functions.
static @Nullable Config	loadStructure(File f)	Loads structure of given script, currently only for functions.
static @Nullable Config	loadStructure(InputStream source, String name)	Loads structure of given script, currently only for functions.
static List<Config>	loadStructures(File directory)	Loads structures of all scripts in the given directory, or of the passed script if it's a normal file.
static List<Config>	loadStructures(File[] files)	Loads structures of specified scripts.
static ScriptLoader.ScriptInfo	reloadScript(File script)	Deprecated.
static CompletableFuture<ScriptLoader.ScriptInfo>	reloadScript(File script, OpenCloseable openCloseable)	Reloads a single script.
static ScriptLoader.ScriptInfo	reloadScripts(File folder)	Deprecated.
static CompletableFuture<ScriptLoader.ScriptInfo>	reloadScripts(File folder, OpenCloseable openCloseable)	Reloads all scripts in the given folder and its subfolders.
static String	replaceOptions(String s)	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 org.bukkit.event.Event>... events)	Deprecated.
static void	setCurrentLoops(List<SecLoop> currentLoops)	Deprecated.
static void	setCurrentScript(@Nullable Config currentScript)	Deprecated.
static void	setCurrentSections(List<TriggerSection> currentSections)	Deprecated.
static void	setHasDelayBefore(Kleenean hasDelayBefore)	Deprecated.
static ScriptLoader.ScriptInfo	unloadScript(File script)	Unloads the specified script.

Methods inherited from class java.lang.Object

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

Constructor Details

ScriptLoader

public ScriptLoader()

Method Details

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(List<Config> configs,
 OpenCloseable openCloseable)

Loads the specified scripts.

Parameters:

configs - Configs for scripts, loaded by loadStructures(File[])

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

Returns:

Info on the loaded scripts.

loadStructures

public static List<Config> loadStructures(File[] files)

Loads structures of specified scripts.

Parameters:

files - the scripts to load

loadStructures

public static List<Config> loadStructures(File directory)

Loads structures of all scripts in the given directory, or of the passed script if it's a normal file.

Parameters:

directory - a directory or a single file

loadStructure

public static @Nullable Config loadStructure(File f)

Loads structure of given script, currently only for functions. Must be called before actually loading that script.

Parameters:

f - Script file.

loadStructure

public static @Nullable Config loadStructure(InputStream source,
 String name)

Loads structure of given script, currently only for functions. Must be called before actually loading that script.

Parameters:

source - Source input stream.

name - Name of source "file".

loadStructure

public static @Nullable Config loadStructure(Config config)

Loads structure of given script, currently only for functions. Must be called before actually loading that script.

Parameters:

config - Config object for the script.

unloadScript

public static ScriptLoader.ScriptInfo unloadScript(File script)

Unloads the specified script.

Parameters:

script -

Returns:

Info on the unloaded script

reloadScript

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

Reloads a single script.

Parameters:

script - Script file.

Returns:

Future of statistics of the newly loaded script.

reloadScripts

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

Reloads all scripts in the given folder and its subfolders.

Parameters:

folder - A folder.

Returns:

Future of statistics of newly loaded scripts.

replaceOptions

public static String replaceOptions(String s)

Replaces options in a string.

loadItems

public static ArrayList<TriggerItem> loadItems(SectionNode node)

Loads a section by converting it to TriggerItems.

getLoadedFiles

public static Collection<File> getLoadedFiles()

getDisabledFiles

public static Collection<File> getDisabledFiles()

loadedScripts

public static int loadedScripts()

loadedCommands

public static int loadedCommands()

loadedFunctions

public static int loadedFunctions()

loadedTriggers

public static int loadedTriggers()

loadScripts

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

Deprecated.

See Also:

loadScripts(List, OpenCloseable)

loadScripts

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

Deprecated.

See Also:

loadScripts(List, OpenCloseable), RetainingLogHandler

loadScripts

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

Deprecated.

See Also:

loadScripts(List, OpenCloseable)

reloadScript

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

Deprecated.

See Also:

reloadScript(File, OpenCloseable)

reloadScripts

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

Deprecated.

See Also:

reloadScripts(File, OpenCloseable)

getHasDelayBefore

@Deprecated
public static Kleenean getHasDelayBefore()

Deprecated.

See Also:

ParserInstance.getHasDelayBefore()

setHasDelayBefore

@Deprecated
public static void setHasDelayBefore(Kleenean hasDelayBefore)

Deprecated.

See Also:

ParserInstance.setHasDelayBefore(Kleenean)

getCurrentScript

@Deprecated
public static @Nullable Config getCurrentScript()

Deprecated.

See Also:

ParserInstance.getCurrentScript()

setCurrentScript

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

Deprecated.

See Also:

ParserInstance.setCurrentScript(Config)

getCurrentSections

@Deprecated
public static List<TriggerSection> getCurrentSections()

Deprecated.

See Also:

ParserInstance.getCurrentSections()

setCurrentSections

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

Deprecated.

See Also:

ParserInstance.setCurrentSections(List)

getCurrentLoops

@Deprecated
public static List<SecLoop> getCurrentLoops()

Deprecated.

See Also:

ParserInstance.getCurrentSections(Class)

setCurrentLoops

@Deprecated
public static void setCurrentLoops(List<SecLoop> currentLoops)

Deprecated.

Never use this method, it has no effect.

getCurrentEventName

@Deprecated
public static @Nullable String getCurrentEventName()

Deprecated.

See Also:

ParserInstance.getCurrentEventName()

setCurrentEvent

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

Deprecated.

See Also:

ParserInstance.setCurrentEvent(String, Class[])

deleteCurrentEvent

@Deprecated
public static void deleteCurrentEvent()

Deprecated.

See Also:

ParserInstance.deleteCurrentEvent()

isCurrentEvent

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

Deprecated.

See Also:

ParserInstance.isCurrentEvent(Class)

isCurrentEvent

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

Deprecated.

See Also:

ParserInstance.isCurrentEvent(Class[])

getCurrentEvents

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

Deprecated.

See Also:

ParserInstance.getCurrentEvents()