Class EffCancelCooldown

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.EffCancelCooldown

All Implemented Interfaces:

Debuggable, EventRestrictedSyntax, SyntaxElement, RuntimeErrorProducer, SyntaxRuntimeErrorProducer

@Name("Cancel Command Cooldown")
@Description("Only usable in commands. Makes it so the current command usage isn't counted towards the cooldown.")
@Example("command /nick <text>:\n\texecutable by: players\n\tcooldown: 10 seconds\n\ttrigger:\n\t\tif length of arg-1 is more than 16:\n\t\t\t# Makes it so that invalid arguments don't make you wait for the cooldown again\n\t\t\tcancel the cooldown\n\t\t\tsend \"Your nickname may be at most 16 characters.\"\n\t\t\tstop\n\t\tset the player's display name to arg-1\n")
@Since("2.2-dev34")
public class EffCancelCooldown
extends Effect
implements EventRestrictedSyntax

Field Summary

Fields inherited from class TriggerItem

parent

Constructor Summary

Constructors

Constructor	Description
EffCancelCooldown()

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)

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, 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

EffCancelCooldown

public EffCancelCooldown()

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

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