Package me.mrCookieSlime.Slimefun.Objects.handlers

Interface BlockDispenseHandler

All Superinterfaces:

ItemHandler

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface BlockDispenseHandler
extends ItemHandler

This ItemHandler is triggered when the SlimefunItem it was assigned to is a Dispenser and was triggered. This ItemHandler is used for the BlockPlacer.

Author:

TheBusyBiscuit

See Also:

ItemHandler, BlockPlacer

Method Summary

Modifier and Type	Method	Description
default Class<? extends ItemHandler>	getIdentifier()	This method returns the identifier for this ItemHandler.
void	onBlockDispense(BlockDispenseEvent e, Dispenser dispenser, Block facedBlock, SlimefunItem machine)
default Optional<IncompatibleItemHandlerException>	validate(SlimefunItem item)	This method is used to check whether a given SlimefunItem is compatible with this ItemHandler, it will return an IncompatibleItemHandlerException if the items are not compatible.

Methods inherited from interface me.mrCookieSlime.Slimefun.Objects.handlers.ItemHandler

isPrivate

Method Detail

validate

default Optional<IncompatibleItemHandlerException> validate(SlimefunItem item)

Description copied from interface: ItemHandler

This method is used to check whether a given SlimefunItem is compatible with this ItemHandler, it will return an IncompatibleItemHandlerException if the items are not compatible.

Specified by:

validate in interface ItemHandler

Parameters:

item - The SlimefunItem to validate

Returns:

An Optional describing the result, it will contain an IncompatibleItemHandlerException should there be an issue

onBlockDispense

void onBlockDispense(BlockDispenseEvent e,
                     Dispenser dispenser,
                     Block facedBlock,
                     SlimefunItem machine)

getIdentifier

default Class<? extends ItemHandler> getIdentifier()

Description copied from interface: ItemHandler

This method returns the identifier for this ItemHandler. We use a Class identifier to group Item Handlers together.

Specified by:

getIdentifier in interface ItemHandler

Returns:

The Class identifier for this ItemHandler