Class CondExprCompare

java.lang.Object

io.github.syst3ms.skriptparser.lang.base.ConditionalExpression

io.github.syst3ms.skriptparser.expressions.CondExprCompare

All Implemented Interfaces:

Expression<Boolean>, SyntaxElement

public class CondExprCompare
extends ConditionalExpression

A very general condition, it simply compares two values. Usually you can only compare for equality (e.g. text is/isn't <text>), but some values can also be compared using greater than/less than. In that case you can also test for whether an object is between two others.

Since:

ALPHA

Field Summary

Fields

Modifier and Type	Field	Description
static final PatternInfos<Relation>	PATTERNS

Constructor Summary

Constructors

Constructor	Description
CondExprCompare()

Method Summary

Modifier and Type	Method	Description
boolean	check(TriggerContext ctx)
boolean	init(Expression<?>[] expressions, int matchedPattern, ParseContext result)	Initializes this SyntaxElement before being used.
String	toString(TriggerContext ctx, boolean debug)

Methods inherited from class ConditionalExpression

getValues, isNegated, setNegated

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

Field Details

PATTERNS

public static final PatternInfos<Relation> PATTERNS

Constructor Details

CondExprCompare

public CondExprCompare()

Method Details

init

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

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

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

check

public boolean check(TriggerContext ctx)

Specified by:

check in class ConditionalExpression

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