Package ch.njol.skript.expressions

Class ExprTimeState

java.lang.Object

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

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

ch.njol.skript.expressions.ExprTimeState

All Implemented Interfaces:

Debuggable, Expression<Object>, SyntaxElement

@Name("Former/Future State")
@Description({"Represents the value of an expression before an event happened or the value it will have directly after the event, e.g. the old or new level respectively in a <a href=\'./events.html#level_change\'>level change event</a>.","Note: The past, future and present states of an expression are sometimes called \'time states\' of an expression.","Note 2: If you don\'t specify whether to use the past or future state of an expression that has different values, its default value will be used which is usually the value after the event."})
@Examples({"on teleport:","\tformer world was \"world_nether\" # or \'world was\'","\tworld will be \"world\" # or \'world after the event is\'","on tool change:","\tpast tool is an axe","\tthe tool after the event will be air","on weather change:","\tset {weather::%world%::old} to past weather","\tset {weather::%world%::current} to the new weather"})
@Since("1.1")
public class ExprTimeState
extends WrapperExpression<Object>

Constructor Summary

Constructors

Constructor	Description
ExprTimeState()

Method Summary

Modifier and Type	Method	Description
boolean	init(Expression<?>[] exprs, int matchedPattern, Kleenean isDelayed, SkriptParser.ParseResult parseResult)	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.WrapperExpression

acceptChange, beforeChange, change, get, getAnd, getConvertedExpr, getExpr, getReturnType, getTime, isDefault, isSingle, iterator, setExpr, simplify

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

check, check, check, getAll, getArray, getConvertedExpression, getSingle, getSource, isLoopOf, 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

stream

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

getParser

Constructor Details

ExprTimeState

public ExprTimeState()

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

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

Overrides:

setTime in class WrapperExpression<Object>

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