Class ExprWhether

java.lang.Object

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

org.skriptlang.skript.common.elements.expressions.ExprWhether

All Implemented Interfaces:

Debuggable, Expression<Boolean>, Loopable<Boolean>, Simplifiable<Expression<? extends Boolean>>, SyntaxElement, RuntimeErrorProducer, SyntaxRuntimeErrorProducer

@Name("Whether")
@Description("A shorthand for returning the result of a condition (true or false). This is functionally identical to using 'true if <condition> else false'.\nMany conditions also support being changed through this expression, typically using 'set'.\n")
@Example("set {fly} to whether player can fly") @Example("broadcast \"Flying: %whether player is flying%\"") @Example("set whether the player can fly to true") @Example("toggle whether the player can pick up items")
@Since({"2.9.0","2.17 (changing)"})
public class ExprWhether
extends SimpleExpression<Boolean>

Constructor Summary

Constructors

Constructor	Description
ExprWhether()

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, Object @Nullable [] delta, Changer.ChangeMode mode)	Changes the expression's value by the given amount.
protected Boolean[]	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 Boolean>	getReturnType()	Gets the return type of this expression.
boolean	init(Expression<?>[] expressions, int pattern, Kleenean delayed, SkriptParser.ParseResult result)	Called just after the constructor and SyntaxElement.preInit().
boolean	isSingle()
static void	register(SyntaxRegistry syntaxRegistry)
String	toString(org.bukkit.event.Event event, boolean debug)

Methods inherited from class SimpleExpression

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

ExprWhether

public ExprWhether()

Method Details

register

public static void register(SyntaxRegistry syntaxRegistry)

init

public boolean init(Expression<?>[] expressions,
 int pattern,
 Kleenean delayed,
 SkriptParser.ParseResult result)

Description copied from interface: SyntaxElement

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

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.

pattern - The index of the pattern which matched

delayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)

result - 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 Boolean[] 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<Boolean>

Parameters:

event - The event with which this expression is evaluated.

Returns:

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

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

Overrides:

acceptChange in class SimpleExpression<Boolean>

Parameters:

mode - The mode to check

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,
 Object @Nullable [] 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<Boolean>

Overrides:

change in class SimpleExpression<Boolean>

Parameters:

event - The event

delta - An array with one or more instances of one or more of 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.

mode - The Changer.ChangeMode of the attempted change

getReturnType

public Class<? extends Boolean> 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)

isSingle

public boolean isSingle()

Returns:

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

toString

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

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