Class ExprReplace

java.lang.Object

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

org.skriptlang.skript.common.elements.expressions.ExprReplace

All Implemented Interfaces:

Debuggable, Expression<String>, Loopable<String>, Simplifiable<Expression<? extends String>>, SyntaxElement, RuntimeErrorProducer, SyntaxRuntimeErrorProducer

@Name("Text Replacement")
@Description("Performs a text replacement on a given value, returning the result. Supports regex and case sensitive replacement.")
@Example("send \"Welcome [player]\" where \"[player]\" is replaced with \"%player%\" to player") @Example("# Function for sanitizing user inputs\n# Strips the input of any non-alphanumeric characters using regex\nfunction sanitizeInput(input: string) :: string:\n\treturn {_input} where regex pattern \"\\W\" is replaced with \"\"\n") @Example("# Function to convert &# hex color codes to <# > (mini message format)\nfunction colorFormat(input: string) :: string:\n\treturn {_input} where all instances of regex pattern \"&#([a-fA-F0-9]{6})\" are replaced with \"<#$1>\"\n") @Example("# Very simple chat censor\non chat:\n\tset message to message where all instances of \"idiot\", \"noob\" are replaced with \"****\"\n\tset message to message where regex \"\\b(idiot|noob)\\b\" is replaced with \"****\" # Regex version using word boundaries for better results\n")
@Since("2.16")
public class ExprReplace
extends SimpleExpression<String>

Constructor Summary

Constructors

Constructor	Description
ExprReplace()

Method Summary

Modifier and Type	Method	Description
protected String @Nullable []	get(org.bukkit.event.Event event)	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<?>[] expr, int matchedPattern, Kleenean isDelayed, SkriptParser.ParseResult parseResult)	Called just after the constructor and SyntaxElement.preInit().
boolean	isSingle()
static void	register(SyntaxRegistry registry)
String	toString(@Nullable org.bukkit.event.Event event, boolean debug)

Methods inherited from class SimpleExpression

acceptChange, change, check, check, check, getAll, getAnd, getArray, getConvertedExpr, getConvertedExpression, getNode, getSingle, getSource, getTime, isDefault, isLoopOf, iterator, preInit, setTime, setTime, setTime, setTime, setTime, simplify, supportsLoopPeeking, toString

Methods inherited from class Object

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

Methods inherited from interface Expression

beforeChange, canBeSingle, canReturn, canReturnAnyOf, changeInPlace, changeInPlace, getAcceptedChangeModes, getOptionalSingle, getSyntaxTypeName, possibleReturnTypes, returnNestedStructures, returnsNestedStructures, stream, streamAll

Methods inherited from interface RuntimeErrorProducer

error, error, getRuntimeErrorManager, warning, warning

Methods inherited from interface SyntaxElement

getParser

Methods inherited from interface SyntaxRuntimeErrorProducer

getErrorSource

Constructor Details

ExprReplace

public ExprReplace()

Method Details

register

public static void register(SyntaxRegistry registry)

init

public boolean init(Expression<?>[] expr,
 int matchedPattern,
 Kleenean isDelayed,
 SkriptParser.ParseResult parseResult)

Description copied from interface: SyntaxElement

Called just after the constructor and SyntaxElement.preInit().

Parameters:

expr - 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 String @Nullable [] get(org.bukkit.event.Event event)

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:

event - The event with which this expression is evaluated.

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
 @Nullable org.bukkit.event.Event event,
 boolean debug)

Parameters:

event - The event to get information from. 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