Class ExprColorFromRGB

java.lang.Object

io.github.syst3ms.skriptparser.expressions.ExprColorFromRGB

All Implemented Interfaces:

Expression<Color>, SyntaxElement

public class ExprColorFromRGB
extends Object
implements Expression<Color>

A color specified by its RGB value. Each value, this means red, green and blue, can be a range from 0 to 255. Any values outside of those ranges will result in no color to be created. It is also possible to add the alpha value, which corresponds to the transparency. If the argument size is not exactly 3 or 4, no color will be created.

Since:

ALPHA

Constructor Summary

Constructors

Constructor	Description
ExprColorFromRGB()

Method Summary

Modifier and Type	Method	Description
Color[]	getValues(TriggerContext ctx)	Retrieves all values of this Expression, accounting for possible modifiers.
boolean	init(Expression<?>[] expressions, int matchedPattern, ParseContext parseContext)	Initializes this SyntaxElement before being used.
String	toString(TriggerContext ctx, boolean debug)

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

ExprColorFromRGB

public ExprColorFromRGB()

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

Specified by:

init in interface SyntaxElement

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 Color[] getValues(TriggerContext ctx)

Description copied from interface: Expression

Retrieves all values of this Expression, accounting for possible modifiers. This means that if this is an or-list, it will choose a random value to return.

Specified by:

getValues in interface Expression<Color>

Parameters:

ctx - the event

Returns:

an array of the values

See Also:

• Expression.getArray(TriggerContext)

toString

public String toString(TriggerContext ctx,
 boolean debug)

Specified by:

toString in interface SyntaxElement

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