Class EffBreakNaturally

All Implemented Interfaces:
Debuggable, SyntaxElement

@Name("Break Block") @Description({"Breaks the block and spawns items as if a player had mined it","\nYou can add a tool, which will spawn items based on how that tool would break the block ","(ie: When using a hand to break stone, it drops nothing, whereas with a pickaxe it drops cobblestone)"}) @Examples({"on right click:","\tbreak clicked block naturally","loop blocks in radius 10 around player:","\tbreak loop-block using player\'s tool","loop blocks in radius 10 around player:","\tbreak loop-block naturally using diamond pickaxe"}) @Since("2.4") public class EffBreakNaturally extends Effect
  • Constructor Details

    • EffBreakNaturally

      public EffBreakNaturally()
  • Method Details

    • init

      public boolean init(Expression<?>[] exprs, int matchedPattern, Kleenean isDelayed, SkriptParser.ParseResult parser)
      Description copied from interface: SyntaxElement
      Called just after the constructor.
      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)
      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...)
    • execute

      protected void execute(org.bukkit.event.Event e)
      Description copied from class: Effect
      Executes this effect.
      Specified by:
      execute in class Effect
    • 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