Package ch.njol.skript.expressions

Class ExprSubstring

java.lang.Object

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

ch.njol.skript.expressions.ExprSubstring

All Implemented Interfaces:

Debuggable, Expression<String>, SyntaxElement

@Name("Subtext")
@Description("Extracts part of a text. You can either get the first &lt;x&gt; characters, the last &lt;x&gt; characters, the character at index &lt;x&gt;, or the characters between indices &lt;x&gt; and &lt;y&gt;. The indices &lt;x&gt; and &lt;y&gt; should be between 1 and the <a href=\'#ExprLength\'>length</a> of the text (other values will be fit into this range).")
@Examples({"set {_s} to the first 5 characters of the text argument","message \"%subtext of {_s} from characters 2 to (the length of {_s} - 1)%\" # removes the first and last character from {_s} and sends it to the player or console","set {_characters::*} to characters at 1, 2 and 7 in player\'s display name","send the last character of all players\' names"})
@Since("2.1, 2.5.2 (character at, multiple strings support)")
public class ExprSubstring
extends SimpleExpression<String>

Constructor Summary

Constructors

Constructor	Description
ExprSubstring()

Method Summary

Modifier and Type	Method	Description
protected @Nullable String[]	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 String>	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

ExprSubstring

public ExprSubstring()

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 String[] 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<String>

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<? extends String> 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