Package ch.njol.skript.expressions

Class ExprValueWithin

java.lang.Object

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

ch.njol.skript.expressions.base.WrapperExpression<Object>

ch.njol.skript.expressions.ExprValueWithin

All Implemented Interfaces:

Debuggable, Expression<Object>, SyntaxElement

@Name("Value Within")
@Description("Gets the value within objects. Usually used with variables to get the value they store rather than the variable itself, or with lists to get the values of a type.")
@Examples({"set {_entity} to a random entity out of all entities","delete entity within {_entity} # This deletes the entity itself and not the value stored in the variable","","set {_list::*} to \"something\", 10, \"test\" and a zombie","broadcast the strings within {_list::*} # \"something\", \"test\""})
@Since("2.7")
public class ExprValueWithin
extends WrapperExpression<Object>

Constructor Summary

Constructors

Constructor	Description
ExprValueWithin()

Method Summary

Modifier and Type	Method	Description
Class<?> @Nullable []	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 event, @Nullable Object[] delta, Changer.ChangeMode mode)	Changes the expression's value by the given amount.
boolean	init(Expression<?>[] exprs, int matchedPattern, Kleenean isDelayed, SkriptParser.ParseResult parseResult)	Called just after the constructor.
String	toString(@Nullable org.bukkit.event.Event event, boolean debug)

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

beforeChange, 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, 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

getAcceptedChangeModes, getOptionalSingle, stream

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

getParser

Constructor Details

ExprValueWithin

public ExprValueWithin()

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

acceptChange

public Class<?> @Nullable [] 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<Object>

Overrides:

acceptChange in class WrapperExpression<Object>

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 event,
 @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<Object>

Overrides:

change in class WrapperExpression<Object>

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.

toString

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

Parameters:

event - 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