Package ch.njol.skript.expressions

Class ExprIdOf

java.lang.Object
ch.njol.skript.lang.util.SimpleExpression<T>
ch.njol.skript.expressions.base.PropertyExpression<ItemType,​Long>
ch.njol.skript.expressions.ExprIdOf
All Implemented Interfaces:
Debuggable, Expression<Long>, SyntaxElement
@Name("Id") @Description("The id of a specific item. You usually don\'t need this expression as you can likely do everything with aliases.") @Examples("message \"the ID of %type of the clicked block% is %id of the clicked block%.\"") @Since("1.0") public class ExprIdOf extends PropertyExpression<ItemType,​Long>

  • Constructor Details

    • ExprIdOf

      public ExprIdOf()

  • Method Details

    • init

      public boolean init​(Expression<?>[] vars, int matchedPattern, Kleenean isDelayed, SkriptParser.ParseResult parser)
      Description copied from interface: SyntaxElement
      Called just after the constructor.
      Parameters:
      vars - 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)
      parser - 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 Long[] get​(org.bukkit.event.Event e, ItemType[] 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<ItemType,​Long>
      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)

    • 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

    • acceptChange

      public @Nullable Class<?>[] acceptChange​(Changer.ChangeMode mode)
      Description copied from interface: Expression
      Tests whether this expression supports the given mode, and if yes what type it expects the delta to be.

      Use Changer.ChangerUtils.acceptsChange(Expression, ChangeMode, Class...) to test whether an expression supports changing, don't directly use this method!

      Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with super.change(...).

      Unlike Changer.acceptChange(ChangeMode) this method may print errors.

      Specified by:
      acceptChange in interface Expression<Long>
      Overrides:
      acceptChange in class SimpleExpression<Long>
      Returns:
      An array of types that Expression.change(Event, Object[], ChangeMode) accepts as its delta parameter (which can be arrays to denote that multiple of that type are accepted), or null if the given mode is not supported. For Changer.ChangeMode.DELETE and Changer.ChangeMode.RESET this can return any non-null array to mark them as supported.

    • change

      public void change​(org.bukkit.event.Event e, @Nullable Object[] delta, Changer.ChangeMode mode)
      Description copied from interface: Expression
      Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by Expression.acceptChange(ChangeMode)
      Specified by:
      change in interface Expression<Long>
      Overrides:
      change in class SimpleExpression<Long>
      delta - An array with one or more instances of one or more of the the classes returned by Expression.acceptChange(ChangeMode) for the given change mode (null for Changer.ChangeMode.DELETE and Changer.ChangeMode.RESET). This can be a Object[], thus casting is not allowed.

    • iterator

      public @Nullable Iterator<Long> iterator​(org.bukkit.event.Event e)
      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<Long>
      Overrides:
      iterator in class SimpleExpression<Long>
      Parameters:
      e - 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.

    • getReturnType

      public Class<Long> 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)

    • 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<Long>
      Overrides:
      isLoopOf in class SimpleExpression<Long>
      Parameters:
      s - The entered string
      Returns:
      Whether this loop matches the given string