Package ch.njol.skript.expressions

Class ExprParse

java.lang.Object

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

ch.njol.skript.expressions.ExprParse

All Implemented Interfaces:

Debuggable, Expression<Object>, SyntaxElement

@Name("Parse")
@Description({"Parses text as a given type, or as a given pattern.","This expression can be used in two different ways: One which parses the entire text as a single instance of a type, e.g. as a number, and one that parses the text according to a pattern.","If the given text could not be parsed, this expression will return nothing and the <a href=\'#ExprParseError\'>parse error</a> will be set if some information is available.","Some notes about parsing with a pattern:","- The pattern must be a <a href=\'./patterns/\'>Skript pattern</a>, e.g. percent signs are used to define where to parse which types, e.g. put a %number% or %items% in the pattern if you expect a number or some items there.","- You <i>have to</i> save the expression\'s value in a list variable, e.g. <code>set {parsed::*} to message parsed as \"...\"</code>.","- The list variable will contain the parsed values from all %types% in the pattern in order. If a type was plural, e.g. %items%, the variable\'s value at the respective index will be a list variable, e.g. the values will be stored in {parsed::1::*}, not {parsed::1}."})
@Examples({"set {var} to line 1 parsed as number","on chat:","\tset {var::*} to message parsed as \"buying %items% for %money%\"","\tif parse error is set:","\t\tmessage \"%parse error%\"","\telse if {var::*} is set:","\t\tcancel event","\t\tremove {var::2} from the player\'s balance","\t\tgive {var::1::*} to the player"})
@Since("2.0")
public class ExprParse
extends SimpleExpression<Object>

Constructor Summary

Constructors

Constructor	Description
ExprParse()

Method Summary

Modifier and Type	Method	Description
protected @Nullable Object[]	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<?>	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()
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, simplify, 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

ExprParse

public ExprParse()

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

Parameters:

e - The event

Returns:

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

isSingle

public boolean isSingle()

Returns:

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

getReturnType

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

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