Class ContextExpression<C extends TriggerContext, T>

java.lang.Object

io.github.syst3ms.skriptparser.lang.base.ContextExpression<C,T>

Type Parameters:

C - the TriggerContext class

T - the Expression's type

All Implemented Interfaces:

Expression<T>, SyntaxElement

public class ContextExpression<C extends TriggerContext, T>
extends Object
implements Expression<T>

An Expression that corresponds to a contextual value. Each trigger can carry multiple instances of data (called 'context values'). This expression holds a reference to such value.

Constructor Summary

Constructors

Constructor	Description
ContextExpression(ContextValue<C,T> info, String value, boolean alone)

Method Summary

Modifier and Type	Method	Description
Class<? extends T>	getReturnType()
T[]	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.
boolean	isSingle()
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, getSingle, getSource, isAndList, isLoopOf, iterator, setAndList, stream

Constructor Details

ContextExpression

public ContextExpression(ContextValue<C,T> info,
 String value,
 boolean alone)

Method Details

init

@Contract("_, _, _ -> fail")
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 T[] 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<C extends TriggerContext>

Parameters:

ctx - the event

Returns:

an array of the values

See Also:

• Expression.getArray(TriggerContext)

isSingle

public boolean isSingle()

Specified by:

isSingle in interface Expression<C extends TriggerContext>

Returns:

whether this expression returns a single value. By default, this is defined on registration, but it can be overridden.

getReturnType

public Class<? extends T> getReturnType()

Specified by:

getReturnType in interface Expression<C extends TriggerContext>

Returns:

the return type of this expression. By default, this is defined on registration, but, like Expression.isSingle(), can be overriden.

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