Class ExecExprReplace

java.lang.Object

io.github.syst3ms.skriptparser.lang.Statement

io.github.syst3ms.skriptparser.lang.Effect

io.github.syst3ms.skriptparser.lang.base.ExecutableExpression<String>

io.github.syst3ms.skriptparser.expressions.ExecExprReplace

All Implemented Interfaces:

Expression<String>, SyntaxElement

public class ExecExprReplace
extends ExecutableExpression<String>

Replaces certain occurrences in a string with another string and returns those applied strings. If used like an effect, instead of returning the applied strings, specified above, it will replace them from in the list. Note that not all expressions support this behaviour. If no valid match was found, nothing will happen.
Note that indices in Skript start at one.

Since:

ALPHA

See Also:

• ExprElement

Field Summary

Fields inherited from class Statement

next, parent

Constructor Summary

Constructors

Constructor	Description
ExecExprReplace()

Method Summary

Modifier and Type	Method	Description
String[]	getValues(TriggerContext ctx, boolean isEffect)	Retrieves all values of this expression, if used as one.
boolean	init(Expression<?>[] expressions, int matchedPattern, ParseContext parseContext)	Initializes this SyntaxElement before being used.
String	toString(TriggerContext ctx, boolean debug)

Methods inherited from class ExecutableExpression

execute, getValues

Methods inherited from class Effect

run

Methods inherited from class Statement

getNext, getParent, runAll, setNext, setParent, walk

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface Expression

acceptsChange, acceptsChange, acceptsChange, change, check, check, convertExpression, getArray, getReturnType, getSingle, getSource, isAndList, isLoopOf, isSingle, iterator, setAndList, stream

Constructor Details

ExecExprReplace

public ExecExprReplace()

Method Details

init

public boolean init(Expression<?>[] expressions,
 int matchedPattern,
 ParseContext parseContext)

Description copied from interface: SyntaxElement

Initializes this SyntaxElement before being used. This method is always called before all the others in an extending class, the only exception being CodeSection.loadSection(FileSection, ParserState, SkriptLogger).

Parameters:

expressions - an array of expressions representing all the expressions that are being passed to this syntax element. As opposed to Skript, elements of this array can't be null.

matchedPattern - the index of the pattern that was successfully matched. It corresponds to the order of the syntaxes in registration

parseContext - an object containing additional information about the parsing of this syntax element, like regex matches and parse marks

Returns:

true if the syntax element was initialized successfully, false otherwise.

See Also:

• SkriptRegistration
• ParseContext

getValues

public String[] getValues(TriggerContext ctx,
 boolean isEffect)

Description copied from class: ExecutableExpression

Retrieves all values of this expression, if used as one. Otherwise, if used as an effect, performs side-effects with certain behaviour. Note that when this is not the case, this syntax, by convention, should not have any side-effects.

Specified by:

getValues in class ExecutableExpression<String>

Parameters:

ctx - the context

isEffect - whether this syntax is used as effect or as an expression

Returns:

an array of the values

toString

public String toString(TriggerContext ctx,
 boolean debug)

Parameters:

ctx - the event

debug - whether to show additional information or not

Returns:

a String that should aim to resemble what is written in the script as closely as possible