Package org.skriptlang.skript.bukkit.furnace.elements

Class ExprFurnaceEventItems

java.lang.Object
ch.njol.skript.lang.util.SimpleExpression<org.bukkit.inventory.ItemStack>
ch.njol.skript.expressions.base.PropertyExpression<org.bukkit.block.Block,org.bukkit.inventory.ItemStack>
org.skriptlang.skript.bukkit.furnace.elements.ExprFurnaceEventItems
All Implemented Interfaces:
Debuggable, Expression<org.bukkit.inventory.ItemStack>, Loopable<org.bukkit.inventory.ItemStack>, SyntaxElement
@Name("Furnace Event Items") @Description({"Represents the different items in furnace events.","Only \'smelting item\' can be changed."}) @Examples({"on furnace smelt:","\tbroadcast smelted item","\t# Or \'result\'","on furnace extract:","\tbroadcast extracted item","on fuel burn:","\tbroadcast burned fuel","on smelting start:","\tbroadcast smelting item","\tclear smelting item"}) @Events({"smelt","fuel burn","smelting start","furnace extract"}) @Since("2.10") public class ExprFurnaceEventItems extends ch.njol.skript.expressions.base.PropertyExpression<org.bukkit.block.Block,org.bukkit.inventory.ItemStack>

  • Constructor Details

    • ExprFurnaceEventItems

      public ExprFurnaceEventItems()

  • Method Details

    • init

      public boolean init(Expression<?>[] exprs, int matchedPattern, Kleenean isDelayed, SkriptParser.ParseResult parseResult)
      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)
      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.inventory.ItemStack @Nullable [] get(org.bukkit.event.Event event, org.bukkit.block.Block[] source)
      Specified by:
      get in class ch.njol.skript.expressions.base.PropertyExpression<org.bukkit.block.Block,org.bukkit.inventory.ItemStack>

    • acceptChange

      public Class<?> @Nullable [] acceptChange(Changer.ChangeMode mode)
      Description copied from interface: Expression
      Tests whether this expression supports the given mode, and if yes what type it expects the delta to be.

      Use Changer.ChangerUtils.acceptsChange(Expression, ChangeMode, Class...) to test whether an expression supports changing, don't directly use this method!

      Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with super.change(...).

      Unlike Changer.acceptChange(ChangeMode) this method may print errors.

      Specified by:
      acceptChange in interface Expression<org.bukkit.inventory.ItemStack>
      Overrides:
      acceptChange in class SimpleExpression<org.bukkit.inventory.ItemStack>
      Parameters:
      mode - The mode to check
      Returns:
      An array of types that Expression.change(Event, Object[], ChangeMode) accepts as its delta parameter (which can be arrays to denote that multiple of that type are accepted), or null if the given mode is not supported. For Changer.ChangeMode.DELETE and Changer.ChangeMode.RESET this can return any non-null array to mark them as supported.

    • change

      public void change(org.bukkit.event.Event event, Object @Nullable [] delta, Changer.ChangeMode mode)
      Description copied from interface: Expression
      Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by Expression.acceptChange(ChangeMode)
      Specified by:
      change in interface Expression<org.bukkit.inventory.ItemStack>
      Overrides:
      change in class SimpleExpression<org.bukkit.inventory.ItemStack>
      Parameters:
      event - The event
      delta - An array with one or more instances of one or more of the classes returned by Expression.acceptChange(ChangeMode) for the given change mode (null for Changer.ChangeMode.DELETE and Changer.ChangeMode.RESET). This can be a Object[], thus casting is not allowed.
      mode - The Changer.ChangeMode of the attempted change

    • isSingle

      public boolean isSingle()
      Specified by:
      isSingle in interface Expression<org.bukkit.inventory.ItemStack>
      Overrides:
      isSingle in class ch.njol.skript.expressions.base.PropertyExpression<org.bukkit.block.Block,org.bukkit.inventory.ItemStack>
      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.inventory.ItemStack> 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