Class EffBrewingConsume

java.lang.Object
ch.njol.skript.lang.TriggerItem
ch.njol.skript.lang.Statement
ch.njol.skript.lang.Effect
org.skriptlang.skript.bukkit.brewing.elements.EffBrewingConsume
All Implemented Interfaces:
Debuggable, EventRestrictedSyntax, SyntaxElement, RuntimeErrorProducer, SyntaxRuntimeErrorProducer

@Name("Consume Brewing Fuel") @Description("Makes the brewing stand in a brewing fuel event consume its fuel.\nPreventing the fuel from being consumed will keep the fuel item and still add to the fuel level of the brewing stand.\n") @Example("on brewing fuel consumption:\n\tprevent the brewing stand from consuming the fuel\n") @Since("2.13") @Events("Brewing Fuel") public class EffBrewingConsume extends Effect implements EventRestrictedSyntax
  • Constructor Details

    • EffBrewingConsume

      public EffBrewingConsume()
  • Method Details

    • register

      public static void register(SyntaxRegistry registry)
    • init

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

      public Class<? extends org.bukkit.event.Event>[] supportedEvents()
      Description copied from interface: EventRestrictedSyntax
      Returns all supported events for this syntax element.

      Before SyntaxElement.init(Expression[], int, Kleenean, SkriptParser.ParseResult) is called, checks to see if the current event is supported by this syntax element. If it is not, an error will be printed and the syntax element will not be initialised.

      Specified by:
      supportedEvents in interface EventRestrictedSyntax
      Returns:
      All supported event classes.
      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)
      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