Package org.skriptlang.skript.bukkit.particles.elements.effects

Class EffPlayEffect

java.lang.Object

ch.njol.skript.lang.TriggerItem

ch.njol.skript.lang.Statement

ch.njol.skript.lang.Effect

org.skriptlang.skript.bukkit.particles.elements.effects.EffPlayEffect

All Implemented Interfaces:

Debuggable, SyntaxElement, RuntimeErrorProducer, SyntaxRuntimeErrorProducer

@Name("Play or Draw an Effect")
@Description("Plays or draws a specific effect at a location, to a player, or on an entity.\nEffects can be:\n* Particles.\n* Game effects, which consist of combinations of particles and sounds, like the bone meal particles, the sound of footsteps on a specific block, or the particles and sound of breaking a splash potion.\n* Entity effects, which are particles or animations that are entity-specific and can only be played on a compatible entity. For example, the ravager attack animation can be played with this effect.\n\nAll effects vary significantly in availability from version to version, and some may simply not function on your version of Minecraft. Some effects, like the death animation entity effect, may cause client glitches and should be used carefully!\n")
@Example("draw 2 smoke particles at player") @Example("force draw 10 red dust particles of size 3 for player") @Example("play blue instant splash potion break effect with a view radius of 10") @Example("play ravager attack animation on player\'s target")
public class EffPlayEffect
extends Effect

Field Summary

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

parent

Constructor Summary

Constructors

Constructor	Description
EffPlayEffect()

Method Summary

Modifier and Type	Method	Description
protected void	execute(org.bukkit.event.Event event)	Executes this effect.
Node	getNode()	Returns the source Node for any errors the implementing class emits.
boolean	init(Expression<?>[] expressions, int matchedPattern, Kleenean isDelayed, SkriptParser.ParseResult parseResult)	Called just after the constructor and SyntaxElement.preInit().
static void	register(@NotNull SyntaxRegistry registry, @NotNull Origin origin)
String	toString(@Nullable org.bukkit.event.Event event, boolean debug)

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

getSyntaxTypeName, parse, preInit, run

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

parse, parse

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

debug, executionIntent, getActualNext, 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 org.skriptlang.skript.log.runtime.RuntimeErrorProducer

error, error, getRuntimeErrorManager, warning, warning

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

getParser

Methods inherited from interface org.skriptlang.skript.log.runtime.SyntaxRuntimeErrorProducer

getErrorSource

Constructor Details

EffPlayEffect

public EffPlayEffect()

Method Details

register

public static void register(@NotNull
 @NotNull SyntaxRegistry registry,
 @NotNull
 @NotNull Origin origin)

init

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

Description copied from interface: SyntaxElement

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

Parameters:

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

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

getNode

public Node getNode()

Description copied from interface: SyntaxRuntimeErrorProducer

Returns the source Node for any errors the implementing class emits.
Used for accessing the line contents via Node.getKey() and the line number via Node.getLine().
A standard implementation is to store the Node during SyntaxElement.init(Expression[], int, Kleenean, SkriptParser.ParseResult) via ParserInstance.getNode().

Specified by:

getNode in interface SyntaxRuntimeErrorProducer

Overrides:

getNode in class Effect

Returns:

The source that produced a runtime error.