Class ExprArgument

java.lang.Object
ch.njol.skript.lang.util.SimpleExpression<Object>
org.skriptlang.skript.bukkit.command.elements.expressions.ExprArgument
All Implemented Interfaces:
Debuggable, EventRestrictedSyntax, Expression<Object>, Loopable<Object>, Simplifiable<Expression<? extends Object>>, SyntaxElement, RuntimeErrorProducer, SyntaxRuntimeErrorProducer
@Name("Argument") @Description("A user provided value in a command execution.\nFor example, if the command \"/tell <player> <text>\" is used like \"/tell Njol Hello Njol!\", 'argument 1' is the player named \"Njol\" and 'argument 2' is the text \"Hello Njol!\".\nOne can also use the type of the argument instead of its index to address the argument.\nFor example, in the command example above, 'player-argument' is the same as 'argument 1'.\nUsable in script commands and command events.\nPlease note that specifying the argument type is only supported in script commands.\n") @Example("give the item-argument to the player-argument") @Example("damage the player-argument by the number-argument") @Example("give a diamond pickaxe to the argument") @Example("add argument 1 to argument 2") @Example("heal the last argument") @Since({"1.0","2.7 (support for command events)"}) public class ExprArgument extends SimpleExpression<Object> implements EventRestrictedSyntax

  • Field Details

    • argument

      @Internal @Nullable public @Nullable ArgumentData<?> argument

  • Constructor Details

    • ExprArgument

      public ExprArgument()

  • Method Details

    • register

      public static void register(SyntaxRegistry syntaxRegistry)

    • init

      public boolean init(Expression<?>[] exprs, int matchedPattern, Kleenean isDelayed, SkriptParser.ParseResult parseResult)
      Description copied from interface: SyntaxElement
      Called just after the constructor and SyntaxElement.preInit().
      Specified by:
      init in interface SyntaxElement
      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:

    • supportedEvents

      public Class<? extends org.bukkit.event.Event>[] supportedEvents()
      Description copied from interface: EventRestrictedSyntax
      Returns all supported events for this syntax element.

      Before SyntaxElement.init(Expression[], int, Kleenean, SkriptParser.ParseResult) is called, checks to see if the current event is supported by this syntax element. If it is not, an error will be printed and the syntax element will not be initialised.

      Specified by:
      supportedEvents in interface EventRestrictedSyntax
      Returns:
      All supported event classes.
      See Also:

    • get

      protected Object @Nullable [] 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<Object>
      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()
      Specified by:
      isSingle in interface Expression<Object>
      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.
      Specified by:
      getReturnType in interface Expression<Object>
      Returns:
      A supertype of any objects returned by Expression.getSingle(Event) and the component type of any arrays returned by Expression.getArray(Event)

    • isLoopOf

      public boolean isLoopOf(String input)
      Description copied from interface: Loopable
      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 Loopable<Object>
      Overrides:
      isLoopOf in class SimpleExpression<Object>
      Parameters:
      input - The entered input string (the blank in loop-___)
      Returns:
      Whether this loop matches the given string

    • toString

      public String toString(@Nullable @Nullable org.bukkit.event.Event event, boolean debug)
      Specified by:
      toString in interface Debuggable
      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

    • couldCauseArithmeticConfusion

      public boolean couldCauseArithmeticConfusion()
      Returns:
      whether the expression is 'arg', a single argument that could cause confusion with 'arg-1' being parsed as 'argument - 1'.