java.lang.Object
ch.njol.skript.lang.util.SimpleExpression<org.bukkit.Tag>
org.skriptlang.skript.bukkit.tags.elements.ExprTag
All Implemented Interfaces:
Debuggable, Expression<org.bukkit.Tag>, Loopable<org.bukkit.Tag>, SyntaxElement, RuntimeErrorProducer, SyntaxRuntimeErrorProducer

@Name("Tag") @Description({"Represents a tag which can be used to classify items, blocks, or entities.","Tags are composed of a value and an optional namespace: \"minecraft:oak_logs\".","If you omit the namespace, one will be provided for you, depending on what kind of tag you\'re using. For example, `tag \"doors\"` will be the tag \"minecraft:doors\", while `paper tag \"doors\"` will be \"paper:doors\".","`minecraft tag` will search through the vanilla tags, `datapack tag` will search for datapack-provided tags (a namespace is required here!), `paper tag` will search for Paper\'s custom tags if you are running Paper, and `custom tag` will look in the \"skript\" namespace for custom tags you\'ve registered.","You can also filter by tag types using \"item\", \"block\", or \"entity\"."}) @Examples({"minecraft tag \"dirt\" # minecraft:dirt","paper tag \"doors\" # paper:doors","tag \"skript:custom_dirt\" # skript:custom_dirt","custom tag \"dirt\" # skript:dirt","datapack block tag \"dirt\" # minecraft:dirt","datapack tag \"my_pack:custom_dirt\" # my_pack:custom_dirt","tag \"minecraft:mineable/pickaxe\" # minecraft:mineable/pickaxe","custom item tag \"blood_magic_sk/can_sacrifice_with\" # skript:blood_magic_sk/can_sacrifice_with"}) @Since("2.10") @RequiredPlugins("Paper (paper tags)") @Keywords({"blocks","minecraft tag","type","category"}) public class ExprTag extends SimpleExpression<org.bukkit.Tag> implements SyntaxRuntimeErrorProducer
  • Constructor Details

    • ExprTag

      public ExprTag()
  • Method Details

    • init

      public boolean init(Expression<?>[] expressions, int matchedPattern, Kleenean isDelayed, SkriptParser.ParseResult parseResult)
      Description copied from interface: SyntaxElement
      Called just after the constructor.
      Specified by:
      init in interface SyntaxElement
      Parameters:
      expressions - 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 org.bukkit.Tag<?> @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<org.bukkit.Tag>
      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<org.bukkit.Tag>
      Returns:
      true if this expression will ever only return one value at most, false if it can return multiple values.
    • getReturnType

      public Class<? extends org.bukkit.Tag> getReturnType()
      Description copied from interface: Expression
      Gets the return type of this expression.
      Specified by:
      getReturnType in interface Expression<org.bukkit.Tag>
      Returns:
      A supertype of any objects returned by Expression.getSingle(Event) and the component type of any arrays returned by Expression.getArray(Event)
    • getNode

      public Node getNode()
      Description copied from interface: SyntaxRuntimeErrorProducer
      Returns the source Node for any errors the implementing class emits.
      Used for accessing the line contents via Node.getKey() and the line number via Node.getLine().
      A standard implementation is to store the Node during SyntaxElement.init(Expression[], int, Kleenean, SkriptParser.ParseResult) via ParserInstance.getNode().
      Specified by:
      getNode in interface SyntaxRuntimeErrorProducer
      Returns:
      The source that produced a runtime error.
    • 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
    • simplify

      public Expression<? extends org.bukkit.Tag> simplify()
      Description copied from interface: Expression
      Simplifies the expression, e.g. if it only contains literals the expression may be simplified to a literal, and wrapped expressions are unwrapped.

      After this method was used the toString methods are likely not useful anymore.

      This method is not yet used but will be used to improve efficiency in the future.

      Specified by:
      simplify in interface Expression<org.bukkit.Tag>
      Overrides:
      simplify in class SimpleExpression<org.bukkit.Tag>
      Returns:
      A reference to a simpler version of this expression. Can change this expression directly and return itself if applicable, i.e. no references to the expression before this method call should be kept!