Package ch.njol.skript.expressions

Class ExprLoopValue

java.lang.Object

ch.njol.skript.lang.util.SimpleExpression<Object>

ch.njol.skript.expressions.ExprLoopValue

All Implemented Interfaces:

Debuggable, Expression<Object>, SyntaxElement

@Name("Loop value")
@Description("The currently looped value.")
@Examples({"# countdown:","loop 10 times:","\tmessage \"%11 - loop-number%\"","\twait a second","# generate a 10x10 floor made of randomly coloured wool below the player:","loop blocks from the block below the player to the block 10 east of the block below the player:","\tloop blocks from the loop-block to the block 10 north of the loop-block:","\t\tset loop-block-2 to any wool"})
@Since("1.0")
public class ExprLoopValue
extends SimpleExpression<Object>

Used to access a loop's current value.

TODO expression to get the current # of execution (e.g. loop-index/number/count/etc (not number though));

Constructor Summary

Constructors

Constructor	Description
ExprLoopValue()

Method Summary

Modifier and Type	Method	Description
protected @Nullable Object[]	get(org.bukkit.event.Event e)	This is the internal method to get an expression's values. To get the expression's value from the outside use SimpleExpression.getSingle(Event) or SimpleExpression.getArray(Event).
protected <R> @Nullable ConvertedExpression<Object,? extends R>	getConvertedExpr(Class<R>... to)	Converts this expression to another type.
Class<? extends Object>	getReturnType()	Gets the return type of this expression.
boolean	init(Expression<?>[] vars, int matchedPattern, Kleenean isDelayed, SkriptParser.ParseResult parser)	Called just after the constructor.
boolean	isSingle()
String	toString(@Nullable org.bukkit.event.Event e, boolean debug)

Methods inherited from class ch.njol.skript.lang.util.SimpleExpression

acceptChange, change, check, check, check, getAll, getAnd, getArray, getConvertedExpression, getSingle, getSource, getTime, isDefault, isLoopOf, iterator, setTime, setTime, setTime, setTime, simplify, toString

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

beforeChange, stream

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

getParser

Constructor Details

ExprLoopValue

public ExprLoopValue()

Method Details

init

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

Description copied from interface: SyntaxElement

Called just after the constructor.

Parameters:

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

isSingle

public boolean isSingle()

Returns:

true if this expression will ever only return one value at most, false if it can return multiple values.

getConvertedExpr

protected <R>
@Nullable ConvertedExpression<Object,? extends R> getConvertedExpr(Class<R>... to)

Description copied from class: SimpleExpression

Converts this expression to another type. Unless the expression is special, the default implementation is sufficient.

This method is never called with a supertype of the return type of this expression, or the return type itself.

Overrides:

getConvertedExpr in class SimpleExpression<Object>

Parameters:

to - The desired return type of the returned expression

Returns:

Expression with the desired return type or null if it can't be converted to the given type

See Also:

Expression.getConvertedExpression(Class...), ConvertedExpression.newInstance(Expression, Class...), Converter

getReturnType

public Class<? extends Object> getReturnType()

Description copied from interface: Expression

Gets the return type of this expression.

Returns:

A supertype of any objects returned by Expression.getSingle(Event) and the component type of any arrays returned by Expression.getArray(Event)

get

protected @Nullable Object[] get(org.bukkit.event.Event e)

Description copied from class: SimpleExpression

This is the internal method to get an expression's values.
To get the expression's value from the outside use SimpleExpression.getSingle(Event) or SimpleExpression.getArray(Event).

Specified by:

get in class SimpleExpression<Object>

Parameters:

e - The event

Returns:

An array of values for this event. May not contain nulls.

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