Class EffRegisterTag

All Implemented Interfaces:
Debuggable, SyntaxElement

@Name("Register Tag") @Description({"Registers a new tag containing either items or entity datas. Note that items will NOT keep any information other than their type, so adding `diamond sword named \"test\"` to a tag is the same as adding `diamond sword`","Item tags should be used for contexts where the item is not placed down, while block tags should be used for contexts where the item is placed. For example, and item tag could be \"skript:edible\", while a block tag would be \"skript:needs_water_above\".","All custom tags will be given the namespace \"skript\", followed by the name you give it. The name must only include the characters A to Z, 0 to 9, and \'/\', \'.\', \'_\', and \'-\'. Otherwise, the tag will not register.","","Please note that two tags can share a name if they are of different types. Registering a new tag of the same name and type will overwrite the existing tag. Tags will reset on server shutdown."}) @Examples({"register a new custom entity tag named \"fish\" using cod, salmon, tropical fish, and pufferfish","register an item tag named \"skript:wasp_weapons/swords\" containing diamond sword and netherite sword","register block tag named \"pokey\" containing sweet berry bush and bamboo sapling","","on player move:","\tblock at player is tagged as tag \"skript:pokey\"","\tdamage the player by 1 heart"}) @Since("2.10") @Keywords({"blocks","minecraft tag","type","category"}) public class EffRegisterTag extends Effect
  • Constructor Details

    • EffRegisterTag

      public EffRegisterTag()
  • 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:
    • execute

      protected void execute(org.bukkit.event.Event event)
      Description copied from class: Effect
      Executes this effect.
      Specified by:
      execute in class Effect
      Parameters:
      event - The event with which this effect will be executed
    • 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