Class ExprAmount

java.lang.Object

io.github.syst3ms.skriptparser.lang.properties.PropertyExpression<Object,Number>

io.github.syst3ms.skriptparser.expressions.ExprAmount

All Implemented Interfaces:

Expression<Number>, SyntaxElement

public class ExprAmount
extends PropertyExpression<Object,Number>

The amount of elements in a given list. Note that when getting the size of a list variable, it will only return the size of the first layer of elements. If you want to get the whole list size, including nested layers in a variable, use the recursive size instead.

Since:

ALPHA

Field Summary

Fields inherited from class PropertyExpression

PROPERTY_IDENTIFIER

Constructor Summary

Constructors

Constructor	Description
ExprAmount()

Method Summary

Modifier and Type	Method	Description
Number[]	getValues(TriggerContext ctx)	A simple default method that will apply PropertyExpression.getProperty(Object) on the PropertyExpression.owner of this property.
boolean	init(Expression<?> @NotNull [] expressions, int matchedPattern, @NotNull ParseContext parseContext)	This default init() implementation automatically properly sets the owner of this property, which can be accessed using PropertyExpression.getOwner().
String	toString(TriggerContext ctx, boolean debug)

Methods inherited from class PropertyExpression

composePatterns, getOwner, getProperty, isGenitive, isSingle, setOwner, toString

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, iterator, setAndList, stream

Constructor Details

ExprAmount

public ExprAmount()

Method Details

init

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

Description copied from class: PropertyExpression

This default init() implementation automatically properly sets the owner of this property, which can be accessed using PropertyExpression.getOwner(). If this implementation is overridden for one reason or another, it must call PropertyExpression.setOwner(Expression) properly.

Specified by:

init in interface SyntaxElement

Overrides:

init in class PropertyExpression<Object,Number>

Parameters:

expressions - an array of expressions representing all the expressions that are being passed to this syntax element.

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:

whether the initialization was successful or not.

See Also:

• SkriptRegistration
• ParseContext

getValues

public Number[] getValues(TriggerContext ctx)

Description copied from class: PropertyExpression

A simple default method that will apply PropertyExpression.getProperty(Object) on the PropertyExpression.owner of this property.

Specified by:

getValues in interface Expression<Number>

Overrides:

getValues in class PropertyExpression<Object,Number>

Parameters:

ctx - the event

Returns:

the values of this property after applying the PropertyExpression.getProperty(Object) function on the owner.

See Also:

• Expression.getArray(TriggerContext)

toString

public String toString(TriggerContext ctx,
 boolean debug)

Specified by:

toString in interface SyntaxElement

Overrides:

toString in class PropertyExpression<Object,Number>

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