Class ExprPathfindingLocation

java.lang.Object

ch.njol.skript.lang.util.SimpleExpression<org.bukkit.Location>

org.skriptlang.skript.bukkit.entity.elements.expressions.ExprPathfindingLocation

All Implemented Interfaces:

Debuggable, EventRestrictedSyntax, Expression<org.bukkit.Location>, Loopable<org.bukkit.Location>, Simplifiable<Expression<? extends org.bukkit.Location>>, SyntaxElement, RuntimeErrorProducer, SyntaxRuntimeErrorProducer

@Name("Pathfinding Target Location")
@Description("The location that the entity is pathfinding towards.")
@Example("on pathfind:\n\tif the pathfinding target location is within radius 5 of {mylocation}:\n\t    broadcast \"A mob tried to pathfind near a forbidden location!\"\n\t    cancel event\n")
@Since("2.16")
@Events("pathfind")
public class ExprPathfindingLocation
extends SimpleExpression<org.bukkit.Location>
implements EventRestrictedSyntax

Constructor Summary

Constructors

Constructor	Description
ExprPathfindingLocation()

Method Summary

Modifier and Type	Method	Description
protected org.bukkit.Location[]	get(org.bukkit.event.Event event)	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).
Class<? extends org.bukkit.Location>	getReturnType()	Gets the return type of this expression.
boolean	init(Expression<?>[] expressions, int matchedPattern, Kleenean isDelayed, SkriptParser.ParseResult parseResult)	Called just after the constructor and SyntaxElement.preInit().
boolean	isSingle()
static void	register(SyntaxRegistry syntaxRegistry)
Class<? extends org.bukkit.event.Event>[]	supportedEvents()	Returns all supported events for this syntax element.
String	toString(@Nullable org.bukkit.event.Event event, boolean debug)

Methods inherited from class SimpleExpression

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

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface Expression

beforeChange, canBeSingle, canReturn, canReturnAnyOf, changeInPlace, changeInPlace, getAcceptedChangeModes, getOptionalSingle, getSyntaxTypeName, possibleReturnTypes, returnNestedStructures, returnsNestedStructures, stream, streamAll

Methods inherited from interface RuntimeErrorProducer

error, error, getRuntimeErrorManager, warning, warning

Methods inherited from interface SyntaxElement

getParser

Methods inherited from interface SyntaxRuntimeErrorProducer

getErrorSource

Constructor Details

ExprPathfindingLocation

public ExprPathfindingLocation()

Method Details

register

public static void register(SyntaxRegistry syntaxRegistry)

init

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

Description copied from interface: SyntaxElement

Called just after the constructor and SyntaxElement.preInit().

Specified by:

init in interface SyntaxElement

Parameters:

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

supportedEvents

public Class<? extends org.bukkit.event.Event>[] supportedEvents()

Description copied from interface: EventRestrictedSyntax

Returns all supported events for this syntax element.

Before SyntaxElement.init(Expression[], int, Kleenean, SkriptParser.ParseResult) is called, checks to see if the current event is supported by this syntax element. If it is not, an error will be printed and the syntax element will not be initialised.

Specified by:

supportedEvents in interface EventRestrictedSyntax

Returns:

All supported event classes.

See Also:

• CollectionUtils.array(Object[])

get

protected org.bukkit.Location[] get(org.bukkit.event.Event event)

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<org.bukkit.Location>

Parameters:

event - The event with which this expression is evaluated.

Returns:

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

isSingle

public boolean isSingle()

Specified by:

isSingle in interface Expression<org.bukkit.Location>

Returns:

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

getReturnType

public Class<? extends org.bukkit.Location> getReturnType()

Description copied from interface: Expression

Gets the return type of this expression.

Specified by:

getReturnType in interface Expression<org.bukkit.Location>

Returns:

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

toString

public String toString(@Nullable
 @Nullable org.bukkit.event.Event event,
 boolean debug)

Specified by:

toString in interface Debuggable

Parameters:

event - The event to get information from. 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