Package io.github.thebusybiscuit.slimefun4.implementation.items.autocrafters

Class AbstractAutoCrafter

java.lang.Object

io.github.thebusybiscuit.slimefun4.api.items.SlimefunItem

io.github.thebusybiscuit.slimefun4.implementation.items.autocrafters.AbstractAutoCrafter

All Implemented Interfaces:

EnergyNetComponent, ItemAttribute, Placeable

Direct Known Subclasses:

SlimefunAutoCrafter, VanillaAutoCrafter

public abstract class AbstractAutoCrafter
extends SlimefunItem
implements EnergyNetComponent

This is the abstract super class for our auto crafters.

Author:

TheBusyBiscuit

See Also:

• VanillaAutoCrafter
• EnhancedAutoCrafter

Field Summary

Fields

Modifier and Type	Field	Description
protected final int[]	background
protected final org.bukkit.NamespacedKey	recipeEnabledKey	The NamespacedKey used to determine whether the recipe is enabled.
protected final org.bukkit.NamespacedKey	recipeStorageKey	The NamespacedKey used to store recipe data.

Fields inherited from class io.github.thebusybiscuit.slimefun4.api.items.SlimefunItem

addon, disenchantable, enchantable, hidden, recipeOutput, useableInWorkbench

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractAutoCrafter(ItemGroup itemGroup, SlimefunItemStack item, RecipeType recipeType, org.bukkit.inventory.ItemStack[] recipe)

Method Summary

Modifier and Type	Method	Description
boolean	craft(CrafterInteractable inv, AbstractRecipe recipe)	This method performs a crafting operation.
int	getCapacity()	This method returns the max amount of electricity this machine can hold.
final EnergyNetComponentType	getEnergyComponentType()	This method returns the Type of EnergyNetComponentType this SlimefunItem represents.
int	getEnergyConsumption()	This method returns the amount of energy that is consumed per operation.
abstract AbstractRecipe	getSelectedRecipe(org.bukkit.block.Block b)	This method returns the currently selected AbstractRecipe for the given Block.
protected boolean	isValidInventory(org.bukkit.block.Block block)	This method checks if the given Block has a valid Inventory where the Auto Crafter could be placed upon.
protected boolean	matches(org.bukkit.inventory.ItemStack item, Predicate<org.bukkit.inventory.ItemStack> predicate)	This method checks whether the given Predicate matches the provided ItemStack.
boolean	matchesAny(org.bukkit.inventory.Inventory inv, Map<Integer,Integer> itemQuantities, Predicate<org.bukkit.inventory.ItemStack> predicate)
void	onRightClick(org.bukkit.block.Block b, org.bukkit.entity.Player p)	This method handles our right-clicking behaviour.
void	postRegister()	This method is called after SlimefunItem.register(SlimefunAddon).
void	register(SlimefunAddon addon)	This method registers this SlimefunItem.
final AbstractAutoCrafter	setCapacity(int capacity)	This sets the energy capacity for this machine.
final AbstractAutoCrafter	setEnergyConsumption(int energyConsumption)	This method sets the energy consumed by this machine per tick.
protected void	setSelectedRecipe(org.bukkit.block.Block b, AbstractRecipe recipe)	This method sets the selected AbstractRecipe for the given Block.
protected void	showRecipe(org.bukkit.entity.Player p, org.bukkit.block.Block b, AbstractRecipe recipe)	This shows the given AbstractRecipe to the Player in a preview window.
protected void	tick(org.bukkit.block.Block b, SlimefunBlockData data)	This method performs one tick for the AbstractAutoCrafter.
protected abstract void	updateRecipe(org.bukkit.block.Block b, org.bukkit.entity.Player p)	This method is called when a Player right clicks the AbstractAutoCrafter while holding the shift button.

Methods inherited from class io.github.thebusybiscuit.slimefun4.api.items.SlimefunItem

addItemHandler, addItemSetting, addOfficialWikipage, addWikiPage, callItemHandler, canUse, disable, enable, equals, error, getAddon, getBlockTicker, getById, getByItem, getDrops, getDrops, getHandlers, getId, getItem, getItemGroup, getItemName, getItemSetting, getItemSettings, getOptionalById, getOptionalByItem, getRecipe, getRecipeOutput, getRecipeType, getResearch, getState, getWikipage, hashCode, hasResearch, info, isDisabled, isDisabledIn, isDisenchantable, isEnchantable, isHidden, isItem, isItemStackImmutable, isTicking, isUseableInWorkbench, load, loadDataByDefault, preRegister, sendDeprecationWarning, setHidden, setItemGroup, setRecipe, setRecipeOutput, setRecipeType, setResearch, setUseableInWorkbench, toString, warn

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.github.thebusybiscuit.slimefun4.core.attributes.EnergyNetComponent

addCharge, getCharge, getCharge, getCharge, isChargeable, removeCharge, setCharge

Methods inherited from interface io.github.thebusybiscuit.slimefun4.core.attributes.ItemAttribute

getId

Methods inherited from interface io.github.thebusybiscuit.slimefun4.core.attributes.Placeable

useVanillaBlockBreaking

Field Details

recipeStorageKey

protected final org.bukkit.NamespacedKey recipeStorageKey

The NamespacedKey used to store recipe data.

recipeEnabledKey

protected final org.bukkit.NamespacedKey recipeEnabledKey

The NamespacedKey used to determine whether the recipe is enabled.

background

protected final int[] background

Constructor Details

AbstractAutoCrafter

