Package ch.njol.skript.lang

Class TriggerItem

java.lang.Object

ch.njol.skript.lang.TriggerItem

All Implemented Interfaces:

Debuggable

Direct Known Subclasses:

Statement, TriggerSection

public abstract class TriggerItem
extends Object
implements Debuggable

Represents a trigger item, i.e. a trigger section, a condition or an effect.

See Also:

TriggerSection, Trigger, Statement

Field Summary

Fields

Modifier and Type	Field	Description
protected @Nullable TriggerSection	parent

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TriggerItem()
protected	TriggerItem(TriggerSection parent)

Method Summary

Modifier and Type	Method	Description
protected void	debug(org.bukkit.event.Event e, boolean run)
String	getIndentation()
@Nullable TriggerItem	getNext()
@Nullable TriggerSection	getParent()
@Nullable Trigger	getTrigger()
protected abstract boolean	run(org.bukkit.event.Event e)	Executes this item.
TriggerItem	setNext(@Nullable TriggerItem next)
TriggerItem	setParent(@Nullable TriggerSection parent)
String	toString()	Should return toString(null, false)
static boolean	walk(TriggerItem start, org.bukkit.event.Event e)
protected @Nullable TriggerItem	walk(org.bukkit.event.Event e)	Executes this item and returns the next item to run.

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

Field Details

parent

protected @Nullable TriggerSection parent

Constructor Details

TriggerItem

protected TriggerItem()

TriggerItem

protected TriggerItem(TriggerSection parent)

Method Details

walk

protected @Nullable TriggerItem walk(org.bukkit.event.Event e)

Executes this item and returns the next item to run.

Overriding classes must call debug(Event, boolean). If this method is overridden, run(Event) is not used anymore and can be ignored.

Parameters:

e -

Returns:

The next item to run or null to stop execution

run

protected abstract boolean run(org.bukkit.event.Event e)

Executes this item.

Parameters:

e -

Returns:

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

walk

public static boolean walk(TriggerItem start,
 org.bukkit.event.Event e)

Parameters:

start -

e -

Returns:

false if an exception occurred

getIndentation

public String getIndentation()

debug

protected final void debug(org.bukkit.event.Event e,
 boolean run)

toString

public final String toString()

Description copied from interface: Debuggable

Should return toString(null, false)

Specified by:

toString in interface Debuggable

Overrides:

toString in class Object

setParent

public TriggerItem setParent(@Nullable TriggerSection parent)

getParent

public final @Nullable TriggerSection getParent()

getTrigger

public final @Nullable Trigger getTrigger()

Returns:

The trigger this item belongs to, or null if this is a stand-alone item (e.g. the effect of an effect command)

setNext

public TriggerItem setNext(@Nullable TriggerItem next)

getNext

public @Nullable TriggerItem getNext()