Package ch.njol.skript.lang

Class LoopSection

java.lang.Object

ch.njol.skript.lang.TriggerItem

ch.njol.skript.lang.TriggerSection

ch.njol.skript.lang.Section

ch.njol.skript.lang.LoopSection

All Implemented Interfaces:

Debuggable, SectionExitHandler, SyntaxElement, RuntimeErrorProducer, SyntaxRuntimeErrorProducer

public abstract class LoopSection
extends Section
implements SyntaxElement, Debuggable, SectionExitHandler

Represents a loop section.

See Also:

• SecWhile
• SecLoop

Nested Class Summary

Nested classes/interfaces inherited from class ch.njol.skript.lang.Section

Section.SectionContext

Field Summary

Fields

Modifier and Type	Field	Description
protected final Map<org.bukkit.event.Event,Long>	currentLoopCounter

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

first, last

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

parent

Constructor Summary

Constructors

Constructor	Description
LoopSection()

Method Summary

Modifier and Type	Method	Description
void	exit(org.bukkit.event.Event event)	Exit the loop, used to reset the loop properties such as iterations counter
abstract TriggerItem	getActualNext()	This method guarantees to return next TriggerItem after this item.
long	getLoopCounter(org.bukkit.event.Event event)

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

getNode, getSyntaxTypeName, init, init, loadCode, loadCode, loadCode, loadCode, loadOptionalCode, parse, preInit

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

run, setNext, setParent, setTriggerItems, triggerExecutionIntent, walk, walk

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

debug, executionIntent, getIndentation, getNext, getParent, getTrigger, toString, 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, toString

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, getSyntaxTypeName, init, preInit

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

getErrorSource

Field Details

currentLoopCounter

protected final transient Map<org.bukkit.event.Event,Long> currentLoopCounter

Constructor Details

LoopSection

public LoopSection()

Method Details

getLoopCounter

public long getLoopCounter(org.bukkit.event.Event event)

Parameters:

event - The event where the loop is used to return its loop iterations

Returns:

The loop iteration number

getActualNext

public abstract TriggerItem getActualNext()

Description copied from class: TriggerItem

This method guarantees to return next TriggerItem after this item. This is not always the case for TriggerItem.getNext(), for example, getNext() of a loop section usually returns itself.

Overrides:

getActualNext in class TriggerItem

Returns:

The next TriggerItem after the loop

exit

public void exit(org.bukkit.event.Event event)

Exit the loop, used to reset the loop properties such as iterations counter

Specified by:

exit in interface SectionExitHandler

Parameters:

event - The event where the loop is used to reset its relevant properties