Package ch.njol.skript.expressions

Class ExprVehicle

java.lang.Object

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

ch.njol.skript.expressions.base.PropertyExpression<F,T>

ch.njol.skript.expressions.base.SimplePropertyExpression<org.bukkit.entity.Entity,org.bukkit.entity.Entity>

ch.njol.skript.expressions.ExprVehicle

All Implemented Interfaces:

Converter<org.bukkit.entity.Entity,org.bukkit.entity.Entity>, Debuggable, Expression<org.bukkit.entity.Entity>, SyntaxElement

@Name("Vehicle")
@Description({"The vehicle an entity is in, if any. This can actually be any entity, e.g. spider jockeys are skeletons that ride on a spider, so the spider is the \'vehicle\' of the skeleton.","See also: <a href=\'#ExprPassenger\'>passenger</a>"})
@Examples("vehicle of the player is a minecart")
@Since("2.0")
public class ExprVehicle
extends SimplePropertyExpression<org.bukkit.entity.Entity,org.bukkit.entity.Entity>

Nested Class Summary

Nested classes/interfaces inherited from interface ch.njol.skript.classes.Converter

Converter.ConverterInfo<F,T>, Converter.ConverterUtils

Field Summary

Fields inherited from interface ch.njol.skript.classes.Converter

NO_CHAINING, NO_COMMAND_ARGUMENTS, NO_LEFT_CHAINING, NO_RIGHT_CHAINING

Constructor Summary

Constructors

Constructor	Description
ExprVehicle()

Method Summary

Modifier and Type	Method	Description
@Nullable Class<?>[]	acceptChange(Changer.ChangeMode mode)	Tests whether this expression supports the given mode, and if yes what type it expects the delta to be.
void	change(org.bukkit.event.Event e, @Nullable Object[] delta, Changer.ChangeMode mode)	Changes the expression's value by the given amount.
@Nullable org.bukkit.entity.Entity	convert(org.bukkit.entity.Entity e)	Converts an object from the given to the desired type.
protected org.bukkit.entity.Entity[]	get(org.bukkit.event.Event e, org.bukkit.entity.Entity[] source)	Converts the given source object(s) to the correct type.
protected String	getPropertyName()
Class<? extends org.bukkit.entity.Entity>	getReturnType()	Gets the return type of this expression.
boolean	setTime(int time)	Sets the time of this expression, i.e.

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

init, toString

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

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

ExprVehicle

public ExprVehicle()

Method Details

get

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

Overrides:

get in class SimplePropertyExpression<org.bukkit.entity.Entity,org.bukkit.entity.Entity>

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)

convert

public @Nullable org.bukkit.entity.Entity convert(org.bukkit.entity.Entity e)

Description copied from interface: Converter

Converts an object from the given to the desired type.

Specified by:

convert in interface Converter<org.bukkit.entity.Entity,org.bukkit.entity.Entity>

Specified by:

convert in class SimplePropertyExpression<org.bukkit.entity.Entity,org.bukkit.entity.Entity>

Parameters:

e - The object to convert.

Returns:

the converted object

getReturnType

public Class<? extends org.bukkit.entity.Entity> 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)

getPropertyName

protected String getPropertyName()

Specified by:

getPropertyName in class SimplePropertyExpression<org.bukkit.entity.Entity,org.bukkit.entity.Entity>

acceptChange

public @Nullable Class<?>[] acceptChange(Changer.ChangeMode mode)

Description copied from interface: Expression

Tests whether this expression supports the given mode, and if yes what type it expects the delta to be.

Use Changer.ChangerUtils.acceptsChange(Expression, ChangeMode, Class...) to test whether an expression supports changing, don't directly use this method!

Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with super.change(...).

Unlike Changer.acceptChange(ChangeMode) this method may print errors.

Specified by:

acceptChange in interface Expression<org.bukkit.entity.Entity>

Overrides:

acceptChange in class SimpleExpression<org.bukkit.entity.Entity>

Returns:

An array of types that Expression.change(Event, Object[], ChangeMode) accepts as its delta parameter (which can be arrays to denote that multiple of that type are accepted), or null if the given mode is not supported. For Changer.ChangeMode.DELETE and Changer.ChangeMode.RESET this can return any non-null array to mark them as supported.

change

public void change(org.bukkit.event.Event e,
 @Nullable Object[] delta,
 Changer.ChangeMode mode)

Description copied from interface: Expression

Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by Expression.acceptChange(ChangeMode)

Specified by:

change in interface Expression<org.bukkit.entity.Entity>

Overrides:

change in class SimpleExpression<org.bukkit.entity.Entity>

delta - An array with one or more instances of one or more of the the classes returned by Expression.acceptChange(ChangeMode) for the given change mode (null for Changer.ChangeMode.DELETE and Changer.ChangeMode.RESET). This can be a Object[], thus casting is not allowed.

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<org.bukkit.entity.Entity>

Overrides:

setTime in class SimpleExpression<org.bukkit.entity.Entity>

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