Package ch.njol.skript.expressions

Class ExprLightLevel

java.lang.Object

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

ch.njol.skript.expressions.base.PropertyExpression<org.bukkit.Location,Byte>

ch.njol.skript.expressions.ExprLightLevel

All Implemented Interfaces:

Debuggable, Expression<Byte>, SyntaxElement

@Name("Light Level")
@Description({"Gets the light level at a certain location which ranges from 0 to 15.","It can be separated into sunlight (15 = direct sunlight, 1-14 = indirect) and block light (torches, glowstone, etc.). The total light level of a block is the maximum of the two different light types."})
@Examples({"# set vampire players standing in bright sunlight on fire","every 5 seconds:","\tloop all players:","\t\t{vampire::%uuid of loop-player%} is true","\t\tsunlight level at the loop-player is greater than 10","\t\tignite the loop-player for 5 seconds"})
@Since("1.3.4")
public class ExprLightLevel
extends PropertyExpression<org.bukkit.Location,Byte>

Constructor Summary

Constructors

Constructor	Description
ExprLightLevel()

Method Summary

Modifier and Type	Method	Description
protected Byte[]	get(org.bukkit.event.Event e, org.bukkit.Location[] source)	Converts the given source object(s) to the correct type.
Class<Byte>	getReturnType()	Gets the return type of this expression.
boolean	init(Expression<?>[] exprs, int matchedPattern, Kleenean isDelayed, SkriptParser.ParseResult parseResult)	Called just after the constructor.
String	toString(@Nullable org.bukkit.event.Event e, boolean debug)

Methods inherited from class ch.njol.skript.expressions.base.PropertyExpression

get, get, getAll, getAnd, getExpr, isSingle, register, setExpr, simplify

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

acceptChange, change, check, check, check, getArray, getConvertedExpr, getConvertedExpression, getSingle, getSource, getTime, isDefault, isLoopOf, iterator, setTime, setTime, setTime, setTime, 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

ExprLightLevel

public ExprLightLevel()

Method Details

init

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

Description copied from interface: SyntaxElement

Called just after the constructor.

Parameters:

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

getReturnType

public Class<Byte> 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 Byte[] get(org.bukkit.event.Event e,
 org.bukkit.Location[] source)

Description copied from class: PropertyExpression

Converts the given source object(s) to the correct type.

Please note that the returned array must neither be null nor contain any null elements!

Specified by:

get in class PropertyExpression<org.bukkit.Location,Byte>

Returns:

An array of the converted objects, which may contain less elements than the source array, but must not be null.

See Also:

Converters.convert(Object[], Class, Converter)

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