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

Class GoldPan

java.lang.Object

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

io.github.thebusybiscuit.slimefun4.implementation.items.SimpleSlimefunItem<ItemUseHandler>

io.github.thebusybiscuit.slimefun4.implementation.items.tools.GoldPan

All Implemented Interfaces:

ItemAttribute, Placeable, RecipeDisplayItem

Direct Known Subclasses:

NetherGoldPan

public class GoldPan
extends SimpleSlimefunItem<ItemUseHandler>
implements RecipeDisplayItem

A GoldPan is a SlimefunItem which allows you to obtain various resources from Gravel.

Author:

TheBusyBiscuit, svr333, JustAHuman

See Also:

• NetherGoldPan
• AutomatedPanningMachine
• ElectricGoldPan

Field Summary

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

addon, disenchantable, enchantable, hidden, recipeOutput, useableInWorkbench

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
List<org.bukkit.inventory.ItemStack>	getDisplayRecipes()	This is the list of items to display alongside this SlimefunItem.
protected Set<GoldPanDrop>	getGoldPanDrops()	This method returns the target GoldPanDrops for this GoldPan.
org.bukkit.Material	getInputMaterial()	Deprecated. since RC-36 Use getInputMaterials() instead.
Set<org.bukkit.Material>	getInputMaterials()	This method returns the target Materials for this GoldPan.
ItemUseHandler	getItemHandler()	This returns the ItemHandler that will be added to this SlimefunItem.
String	getLabelLocalPath()
org.bukkit.inventory.ItemStack	getRandomOutput()	This returns a random output ItemStack that can be obtained via this GoldPan.
boolean	isValidInput(org.bukkit.inventory.ItemStack itemStack)	This returns whether the GoldPan accepts the ItemStack as an input
boolean	isValidInputMaterial(org.bukkit.Material material)	This returns whether the GoldPan accepts the Material as an input
EntityInteractHandler	onEntityInteract()	This method cancels EntityInteractHandler to prevent interacting GoldPan with entities.
void	postRegister()	This method is called after SlimefunItem.register(SlimefunAddon).
void	updateRandomizer()	Do not call this method directly.

Methods inherited from class io.github.thebusybiscuit.slimefun4.implementation.items.SimpleSlimefunItem

preRegister

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, register, 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.ItemAttribute

getId

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

useVanillaBlockBreaking

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

getRecipeSectionLabel

Constructor Details

GoldPan

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

Method Details

getInputMaterial

@Deprecated(since="RC-36")
public org.bukkit.Material getInputMaterial()

Deprecated.

since RC-36 Use getInputMaterials() instead.

getInputMaterials

@Nonnull
public Set<org.bukkit.Material> getInputMaterials()

This method returns the target Materials for this GoldPan.

Returns:

The Set of Materials this GoldPan can be used on.

getGoldPanDrops

@Nonnull
protected Set<GoldPanDrop> getGoldPanDrops()

This method returns the target GoldPanDrops for this GoldPan.

Returns:

The Set of GoldPanDrops this GoldPan can drop.

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

updateRandomizer

public void updateRandomizer()

Do not call this method directly.

This method is for internal purposes only. It will update and re-calculate all weights in our RandomizedSet.

getRandomOutput

@Nonnull
public org.bukkit.inventory.ItemStack getRandomOutput()

This returns a random output ItemStack that can be obtained via this GoldPan.

Returns:

a random ItemStack obtained by this GoldPan

getLabelLocalPath

@Nonnull
public String getLabelLocalPath()

Specified by:

getLabelLocalPath in interface RecipeDisplayItem

getItemHandler

@Nonnull
public ItemUseHandler getItemHandler()

Description copied from class: SimpleSlimefunItem

This returns the ItemHandler that will be added to this SlimefunItem.

Specified by:

getItemHandler in class SimpleSlimefunItem<ItemUseHandler>

Returns:

The ItemHandler that should be added to this SlimefunItem

onEntityInteract

@Nonnull
public EntityInteractHandler onEntityInteract()

This method cancels EntityInteractHandler to prevent interacting GoldPan with entities.

Returns:

the EntityInteractHandler of this SlimefunItem

getDisplayRecipes

@Nonnull
public List<org.bukkit.inventory.ItemStack> getDisplayRecipes()

Description copied from interface: RecipeDisplayItem

This is the list of items to display alongside this SlimefunItem. Note that these items will be filled in from top to bottom first. So if you want it to express a recipe, add your input ItemStack and then your output ItemStack.

Specified by:

getDisplayRecipes in interface RecipeDisplayItem

Returns:

The recipes to display in the SlimefunGuide

isValidInput

public boolean isValidInput(@Nullable
 org.bukkit.inventory.ItemStack itemStack)

This returns whether the GoldPan accepts the ItemStack as an input

Parameters:

itemStack - The ItemStack to check

Returns:

If the ItemStack is valid

isValidInputMaterial

public boolean isValidInputMaterial(@Nonnull
 org.bukkit.Material material)

This returns whether the GoldPan accepts the Material as an input

Parameters:

material - The Material to check

Returns:

If the Material is valid