crafttweaker.runtime

Class ScriptFile

java.lang.Object

crafttweaker.runtime.ScriptFile

public class ScriptFile
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
ScriptFile(ITweaker tweaker, IScriptIterator script, boolean isSyntaxCommand)

Method Summary

Modifier and Type	Method and Description
boolean	add(IPreprocessor preprocessor) Delegates to the preprocessor List
boolean	addAll(java.util.Collection<? extends IPreprocessor> c)
boolean	areBracketErrorsIgnored() Change whether you want to have bracket errors show up for the specified file
java.util.List<IPreprocessor>	getAffectingPreprocessors()
java.lang.String	getEffectiveName() Gets the effective name that has every info in it that it can, like zip files don't use only the zip file name
java.lang.String	getGroupName() Group name is with relative path to the file or ZIP file name
java.lang.String	getLoaderName() Deprecated.
java.lang.String[]	getLoaderNames()
java.lang.String	getName() Actual name of the zs file
int	getPriority() Change the priority
IScriptIterator	getScript()
ITweaker	getTweaker() Gets the tweaker which handles the loading of the current file
boolean	isCompileBlocked()
boolean	isDebugEnabled() Change whether you want to enable debug mode for the specified file
boolean	isExecutionBlocked() Getters and setters which alter the loading of the code
boolean	isParsingBlocked()
boolean	isSyntaxCommand() Whether it is a by syntax command.
java.lang.String	loaderNamesConcatCapitalized() Compliant with the capitalization used in the name class generator
java.io.InputStream	open() Gives InputStream of the script, must be closed again or might cause problems down the line
void	setCompileBlocked(boolean compileBlocked)
void	setDebugEnabled(boolean debugEnabled)
void	setExecutionBlocked(boolean executionBlocked)
void	setIgnoreBracketErrors(boolean ignoreBracketErrors)
void	setLoaderName(java.lang.String loaderName) Deprecated.
void	setLoaderNames(java.lang.String... loaderNames) Change the loader names to change whether it should be loaded or not
void	setNetworkSide(NetworkSide networkSide) Registers the file to be only loaded on this network side
void	setParsingBlocked(boolean parsingBlocked)
void	setPriority(int priority)
boolean	shouldBeLoadedOn(NetworkSide proposedSide) Returns whether it should be loaded on the side it was asked to be loaded on
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ScriptFile

public ScriptFile(ITweaker tweaker,
                  IScriptIterator script,
                  boolean isSyntaxCommand)

Method Detail

getScript

public IScriptIterator getScript()

getGroupName

public java.lang.String getGroupName()

Group name is with relative path to the file or ZIP file name

getName

public java.lang.String getName()

Actual name of the zs file

getEffectiveName

public java.lang.String getEffectiveName()

Gets the effective name that has every info in it that it can, like zip files don't use only the zip file name

open

public java.io.InputStream open()
                         throws java.io.IOException

Gives InputStream of the script, must be closed again or might cause problems down the line

Returns:

Input stream of the file

Throws:

java.io.IOException

add

public boolean add(IPreprocessor preprocessor)

Delegates to the preprocessor List

addAll

public boolean addAll(java.util.Collection<? extends IPreprocessor> c)

getAffectingPreprocessors

public java.util.List<IPreprocessor> getAffectingPreprocessors()

getPriority

public int getPriority()

Change the priority

setPriority

public void setPriority(int priority)

getLoaderNames

public java.lang.String[] getLoaderNames()

setLoaderNames

public void setLoaderNames(java.lang.String... loaderNames)

Change the loader names to change whether it should be loaded or not

getLoaderName

@Deprecated
public java.lang.String getLoaderName()

Deprecated.

setLoaderName

@Deprecated
public void setLoaderName(java.lang.String loaderName)

Deprecated.

getTweaker

public ITweaker getTweaker()

Gets the tweaker which handles the loading of the current file

Returns:

ITweaker instance of the current tweaker

isExecutionBlocked

public boolean isExecutionBlocked()

Getters and setters which alter the loading of the code

setExecutionBlocked

public void setExecutionBlocked(boolean executionBlocked)

isParsingBlocked

public boolean isParsingBlocked()

setParsingBlocked

public void setParsingBlocked(boolean parsingBlocked)

isCompileBlocked

public boolean isCompileBlocked()

setCompileBlocked

public void setCompileBlocked(boolean compileBlocked)

isSyntaxCommand

public boolean isSyntaxCommand()

Whether it is a by syntax command. Syntax commands only load the script, but don't execute it

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

loaderNamesConcatCapitalized

public java.lang.String loaderNamesConcatCapitalized()

Compliant with the capitalization used in the name class generator

areBracketErrorsIgnored

public boolean areBracketErrorsIgnored()

Change whether you want to have bracket errors show up for the specified file

setIgnoreBracketErrors

public void setIgnoreBracketErrors(boolean ignoreBracketErrors)

isDebugEnabled

public boolean isDebugEnabled()

Change whether you want to enable debug mode for the specified file

setDebugEnabled

public void setDebugEnabled(boolean debugEnabled)

setNetworkSide

public void setNetworkSide(NetworkSide networkSide)

Registers the file to be only loaded on this network side

shouldBeLoadedOn

public boolean shouldBeLoadedOn(NetworkSide proposedSide)

Returns whether it should be loaded on the side it was asked to be loaded on