Package ch.njol.skript.expressions

Class ExprTool

java.lang.Object

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

ch.njol.skript.expressions.base.PropertyExpression<org.bukkit.entity.LivingEntity,Slot>

ch.njol.skript.expressions.ExprTool

All Implemented Interfaces:

Debuggable, Expression<Slot>, SyntaxElement

@Name("Tool")
@Description("The item an entity is holding in their main or off hand.")
@Examples({"player\'s tool is a pickaxe","player\'s off hand tool is a shield","set tool of all players to a diamond sword","set offhand tool of target entity to a bow"})
@Since("1.0")
public class ExprTool
extends PropertyExpression<org.bukkit.entity.LivingEntity,Slot>

Constructor Summary

Constructors

Constructor	Description
ExprTool()

Method Summary

Modifier and Type	Method	Description
protected Slot[]	get(org.bukkit.event.Event e, org.bukkit.entity.LivingEntity[] source)	Converts the given source object(s) to the correct type.
Class<Slot>	getReturnType()	Gets the return type of this expression.
boolean	init(Expression<?>[] exprs, int matchedPattern, Kleenean isDelayed, SkriptParser.ParseResult parser)	Called just after the constructor.
boolean	setTime(int time)	Sets the time of this expression, i.e.
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, 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

ExprTool

public ExprTool()

Method Details

init

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

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)

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

get

protected Slot[] get(org.bukkit.event.Event e,
 org.bukkit.entity.LivingEntity[] 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.entity.LivingEntity,Slot>

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)

getReturnType

public Class<Slot> 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)

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

setTime

public boolean setTime(int time)

Description copied from class: SimpleExpression

Sets the time of this expression, i.e. whether the returned value represents this expression before or after the event.

This method will not be called if this expression is guaranteed to be used after a delay (an error will be printed immediately), but will be called if it only can be after a delay (e.g. if the preceding delay is in an if or a loop) as well as if there's no delay involved.

If this method returns false the expression will be discarded and an error message is printed. Custom error messages must be of ErrorQuality.SEMANTIC_ERROR to be printed (NB: Skript.error(String) always creates semantic errors).

This implementation sets the time but returns false.

Specified by:

setTime in interface Expression<Slot>

Overrides:

setTime in class SimpleExpression<Slot>

Parameters:

time - -1 for past or 1 for future. 0 is never passed to this method as it represents the default state.

Returns:

Whether this expression has distinct time states, e.g. a player never changes but a block can. This should be sensitive for the event (using ParserInstance.isCurrentEvent(Class)).

See Also:

SimpleExpression.setTime(int, Class, Expression...), SimpleExpression.setTime(int, Expression, Class...)