Class ExprTagsOfType

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

@Name("All Tags of a Type") @Description({"Returns all the tags.","`minecraft tag` will return only the vanilla tags, `datapack tag` will return only datapack-provided tags, `paper tag` will return only 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({"broadcast minecraft tags","send paper entity tags","broadcast all block tags"}) @Since("2.10") @RequiredPlugins("Paper (paper tags)") @Keywords({"blocks","minecraft tag","type","category"}) public class ExprTagsOfType extends SimpleExpression<org.bukkit.Tag>
  • Constructor Details

    • ExprTagsOfType

      public ExprTagsOfType()
  • 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.
      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()
      Returns:
      true if this expression will ever only return one value at most, false if it can return multiple values.
    • getReturnType

      public Class<org.bukkit.Tag> 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