Package ch.njol.skript.effects

Class EffChange

java.lang.Object

ch.njol.skript.lang.TriggerItem

ch.njol.skript.lang.Statement

ch.njol.skript.lang.Effect

ch.njol.skript.effects.EffChange

All Implemented Interfaces:

Debuggable, SyntaxElement

@Name("Change: Set/Add/Remove/Delete/Reset")
@Description("A very general effect that can change many <a href=\'./expressions\'>expressions</a>. Many expressions can only be set and/or deleted, while some can have things added to or removed from them.")
@Examples({"# set:","Set the player\'s display name to \"&lt;red&gt;%name of player%\"","set the block above the victim to lava","# add:","add 2 to the player\'s health # preferably use \'<a href=\'#EffHealth\'>heal</a>\' for this","add argument to {blacklist::*}","give a diamond pickaxe of efficiency 5 to the player","increase the data value of the clicked block by 1","# remove:","remove 2 pickaxes from the victim","subtract 2.5 from {points::%uuid of player%}","# remove all:","remove every iron tool from the player","remove all minecarts from {entitylist::*}","# delete:","delete the block below the player","clear drops","delete {variable}","# reset:","reset walk speed of player","reset chunk at the targeted block"})
@Since("1.0 (set, add, remove, delete), 2.0 (remove all)")
public class EffChange
extends Effect

Field Summary

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

parent

Constructor Summary

Constructors

Constructor	Description
EffChange()

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)

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

EffChange

public EffChange()

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

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