Class EffFailExecution

java.lang.Object

ch.njol.skript.lang.TriggerItem

ch.njol.skript.lang.Statement

ch.njol.skript.lang.Effect

org.skriptlang.skript.bukkit.command.elements.effects.EffFailExecution

All Implemented Interfaces:

Debuggable, EventRestrictedSyntax, SyntaxElement, RuntimeErrorProducer, SyntaxRuntimeErrorProducer

@Name("Fail Command Execution")
@Description("Causes a command to fail execution with an error message displayed to the executor.")
@Example("command /withdraw <number>:\n\ttrigger:\n\t\tif the number argument is greater than the player's balance:\n\t\t\tfail the command execution with the error message \"Your balance is less than $%number argument%!\"\n")
@Since("2.17")
public class EffFailExecution
extends Effect
implements EventRestrictedSyntax

Field Summary

Fields inherited from class TriggerItem

parent

Constructor Summary

Constructors

Constructor	Description
EffFailExecution()

Method Summary

Modifier and Type	Method	Description
protected void	execute(org.bukkit.event.Event event)	Executes this effect.
boolean	init(Expression<?>[] exprs, int matchedPattern, Kleenean isDelayed, SkriptParser.ParseResult parseResult)	Called just after the constructor and SyntaxElement.preInit().
static void	register(SyntaxRegistry syntaxRegistry)
Class<? extends org.bukkit.event.Event>[]	supportedEvents()	Returns all supported events for this syntax element.
String	toString(@Nullable org.bukkit.event.Event event, boolean debug)
protected @Nullable TriggerItem	walk(org.bukkit.event.Event event)	Executes this item and returns the next item to run.

Methods inherited from class Effect

getNode, getSyntaxTypeName, parse, preInit, run

Methods inherited from class Statement

parse, parse

Methods inherited from class TriggerItem

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

Methods inherited from class Object

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

Methods inherited from interface RuntimeErrorProducer

error, error, getRuntimeErrorManager, warning, warning

Methods inherited from interface SyntaxElement

getParser

Methods inherited from interface SyntaxRuntimeErrorProducer

getErrorSource

Constructor Details

EffFailExecution

public EffFailExecution()

Method Details

register

public static void register(SyntaxRegistry syntaxRegistry)

init

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

Description copied from interface: SyntaxElement

Called just after the constructor and SyntaxElement.preInit().

Specified by:

init in interface SyntaxElement

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)

parseResult - 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...)

supportedEvents

public Class<? extends org.bukkit.event.Event>[] supportedEvents()

Description copied from interface: EventRestrictedSyntax

Returns all supported events for this syntax element.

Before SyntaxElement.init(Expression[], int, Kleenean, SkriptParser.ParseResult) is called, checks to see if the current event is supported by this syntax element. If it is not, an error will be printed and the syntax element will not be initialised.

Specified by:

supportedEvents in interface EventRestrictedSyntax

Returns:

All supported event classes.

See Also:

• CollectionUtils.array(Object[])

execute

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

Description copied from class: Effect

Executes this effect.

Specified by:

execute in class Effect

Parameters:

event - The event with which this effect will be executed

walk

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

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

Parameters:

event - The event

Returns:

The next item to run or null to stop execution

toString

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

Specified by:

toString in interface Debuggable

Parameters:

event - The event to get information from. 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