@ParametersAreNonnullByDefault
protected AbstractAutoCrafter(ItemGroup itemGroup,
 SlimefunItemStack item,
 RecipeType recipeType,
 org.bukkit.inventory.ItemStack[] recipe)

Method Details

postRegister

public void postRegister()

Description copied from class: SlimefunItem

This method is called after SlimefunItem.register(SlimefunAddon). Override this method to add any additional setup that needs to happen after the original registration of this SlimefunItem.

Overrides:

postRegister in class SlimefunItem

onRightClick

@ParametersAreNonnullByDefault
public void onRightClick(org.bukkit.block.Block b,
 org.bukkit.entity.Player p)

This method handles our right-clicking behaviour.

Do not call this method directly, see our AutoCrafterListener for the intended use case.

Parameters:

b - The Block that was clicked

p - The Player who clicked

tick

protected void tick(@Nonnull
 org.bukkit.block.Block b,
 @Nonnull
 SlimefunBlockData data)

This method performs one tick for the AbstractAutoCrafter.

Parameters:

b - The block for this AbstractAutoCrafter

data - The data stored on this block

matches

@ParametersAreNonnullByDefault
protected boolean matches(org.bukkit.inventory.ItemStack item,
 Predicate<org.bukkit.inventory.ItemStack> predicate)

This method checks whether the given Predicate matches the provided ItemStack.

Parameters:

item - The ItemStack to check

predicate - The Predicate

Returns:

Whether the Predicate matches the ItemStack

matchesAny

@ParametersAreNonnullByDefault
public boolean matchesAny(org.bukkit.inventory.Inventory inv,
 Map<Integer,Integer> itemQuantities,
 Predicate<org.bukkit.inventory.ItemStack> predicate)

isValidInventory

protected boolean isValidInventory(@Nonnull
 org.bukkit.block.Block block)

This method checks if the given Block has a valid Inventory where the Auto Crafter could be placed upon. Right now this only supports chests and a few select tile entities but it can change or be overridden in the future.

Parameters:

block - The Block to check

Returns:

Whether that Block has a valid Inventory

getSelectedRecipe

@Nullable
public abstract AbstractRecipe getSelectedRecipe(@Nonnull
 org.bukkit.block.Block b)

This method returns the currently selected AbstractRecipe for the given Block.

Parameters:

b - The Block

Returns:

The currently selected AbstractRecipe or null

updateRecipe

protected abstract void updateRecipe(@Nonnull
 org.bukkit.block.Block b,
 @Nonnull
 org.bukkit.entity.Player p)

This method is called when a Player right clicks the AbstractAutoCrafter while holding the shift button. Use it to choose the AbstractRecipe.

Parameters:

b - The Block which was clicked

p - The Player who clicked

setSelectedRecipe

protected void setSelectedRecipe(@Nonnull
 org.bukkit.block.Block b,
 @Nullable
 AbstractRecipe recipe)

This method sets the selected AbstractRecipe for the given Block. The recipe will be stored using the PersistentDataAPI.

Parameters:

b - The Block to store the data on

recipe - The AbstractRecipe to select

showRecipe

@ParametersAreNonnullByDefault
protected void showRecipe(org.bukkit.entity.Player p,
 org.bukkit.block.Block b,
 AbstractRecipe recipe)

This shows the given AbstractRecipe to the Player in a preview window.

Parameters:

p - The Player

b - The Block of the AbstractAutoCrafter

recipe - The AbstractRecipe to show them

craft

public boolean craft(@Nonnull
 CrafterInteractable inv,
 @Nonnull
 AbstractRecipe recipe)

This method performs a crafting operation. It will attempt to fulfill the provided AbstractRecipe using the given Inventory. This will consume items and add the result to the Inventory. This method does not handle energy consumption.

Parameters:

inv - The Inventory to take resources from

recipe - The AbstractRecipe to craft

Returns:

Whether this crafting operation was successful or not

getCapacity

public int getCapacity()

This method returns the max amount of electricity this machine can hold.

Specified by:

getCapacity in interface EnergyNetComponent

Returns:

The max amount of electricity this Block can store.

getEnergyConsumption

public int getEnergyConsumption()

This method returns the amount of energy that is consumed per operation.

Returns:

The rate of energy consumption

setCapacity

@Nonnull
public final AbstractAutoCrafter setCapacity(int capacity)

This sets the energy capacity for this machine. This method must be called before registering the item and only before registering.

Parameters:

capacity - The amount of energy this machine can store

Returns:

This method will return the current instance of AContainer, so that it can be chained.

setEnergyConsumption

@Nonnull
public final AbstractAutoCrafter setEnergyConsumption(int energyConsumption)

This method sets the energy consumed by this machine per tick.

Parameters:

energyConsumption - The energy consumed per tick

Returns:

This method will return the current instance of AContainer, so that it can be chained.

register

public void register(@Nonnull
 SlimefunAddon addon)

Description copied from class: SlimefunItem

This method registers this SlimefunItem. Always call this method after your SlimefunItem has been initialized. Never call it more than once!

Overrides:

register in class SlimefunItem

Parameters:

addon - The SlimefunAddon that this SlimefunItem belongs to.

getEnergyComponentType

public final EnergyNetComponentType getEnergyComponentType()

Description copied from interface: EnergyNetComponent

This method returns the Type of EnergyNetComponentType this SlimefunItem represents. It describes how this Block will interact with an EnergyNet.

Specified by:

getEnergyComponentType in interface EnergyNetComponent

Returns:

The EnergyNetComponentType this SlimefunItem represents.