Class ExprRecursiveSize
java.lang.Object
ch.njol.skript.lang.util.SimpleExpression<Long>
org.skriptlang.skript.common.expressions.ExprRecursiveSize
- All Implemented Interfaces:
Debuggable
,Expression<Long>
,Loopable<Long>
,Simplifiable<Expression<? extends Long>>
,SyntaxElement
,RuntimeErrorProducer
,SyntaxRuntimeErrorProducer
@Name("Recursive Size")
@Description({"The recursive size of list.","Returns the recursive size of the list with sublists included, e.g.","","<pre>","{list::*} Structure<br>"," \u251c\u2500\u2500\u2500\u2500 {list::1}: 1<br>"," \u251c\u2500\u2500\u2500\u2500 {list::2}: 2<br>"," \u2502 \u251c\u2500\u2500\u2500\u2500 {list::2::1}: 3<br>"," \u2502 \u2502 \u2514\u2500\u2500\u2500\u2500 {list::2::1::1}: 4<br>"," \u2502 \u2514\u2500\u2500\u2500\u2500 {list::2::2}: 5<br>"," \u2514\u2500\u2500\u2500\u2500 {list::3}: 6","</pre>","","Where using %size of {list::*}% will only return 3 (the first layer of indices only), while %recursive size of {list::*}% will return 6 (the entire list)","Please note that getting a list\'s recursive size can cause lag if the list is large, so only use this expression if you need to!"})
@Example("if recursive size of {player-data::*} > 1000:")
@Since("1.0")
public class ExprRecursiveSize
extends SimpleExpression<Long>
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected Long @Nullable []
get
(org.bukkit.event.Event event) This is the internal method to get an expression's values.
To get the expression's value from the outside useSimpleExpression.getSingle(Event)
orSimpleExpression.getArray(Event)
.Gets the return type of this expression.boolean
init
(Expression<?>[] expressions, int matchedPattern, Kleenean isDelayed, SkriptParser.ParseResult parseResult) Called just after the constructor andSyntaxElement.preInit()
.boolean
isSingle()
toString
(@Nullable org.bukkit.event.Event event, boolean debug) Methods inherited from class ch.njol.skript.lang.util.SimpleExpression
acceptChange, change, check, check, check, getAll, getAnd, getArray, getConvertedExpr, getConvertedExpression, getNode, getSingle, getSource, getTime, isDefault, isLoopOf, iterator, preInit, setTime, setTime, setTime, setTime, setTime, simplify, supportsLoopPeeking, toString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface ch.njol.skript.lang.Expression
beforeChange, canBeSingle, canReturn, changeInPlace, changeInPlace, getAcceptedChangeModes, getOptionalSingle, getSyntaxTypeName, possibleReturnTypes, stream, streamAll
Methods inherited from interface org.skriptlang.skript.log.runtime.RuntimeErrorProducer
error, error, getRuntimeErrorManager, warning, warning
Methods inherited from interface ch.njol.skript.lang.SyntaxElement
getParser
Methods inherited from interface org.skriptlang.skript.log.runtime.SyntaxRuntimeErrorProducer
getErrorSource
-
Constructor Details
-
ExprRecursiveSize
public ExprRecursiveSize()
-
-
Method Details
-
init
public boolean init(Expression<?>[] expressions, int matchedPattern, Kleenean isDelayed, SkriptParser.ParseResult parseResult) Description copied from interface:SyntaxElement
Called just after the constructor andSyntaxElement.preInit()
.- Parameters:
expressions
- 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 matchedisDelayed
- 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:
-
get
Description copied from class:SimpleExpression
This is the internal method to get an expression's values.
To get the expression's value from the outside useSimpleExpression.getSingle(Event)
orSimpleExpression.getArray(Event)
.- Specified by:
get
in classSimpleExpression<Long>
- Parameters:
event
- The event with which this expression is evaluated.- Returns:
- An array of values for this event. May not contain nulls.
-
isSingle
public boolean isSingle()- Returns:
- true if this expression will ever only return one value at most, false if it can return multiple values.
-
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 byExpression.getArray(Event)
-
toString
- 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
-