Package ch.njol.skript.effects

Class EffCancelCooldown

java.lang.Object

ch.njol.skript.lang.TriggerItem

ch.njol.skript.lang.Statement

ch.njol.skript.lang.Effect

ch.njol.skript.effects.EffCancelCooldown

All Implemented Interfaces:

Debuggable, SyntaxElement

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

Field Summary

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

parent

Constructor Summary

Constructors

Constructor	Description
EffCancelCooldown()

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 parseResult)	Called just after the constructor.
String	toString(@Nullable org.bukkit.event.Event e, boolean debug)

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

EffCancelCooldown

public EffCancelCooldown()

Method Details

init

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

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)

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

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