Package ch.njol.skript.expressions

Class ExprElement

java.lang.Object
ch.njol.skript.lang.util.SimpleExpression<Object>
ch.njol.skript.expressions.ExprElement
All Implemented Interfaces:
Debuggable, Expression<Object>, SyntaxElement
@Name("Element of") @Description({"The first, last or a random element of a set, e.g. a list variable.","See also: <a href=\'#ExprRandom\'>random</a>"}) @Examples("give a random element out of {free items::*} to the player") @Since("2.0") public class ExprElement extends SimpleExpression<Object>

  • Constructor Details

    • ExprElement

      public ExprElement()

  • 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 Object[] 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<Object>
      Parameters:
      e - The event
      Returns:
      An array of values for this event. May not contain nulls.

    • 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

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