Package com.blamejared.crafttweaker.impl.script.scriptrun

Class ScriptRunManager

java.lang.Object

com.blamejared.crafttweaker.impl.script.scriptrun.ScriptRunManager

All Implemented Interfaces:

IScriptRunManager

public final class ScriptRunManager
extends Object
implements IScriptRunManager

Method Summary

Modifier and Type	Method	Description
void	applyAction(IAction action)	Applies the given action.
IScriptRun	createScriptRun(ScriptRunConfiguration configuration)	Creates an IScriptRun with the specified ScriptRunConfiguration.
IScriptRun	createScriptRun(Path root, ScriptDiscoveryConfiguration discoveryConfiguration, ScriptRunConfiguration runConfiguration)	Creates an IScriptRun with the specified ScriptRunConfiguration executing all valid scripts discovered according to the given ScriptDiscoveryConfiguration from the given root.
IScriptRun	createScriptRun(Path root, ScriptRunConfiguration configuration)	Creates an IScriptRun with the specified ScriptRunConfiguration executing all valid scripts from the given root.
IScriptRun	createScriptRun(Path root, List<Path> files, ScriptRunConfiguration configuration)	Creates an IScriptRun with the specified ScriptRunConfiguration executing the script files in the files list.
IScriptRun	createScriptRun(List<SourceFile> sources, ScriptRunConfiguration configuration)	Creates an IScriptRun with the specified ScriptRunConfiguration executing the given ZenCode SourceFiles.
IScriptRunInfo	currentRunInfo()	Obtains the IScriptRunInfo of the currently executing IScriptRun, if any.
static ScriptRunManager	get()

Methods inherited from class java.lang.Object

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

Method Details

get

public static ScriptRunManager get()

createScriptRun

public IScriptRun createScriptRun(ScriptRunConfiguration configuration)

Description copied from interface: IScriptRunManager

Creates an IScriptRun with the specified ScriptRunConfiguration.

The script run will execute all scripts that are present in the default scripts directory. In this instance, a valid script file is identified by a Path whose BasicFileAttributes report a regular file and whose file name ends with .zs.

During the discovery phase, any file with a suspicious name will raise a warning in the logs.

Specified by:

createScriptRun in interface IScriptRunManager

Parameters:

configuration - The configuration of the script run.

Returns:

A script run that carries out the specified operations.

createScriptRun

public IScriptRun createScriptRun(Path root,
 ScriptRunConfiguration configuration)

Description copied from interface: IScriptRunManager

Creates an IScriptRun with the specified ScriptRunConfiguration executing all valid scripts from the given root.

In this instance, a valid script file is identified by a Path whose BasicFileAttributes report a regular file and whose file name ends with .zs.

During the discovery phase, any file with a suspicious name will raise a warning in the logs.

Specified by:

createScriptRun in interface IScriptRunManager

Parameters:

root - The root Path from which CraftTweaker should look for scripts.

configuration - The configuration of the script run.

Returns:

A script run that carries out the specified operations.

createScriptRun

public IScriptRun createScriptRun(Path root,
 ScriptDiscoveryConfiguration discoveryConfiguration,
 ScriptRunConfiguration runConfiguration)

Description copied from interface: IScriptRunManager

Creates an IScriptRun with the specified ScriptRunConfiguration executing all valid scripts discovered according to the given ScriptDiscoveryConfiguration from the given root.

In this instance, a valid script file is identified by a Path whose BasicFileAttributes report a regular file and whose file name ends with .zs.

Specified by:

createScriptRun in interface IScriptRunManager

Parameters:

root - The root Path from which CraftTweaker should look for scripts.

discoveryConfiguration - The configuration for the discovery process.

runConfiguration - The configuration of the script run.

Returns:

A script run that carries out the specified operations.

createScriptRun

public IScriptRun createScriptRun(Path root,
 List<Path> files,
 ScriptRunConfiguration configuration)

Description copied from interface: IScriptRunManager

Creates an IScriptRun with the specified ScriptRunConfiguration executing the script files in the files list.

In this instance, all Paths given in files are assumed to be valid files. The path given as root, on the other hand, is used to properly identify the name of the script file for the ZenCode scripting environment. For this reason, it is mandatory for root to be a valid parent of all files listed in the files list.

Specified by:

createScriptRun in interface IScriptRunManager

Parameters:

root - The root which contains all files listed in files.

files - The files that CraftTweaker should execute in the script run.

configuration - The configuration of the script run.

Returns:

A script run that carries out the specified operations.

createScriptRun

public IScriptRun createScriptRun(List<SourceFile> sources,
 ScriptRunConfiguration configuration)

Description copied from interface: IScriptRunManager

Creates an IScriptRun with the specified ScriptRunConfiguration executing the given ZenCode SourceFiles.

No restrictions are imposed on the type of the source files given.

Specified by:

createScriptRun in interface IScriptRunManager

Parameters:

sources - The source files to execute in the script run.

configuration - The configuration of the script run.

Returns:

A script run that carries out the specified operations.

currentRunInfo

public IScriptRunInfo currentRunInfo()

Description copied from interface: IScriptRunManager

Obtains the IScriptRunInfo of the currently executing IScriptRun, if any.

If no script run is currently executing, a NullPointerException is thrown instead. It is the caller's responsibility to verify that this method can only ever be called during a script run execution.

A script run is considered executing only when its IScriptRun.execute() method is operating.

To get information for a specific script run, consider using IScriptRun.specificRunInfo() instead.

Specified by:

currentRunInfo in interface IScriptRunManager

Returns:

The information for the currently executing script run, if any.

applyAction

public void applyAction(IAction action)

Description copied from interface: IScriptRunManager

Applies the given action.

Application of the action requires an IScriptRun to be currently executing. Attempting to apply an action outside of a script run will result in an IllegalStateException being thrown.

Specified by:

applyAction in interface IScriptRunManager

Parameters:

action - The action to apply.