Package ch.njol.skript.lang

Class Effect

java.lang.Object

ch.njol.skript.lang.TriggerItem

ch.njol.skript.lang.Statement

ch.njol.skript.lang.Effect

All Implemented Interfaces:

Debuggable, SyntaxElement

Direct Known Subclasses:

AsyncEffect, EffectSectionEffect

public abstract class Effect
extends Statement

An effect which is unconditionally executed when reached, and execution will usually continue with the next item of the trigger after this effect is executed (the stop effect for example stops the trigger, i.e. nothing else will be executed after it)

See Also:

• Skript.registerEffect(Class, String...)

Field Summary

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

parent

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Effect()

Method Summary

Modifier and Type	Method	Description
protected abstract void	execute(Event event)	Executes this effect.
static @Nullable Effect	parse(String input, @Nullable String defaultError)
final boolean	run(Event event)	Executes this item.

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

parse, parse

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

toString

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

getParser, init

Constructor Details

Effect

protected Effect()

Method Details

execute

protected abstract void execute(Event event)

Executes this effect.

Parameters:

event - The event with which this effect will be executed

run

public final boolean run(Event event)

Description copied from class: TriggerItem

Executes this item.

Specified by:

run in class TriggerItem

Parameters:

event - The event to run this item with

Returns:

True if the next item should be run, or false for the item following this item's parent.

parse

@Nullable
public static @Nullable Effect parse(String input,
 @Nullable
 @Nullable String defaultError)