Package ch.njol.skript.effects

Class EffExit

java.lang.Object

ch.njol.skript.lang.TriggerItem

ch.njol.skript.lang.Statement

ch.njol.skript.lang.Effect

ch.njol.skript.effects.EffExit

All Implemented Interfaces:

Debuggable, SyntaxElement

@Name("Exit")
@Description("Exits a given amount of loops and conditionals, or the entire trigger.")
@Examples({"if player has any ore:","\tstop","message \"%player% has no ores!\"","loop blocks above the player:","\tloop-block is not air:","\t\texit 2 sections","\tset loop-block to water"})
@Since("<i>unknown</i> (before 2.1)")
public class EffExit
extends Effect

Field Summary

Fields inherited from class ch.njol.skript.lang.TriggerItem

parent

Constructor Summary

Constructors

Constructor	Description
EffExit()

Method Summary

Modifier and Type	Method	Description
protected void	execute(org.bukkit.event.Event e)	Executes this effect.
boolean	init(Expression<?>[] exprs, int matchedPattern, Kleenean isDelayed, SkriptParser.ParseResult parser)	Called just after the constructor.
String	toString(@Nullable org.bukkit.event.Event e, boolean debug)
protected @Nullable TriggerItem	walk(org.bukkit.event.Event e)	Executes this item and returns the next item to run.

Methods inherited from class ch.njol.skript.lang.Effect

parse, run

Methods inherited from class ch.njol.skript.lang.TriggerItem

debug, getIndentation, getNext, getParent, getTrigger, setNext, setParent, toString, walk

Methods inherited from class java.lang.Object

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

Methods inherited from interface ch.njol.skript.lang.SyntaxElement

getParser

Constructor Details

EffExit

public EffExit()

Method Details

init

public boolean init(Expression<?>[] exprs,
 int matchedPattern,
 Kleenean isDelayed,
 SkriptParser.ParseResult parser)

Description copied from interface: SyntaxElement

Called just after the constructor.

Parameters:

exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out it will still be included in this list holding the default value of the desired type which usually depends on the event.

matchedPattern - The index of the pattern which matched

isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)

parser - Additional information about the match.

Returns:

Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.

See Also:

ParserInstance.isCurrentEvent(Class...)

walk

protected @Nullable TriggerItem walk(org.bukkit.event.Event e)

Description copied from class: TriggerItem

Executes this item and returns the next item to run.

Overriding classes must call TriggerItem.debug(Event, boolean). If this method is overridden, TriggerItem.run(Event) is not used anymore and can be ignored.

Overrides:

walk in class TriggerItem

Returns:

The next item to run or null to stop execution

execute

protected void execute(org.bukkit.event.Event e)

Description copied from class: Effect

Executes this effect.

Specified by:

execute in class Effect

toString

public String toString(@Nullable org.bukkit.event.Event e,
 boolean debug)

Parameters:

e - The event to get information to. This is always null if debug == false.

debug - If true this should print more information, if false this should print what is shown to the end user

Returns:

String representation of this object