Class EffExit

java.lang.Object

io.github.syst3ms.skriptparser.lang.Statement

io.github.syst3ms.skriptparser.lang.Effect

io.github.syst3ms.skriptparser.effects.EffExit

All Implemented Interfaces:

SyntaxElement

public class EffExit
extends Effect

Exits the entire trigger, preventing all upcoming statements to not get triggered. There's also a possibility to only exit certain sections. If more sections are exited than the total amount of nested sections, the trigger will stop. Note that stopping loops also stops while-loops.

Since:

ALPHA

Field Summary

Fields inherited from class Statement

next, parent

Constructor Summary

Constructors

Constructor	Description
EffExit()

Method Summary

Modifier and Type	Method	Description
protected void	execute(TriggerContext ctx)
boolean	init(Expression<?>[] expressions, int matchedPattern, ParseContext parseContext)	Initializes this SyntaxElement before being used.
String	toString(TriggerContext ctx, boolean debug)
Optional<? extends Statement>	walk(TriggerContext ctx)	By default, runs Statement.run(TriggerContext) ; returns Statement.getNext() if it returns true, or null otherwise.

Methods inherited from class Effect

run

Methods inherited from class Statement

getNext, getParent, runAll, setNext, setParent

Methods inherited from class Object

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

Constructor Details

EffExit

public EffExit()

Method Details

init

public boolean init(Expression<?>[] expressions,
 int matchedPattern,
 ParseContext parseContext)

Description copied from interface: SyntaxElement

Initializes this SyntaxElement before being used. This method is always called before all the others in an extending class, the only exception being CodeSection.loadSection(FileSection, ParserState, SkriptLogger).

Parameters:

expressions - an array of expressions representing all the expressions that are being passed to this syntax element. As opposed to Skript, elements of this array can't be null.

matchedPattern - the index of the pattern that was successfully matched. It corresponds to the order of the syntaxes in registration

parseContext - an object containing additional information about the parsing of this syntax element, like regex matches and parse marks

Returns:

true if the syntax element was initialized successfully, false otherwise.

See Also:

• SkriptRegistration
• ParseContext

execute

protected void execute(TriggerContext ctx)

Specified by:

execute in class Effect

walk

public Optional<? extends Statement> walk(TriggerContext ctx)

Description copied from class: Statement

By default, runs Statement.run(TriggerContext) ; returns Statement.getNext() if it returns true, or null otherwise. Note that if this method is overridden, then the implementation of Statement.run(TriggerContext) doesn't matter.

Overrides:

walk in class Statement

Parameters:

ctx - the event

Returns:

the next item to be ran, or null if this is the last item to be executed

toString

public String toString(TriggerContext ctx,
 boolean debug)

Parameters:

ctx - the event

debug - whether to show additional information or not

Returns:

a String that should aim to resemble what is written in the script as closely as possible