Class ExprColored

java.lang.Object

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

ch.njol.skript.expressions.base.PropertyExpression<String,Object>

ch.njol.skript.expressions.base.SimplePropertyExpression<String,Object>

org.skriptlang.skript.bukkit.text.elements.expressions.ExprColored

All Implemented Interfaces:

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

@Name("Colored/Formatted/Uncolored")
@Description("Parses or removes colors and, optionally, chat styles in/from a message.")
@Example("on chat:\n\tset message to colored message # only safe tags, such as colors, will be parsed\n") @Example("command /fade <player>:\n\ttrigger:\n\t\tset the display name of the player-argument to the uncolored display name of the player-argument\n") @Example("command /format <text>:\n\ttrigger:\n\t\tmessage formatted text-argument # parses all tags, but this is okay as the output is sent back to the executor\n")
@Since({"2.0","2.15 ('uncolored' vs 'unformatted' distinction)"})
public class ExprColored
extends ch.njol.skript.expressions.base.SimplePropertyExpression<String,Object>

Field Summary

Fields inherited from class ch.njol.skript.expressions.base.SimplePropertyExpression

rawExpr

Fields inherited from class ch.njol.skript.expressions.base.PropertyExpression

DEFAULT_PRIORITY

Fields inherited from interface Converter

ALL_CHAINING, ALLOW_UNSAFE_CASTS, NO_CHAINING, NO_LEFT_CHAINING, NO_RIGHT_CHAINING

Constructor Summary

Constructors

Constructor	Description
ExprColored()

Method Summary

Modifier and Type	Method	Description
Object	convert(String string)	Converts an object using this Converter.
protected String	getPropertyName()
Class<?>	getReturnType()	Gets the return type of this expression.
boolean	init(Expression<?>[] expressions, int matchedPattern, Kleenean isDelayed, SkriptParser.ParseResult parseResult)	Called just after the constructor and SyntaxElement.preInit().
boolean	isUnsafeFormat()	Deprecated, for removal: This API element is subject to removal in a future version. This method is only available for compatibility purposes.
static void	register(SyntaxRegistry syntaxRegistry)

Methods inherited from class ch.njol.skript.expressions.base.SimplePropertyExpression

get, toString

Methods inherited from class ch.njol.skript.expressions.base.PropertyExpression

get, get, getAll, getAnd, getDefaultPatterns, getExpr, getPatterns, infoBuilder, isSingle, register, register, registerDefault, registerDefault, setExpr, simplify

Methods inherited from class SimpleExpression

acceptChange, change, check, check, check, getArray, getConvertedExpr, getConvertedExpression, getNode, getSingle, getSource, getTime, isDefault, isLoopOf, iterator, preInit, setTime, setTime, setTime, setTime, setTime, 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

ExprColored

public ExprColored()

Method Details

register

public static void register(SyntaxRegistry syntaxRegistry)

init

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

Description copied from interface: SyntaxElement

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

Specified by:

init in interface SyntaxElement

Overrides:

init in class ch.njol.skript.expressions.base.SimplePropertyExpression<String,Object>

Parameters:

expressions - 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...)

convert

public Object convert(String string)

Description copied from interface: Converter

Converts an object using this Converter.

Specified by:

convert in interface Converter<String,Object>

Specified by:

convert in class ch.njol.skript.expressions.base.SimplePropertyExpression<String,Object>

Parameters:

string - The object to convert.

Returns:

The converted object.

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)

getPropertyName

protected String getPropertyName()

Specified by:

getPropertyName in class ch.njol.skript.expressions.base.SimplePropertyExpression<String,Object>

isUnsafeFormat

@Deprecated(since="2.15",
            forRemoval=true)
public boolean isUnsafeFormat()

Deprecated, for removal: This API element is subject to removal in a future version.

This method is only available for compatibility purposes.