Package ch.njol.skript.expressions

Class ExprArgument

java.lang.Object

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

ch.njol.skript.expressions.ExprArgument

All Implemented Interfaces:

Debuggable, Expression<Object>, SyntaxElement

@Name("Argument")
@Description({"Usable in script commands and command events. Holds the value of an argument given to the command, e.g. if the command \"/tell <player> <text>\" is used like \"/tell Njol Hello Njol!\" argument 1 is the player named \"Njol\" and argument 2 is \"Hello Njol!\".","One can also use the type of the argument instead of its index to address the argument, e.g. in the above example \'player-argument\' is the same as \'argument 1\'.","Please note that specifying the argument type is only supported in script commands."})
@Examples({"give the item-argument to the player-argument","damage the player-argument by the number-argument","give a diamond pickaxe to the argument","add argument 1 to argument 2","heal the last argument"})
@Since("1.0, 2.7 (support for command events)")
public class ExprArgument
extends SimpleExpression<Object>

Constructor Summary

Constructors

Constructor	Description
ExprArgument()

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	isLoopOf(String s)	Checks whether the given 'loop-...' expression should match this loop, e.g.
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, iterator, setTime, 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, getAcceptedChangeModes, getOptionalSingle, stream

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

getParser

Constructor Details

ExprArgument

public ExprArgument()

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)

isLoopOf

public boolean isLoopOf(String s)

Description copied from interface: Expression

Checks whether the given 'loop-...' expression should match this loop, e.g. loop-block matches any loops that loop through blocks and loop-argument matches an argument loop.

You should usually just return false as e.g. loop-block will automatically match the expression if its returnType is Block or a subtype of it.

Specified by:

isLoopOf in interface Expression<Object>

Overrides:

isLoopOf in class SimpleExpression<Object>

Parameters:

s - The entered string

Returns:

Whether this loop matches the given string

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