Class ExprCommandInfo

java.lang.Object
ch.njol.skript.lang.util.SimpleExpression<String>
org.skriptlang.skript.bukkit.command.elements.expressions.ExprCommandInfo
All Implemented Interfaces:
Debuggable, Expression<String>, Loopable<String>, Simplifiable<Expression<? extends String>>, SyntaxElement, RuntimeErrorProducer, SyntaxRuntimeErrorProducer
@Name("Command Info") @Description("Get information about a command.") @Example("main command label of command \"skript\"") @Example("description of command \"help\"") @Example("label of command \"pl\"") @Example("usage of command \"help\"") @Example("aliases of command \"bukkit:help\"") @Example("permission of command \"/op\"") @Example("command \"sk\"'s plugin owner") @Example("command /greet <player>:\n\tusage: /greet <target>\n\ttrigger:\n\t\tif arg-1 is sender:\n\t\t\tsend \"&cYou can't greet yourself! Usage: %the usage%\"\n\t\t\tstop\n\t\tsend \"%sender% greets you!\" to arg-1\n\t\tsend \"You greeted %arg-1%!\"\n") @Since("2.6") public class ExprCommandInfo extends SimpleExpression<String>

  • Constructor Details

    • ExprCommandInfo

      public ExprCommandInfo()

  • 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().
      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:

    • get

      protected String[] 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<String>
      Parameters:
      event - The event with which this expression is evaluated.
      Returns:
      An array of values for this event. May not contain nulls.

    • iterator

      @Nullable public @Nullable Iterator<? extends String> iterator(org.bukkit.event.Event event)
      Description copied from class: SimpleExpression
      Returns the same as Expression.getArray(Event) but as an iterator. This method should be overridden by expressions intended to be looped to increase performance. Overriding this method, returning an Iterator, ensure to override Loopable.supportsLoopPeeking() Or returning an PeekingIterator, ensure to set up PeekingIterator.peek()
      Specified by:
      iterator in interface Loopable<String>
      Overrides:
      iterator in class SimpleExpression<String>
      Parameters:
      event - The event to be used for evaluation
      Returns:
      ArrayIterator
      See Also:

    • stream

      public Stream<? extends String> stream(org.bukkit.event.Event event)
      Description copied from interface: Expression
      Gets a non-null stream of this expression's values.
      Parameters:
      event - The event
      Returns:
      A non-null stream of this expression's non-null values

    • 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 String> 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 @Nullable org.bukkit.event.Event event, boolean debug)
      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