Class ExprStringColor

java.lang.Object

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

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

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

All Implemented Interfaces:

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

@Name("String Colors")
@Description({"Retrieve the first, the last, or all of the color objects or color codes of a string.","The retrieved color codes of the string will be formatted with the color symbol."})
@Example("set {_colors::*} to the string colors of \"<red>hey<blue>yo\"") @Example("set {_color} to the first string color code of \"&aGoodbye!\"\nsend \"%{_color}%Howdy!\" to all players\n")
@Since("2.11")
public class ExprStringColor
extends ch.njol.skript.expressions.base.PropertyExpression<String,Object>

Field Summary

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

DEFAULT_PRIORITY

Constructor Summary

Constructors

Constructor	Description
ExprStringColor()

Method Summary

Modifier and Type	Method	Description
protected Object[]	get(org.bukkit.event.Event event, String[] source)
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 and SyntaxElement.preInit().
boolean	isSingle()
Class<?>[]	possibleReturnTypes()	For expressions that might return multiple (incalculable at parse time) types, this provides a list of all possible types.
static void	register(SyntaxRegistry syntaxRegistry)
Expression<?>	simplify()	Simplifies this object.
String	toString(@Nullable org.bukkit.event.Event event, boolean debug)

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

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

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, 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

ExprStringColor

public ExprStringColor()

Method Details

register

public static void register(SyntaxRegistry syntaxRegistry)

init

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

Description copied from interface: SyntaxElement

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

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 Object[] get(org.bukkit.event.Event event,
 String[] source)

Specified by:

get in class ch.njol.skript.expressions.base.PropertyExpression<String,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)

possibleReturnTypes

public Class<?>[] possibleReturnTypes()

Description copied from interface: Expression

For expressions that might return multiple (incalculable at parse time) types, this provides a list of all possible types. Use cases include: expressions that depend on the return type of their input.

Returns:

A list of all possible types this might return

isSingle

public boolean isSingle()

Specified by:

isSingle in interface Expression<Object>

Overrides:

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

Returns:

true if this expression will ever only return one value at most, false if it can return multiple values.

simplify

public Expression<?> simplify()

Description copied from interface: Simplifiable

Simplifies this object. This should be called immediately after init() returns true. If simplification is not possible, the object is returned as is.
References to the original object should be replaced with the simplified object.
Any returned object should attempt to maintain the original value of Debuggable.toString(Event, boolean). An addition indicating that the value was simplified can be added in the debug string. See SimplifiedLiteral for an example.
Simplification should never invalidate contracts. For example, any simplified expression should take care to return the same or a more specific type than the original expression, never a more generic type. Likewise, be sure to maintain the behavior of change() and acceptsChange(). Failure to do so can result in unexpected behavior and tricky bugs.
Finally, simplified results should update Expression.getSource() to point to the expression prior to simplification. This makes maintaining the above contracts easier.

Specified by:

simplify in interface Expression<Object>

Specified by:

simplify in interface Simplifiable<Expression<? extends Object>>

Overrides:

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

Returns:

the simplified object.

See Also:

• SimplifiedLiteral

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