Package ch.njol.skript.expressions

Class ExprXOf

java.lang.Object
ch.njol.skript.lang.util.SimpleExpression<T>
ch.njol.skript.expressions.base.PropertyExpression<Object,​Object>
ch.njol.skript.expressions.ExprXOf
All Implemented Interfaces:
Debuggable, Expression<Object>, SyntaxElement
@Name("X of Item") @Description("An expression to be able to use a certain amount of items where the amount can be any expression. Please note that this expression is not stable and might be replaced in the future.") @Examples("give level of player of pickaxes to the player") @Since("1.2") public class ExprXOf extends PropertyExpression<Object,​Object>

  • Constructor Details

    • ExprXOf

      public ExprXOf()

  • 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 Object[] get​(org.bukkit.event.Event e, Object[] source)
      Description copied from class: PropertyExpression
      Converts the given source object(s) to the correct type.

      Please note that the returned array must neither be null nor contain any null elements!

      Specified by:
      get in class PropertyExpression<Object,​Object>
      Returns:
      An array of the converted objects, which may contain less elements than the source array, but must not be null.
      See Also:
      Converters.convert(Object[], Class, Converter)

    • getConvertedExpression

      public <R> @Nullable Expression<? extends R> getConvertedExpression​(Class<R>... to)
      Description copied from class: SimpleExpression
      Usually, you want to override SimpleExpression.getConvertedExpr(Class[]). However, it may be useful to override this method if you have an expression with a return type that is unknown until runtime (like variables). Usually, you'll be fine with just the default implementation. This method is final on versions below 2.2-dev36.
      Specified by:
      getConvertedExpression in interface Expression<Object>
      Overrides:
      getConvertedExpression in class SimpleExpression<Object>
      Parameters:
      to - The desired return type of the returned expression
      Returns:
      The converted expression
      See Also:
      Converter, ConvertedExpression

    • getReturnType

      public Class<?> 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