Package ch.njol.skript.expressions

Class ExprLocation

java.lang.Object

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

ch.njol.skript.expressions.base.WrapperExpression<org.bukkit.Location>

ch.njol.skript.expressions.ExprLocation

All Implemented Interfaces:

Debuggable, Expression<org.bukkit.Location>, SyntaxElement

@Name("Location")
@Description("The location where an event happened (e.g. at an entity or block), or a location <a href=\'#ExprDirection\'>relative</a> to another (e.g. 1 meter above another location).")
@Examples({"drop 5 apples at the event-location # exactly the same as writing \'drop 5 apples\'","set {_loc} to the location 1 meter above the player"})
@Since("2.0")
public class ExprLocation
extends WrapperExpression<org.bukkit.Location>

Constructor Summary

Constructors

Constructor	Description
ExprLocation()

Method Summary

Modifier and Type	Method	Description
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.WrapperExpression

acceptChange, beforeChange, change, get, getAnd, getConvertedExpr, getExpr, getReturnType, getTime, isDefault, isSingle, iterator, setExpr, setTime, simplify

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

check, check, check, getAll, getArray, getConvertedExpression, getSingle, getSource, isLoopOf, 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

stream

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

getParser

Constructor Details

ExprLocation

public ExprLocation()

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

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