Package ch.njol.skript.expressions

Class ExprNumbers

java.lang.Object
ch.njol.skript.lang.util.SimpleExpression<Number>
ch.njol.skript.expressions.ExprNumbers
All Implemented Interfaces:
Debuggable, Expression<Number>, SyntaxElement
@Name("Numbers") @Description({"All numbers between two given numbers, useful for looping.","Use \'numbers\' if your start is not an integer and you want to keep the fractional part of the start number constant, or use \'integers\' if you only want to loop integers.","You may also use \'decimals\' if you want to use the decimal precision of the start number.","You may want to use the \'times\' expression instead, for instance \'loop 5 times:\'"}) @Examples({"loop numbers from 2.5 to 5.5: # loops 2.5, 3.5, 4.5, 5.5","loop integers from 2.9 to 5.1: # same as \'3 to 5\', i.e. loops 3, 4, 5","loop decimals from 3.94 to 4: # loops 3.94, 3.95, 3.96, 3.97, 3.98, 3.99, 4"}) @Since("1.4.6 (integers & numbers), 2.5.1 (decimals)") public class ExprNumbers extends SimpleExpression<Number>

  • Constructor Details

    • ExprNumbers

      public ExprNumbers()

  • 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 @Nullable Number[] get​(org.bukkit.event.Event event)
      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<Number>
      Parameters:
      event - The event
      Returns:
      An array of values for this event. May not contain nulls.

    • iterator

      public @Nullable Iterator<Number> iterator​(org.bukkit.event.Event event)
      Description copied from interface: Expression
      Returns the same as Expression.getArray(Event) but as an iterator. This method should be overriden by expressions intended to be looped to increase performance.
      Specified by:
      iterator in interface Expression<Number>
      Overrides:
      iterator in class SimpleExpression<Number>
      Parameters:
      event - The event
      Returns:
      An iterator to iterate over all values of this expression which may be empty and/or null, but must not return null elements.

    • isLoopOf

      public boolean isLoopOf​(String s)
      Description copied from interface: Expression
      Checks whether the given 'loop-...' expression should match this loop, e.g. loop-block matches any loops that loop through blocks and loop-argument matches an argument loop.

      You should usually just return false as e.g. loop-block will automatically match the expression if its returnType is Block or a subtype of it.

      Specified by:
      isLoopOf in interface Expression<Number>
      Overrides:
      isLoopOf in class SimpleExpression<Number>
      Parameters:
      s - The entered string
      Returns:
      Whether this loop matches the given string

    • 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 Number> 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