Package ch.njol.skript.expressions

Class ExprAmount

java.lang.Object
ch.njol.skript.lang.util.SimpleExpression<Long>
ch.njol.skript.expressions.ExprAmount
All Implemented Interfaces:
Debuggable, Expression<Long>, SyntaxElement
@Name("Amount") @Description({"The amount of something.","Please note that <code>amount of %items%</code> will not return the number of items, but the number of stacks, e.g. 1 for a stack of 64 torches. To get the amount of items in a stack, see the <a href=\'#ExprItemAmount\'>item amount</a> expression.","","Also, you can get the recursive size of a list, which will return 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!"}) @Examples("message \"There are %number of all players% players online!\"") @Since("1.0") public class ExprAmount extends SimpleExpression<Long>
TODO should 'amount of [item]' return the size of the stack?

  • Constructor Details

    • ExprAmount

      public ExprAmount()

  • Method Details

    • init

      public boolean init​(Expression<?>[] exprs, int matchedPattern, Kleenean isDelayed, SkriptParser.ParseResult parseResult)
      Description copied from interface: SyntaxElement
      Called just after the constructor.
      Parameters:
      exprs - 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 matched
      isDelayed - 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:
      ParserInstance.isCurrentEvent(Class...)

    • get

      protected Long[] get​(org.bukkit.event.Event e)
      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 use SimpleExpression.getSingle(Event) or SimpleExpression.getArray(Event).
      Specified by:
      get in class SimpleExpression<Long>
      Parameters:
      e - The event
      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

      public Class<? extends Long> 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 by Expression.getArray(Event)

    • toString

      public String toString​(@Nullable org.bukkit.event.Event e, boolean debug)
      Parameters:
      e - The event to get information to. 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