Package ch.njol.skript.expressions.arithmetic

Class ExprArithmetic

java.lang.Object

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

ch.njol.skript.expressions.arithmetic.ExprArithmetic

All Implemented Interfaces:

Debuggable, Expression<Number>, SyntaxElement

@Name("Arithmetic")
@Description("Arithmetic expressions, e.g. 1 + 2, (health of player - 2) / 3, etc.")
@Examples({"set the player\'s health to 10 - the player\'s health","loop (argument + 2) / 5 times:","\tmessage \"Two useless numbers: %loop-num * 2 - 5%, %2^loop-num - 1%\"","message \"You have %health of player * 2% half hearts of HP!\""})
@Since("1.4.2")
public class ExprArithmetic
extends SimpleExpression<Number>

Constructor Summary

Constructors

Constructor	Description
ExprArithmetic()

Method Summary

Modifier and Type	Method	Description
protected Number[]	get(org.bukkit.event.Event e)	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 Number>	getReturnType()	Gets the return type of this expression.
boolean	init(Expression<?>[] exprs, int matchedPattern, Kleenean isDelayed, SkriptParser.ParseResult parseResult)	Called just after the constructor.
boolean	isSingle()
Expression<? extends Number>	simplify()	Simplifies the expression, e.g.
String	toString(@Nullable org.bukkit.event.Event e, boolean debug)

Methods inherited from class ch.njol.skript.lang.util.SimpleExpression

acceptChange, change, check, check, check, getAll, getAnd, getArray, getConvertedExpr, getConvertedExpression, getSingle, getSource, getTime, isDefault, isLoopOf, iterator, 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

beforeChange, stream

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

getParser

Constructor Details

ExprArithmetic

public ExprArithmetic()

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

get

protected Number[] get(org.bukkit.event.Event e)

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

Parameters:

e - The event

Returns:

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

getReturnType

public Class<? extends Number> 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(@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

simplify

public Expression<? extends Number> simplify()

Description copied from interface: Expression

Simplifies the expression, e.g. if it only contains literals the expression may be simplified to a literal, and wrapped expressions are unwrapped.

After this method was used the toString methods are likely not useful anymore.

This method is not yet used but will be used to improve efficiency in the future.

Specified by:

simplify in interface Expression<Number>

Overrides:

simplify in class SimpleExpression<Number>

Returns:

A reference to a simpler version of this expression. Can change this expression directly and return itself if applicable, i.e. no references to the expression before this method call should be kept!