me.mrCookieSlime.Slimefun.Objects.SlimefunItem

Class SlimefunItem

java.lang.Object

me.mrCookieSlime.Slimefun.Objects.SlimefunItem.SlimefunItem

All Implemented Interfaces:

Placeable

Direct Known Subclasses:

AContainer, AdvancedCargoOutputNode, AGenerator, Alloy, AncientPedestal, AnimalGrowthAccelerator, AReactor, AutoBreeder, AutomatedCraftingChamber, BirthdayCake, Capacitor, CargoInputNode, CargoManager, CargoOutputNode, ChargableItem, CropGrowthAccelerator, EnergyRegulator, HandledBlock, Juice, Parachute, PersonalActivationPlate, ProgrammableAndroid, RadioactiveItem, ReactorAccessPort, SimpleSlimefunItem, SlimefunArmorPiece, SlimefunBow, SlimefunMachine, SolarHelmet, SoulboundItem, Talisman, Teleporter, TrashCan, VanillaItem, XPCollector

public class SlimefunItem
extends java.lang.Object
implements Placeable

Constructor Summary

Constructors

Constructor and Description
SlimefunItem(Category category, SlimefunItemStack item, RecipeType recipeType, ItemStack[] recipe)
SlimefunItem(Category category, SlimefunItemStack item, RecipeType recipeType, ItemStack[] recipe, ItemStack recipeOutput)
SlimefunItem(Category category, SlimefunItemStack item, RecipeType recipeType, ItemStack[] recipe, ItemStack recipeOutput, java.lang.String[] keys, java.lang.Object[] values)
SlimefunItem(Category category, SlimefunItemStack item, RecipeType recipeType, ItemStack[] recipe, java.lang.String[] keys, java.lang.Object[] values)

Method Summary

Modifier and Type	Method and Description
void	addItemHandler(ItemHandler... handlers)
void	addOficialWikipage(java.lang.String page) This method will assign the given wiki page to this Item.
void	bindToResearch(Research r)
<T extends ItemHandler> boolean	callItemHandler(java.lang.Class<T> c, java.util.function.Consumer<T> callable) This method calls every ItemHandler of the given Class and performs the action as specified via the Consumer.
void	error(java.lang.String message, java.lang.Throwable throwable) This will throw a Throwable to the console and signal that this was caused by this SlimefunItem.
SlimefunAddon	getAddon() This method returns the SlimefunAddon that registered this SlimefunItem.
BlockTicker	getBlockTicker()
static SlimefunItem	getByID(java.lang.String id)
static SlimefunItem	getByItem(ItemStack item)
Category	getCategory() This returns the Category of our SlimefunItem, every SlimefunItem is associated with exactly one Category.
java.util.Collection<ItemStack>	getDrops()
java.util.Collection<ItemStack>	getDrops(Player p)
GeneratorTicker	getEnergyTicker()
java.util.Collection<ItemHandler>	getHandlers() This method returns a Set of item handlers associated with this Item.
java.lang.String	getID() Returns the identifier of this SlimefunItem.
ItemStack	getItem() This returns the ItemStack of this SlimefunItem.
static ItemStack	getItem(java.lang.String id)
java.lang.String	getItemName() This method will return this Item's Name (The name that is displayed when hovering over this ItemStack in an Inventory).
static java.util.Set<ItemHandler>	getPublicItemHandlers(java.lang.Class<? extends ItemHandler> identifier)
ItemStack[]	getRecipe()
ItemStack	getRecipeOutput()
RecipeType	getRecipeType()
Research	getResearch()
ItemState	getState() This method returns the ItemState this SlimefunItem is currently in.
java.lang.String	getWikipage() This method returns the wiki page that has been asigned to this item.
boolean	hasWikipage() This method returns whether this item has been assigned a wiki page.
void	info(java.lang.String message)
boolean	isAddonItem() This method returns whether this SlimefunItem was added by an addon.
boolean	isDisabled() This method returns whether this SlimefunItem is disabled.
boolean	isDisenchantable()
boolean	isEnchantable()
boolean	isHidden() This method returns whether this SlimefunItem was hidden from the SlimefunGuide.
boolean	isItem(ItemStack item) This method checks whether the provided ItemStack represents this SlimefunItem.
boolean	isTicking() This returns whether or not we are scheduling a ticking task for this block.
boolean	isUseableInWorkbench() This method returns whether or not this SlimefunItem is allowed to be used in a Crafting Table.
void	load() This method is used for internal purposes only.
void	postRegister() This method is called after register(SlimefunAddon).
void	preRegister() This method is called before register(SlimefunAddon).
void	register(SlimefunAddon addon) This method registers this SlimefunItem.
static void	registerBlockHandler(java.lang.String id, SlimefunBlockHandler handler)
void	setCategory(Category category)
void	setRecipe(ItemStack[] recipe)
void	setRecipeOutput(ItemStack output)
void	setRecipeType(RecipeType type)
SlimefunItem	setUseableInWorkbench(boolean useable) This sets whether or not this SlimefunItem is allowed to be used in a normal Crafting Table.
java.lang.String	toString()
void	warn(java.lang.String message)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.github.thebusybiscuit.slimefun4.api.items.Placeable

onBreak, onExplode, onPlace

Constructor Detail

SlimefunItem

public SlimefunItem(Category category,
                    SlimefunItemStack item,
                    RecipeType recipeType,
                    ItemStack[] recipe)

SlimefunItem

public SlimefunItem(Category category,
                    SlimefunItemStack item,
                    RecipeType recipeType,
                    ItemStack[] recipe,
                    ItemStack recipeOutput)

SlimefunItem

public SlimefunItem(Category category,
                    SlimefunItemStack item,
                    RecipeType recipeType,
                    ItemStack[] recipe,
                    java.lang.String[] keys,
                    java.lang.Object[] values)

SlimefunItem

public SlimefunItem(Category category,
                    SlimefunItemStack item,
                    RecipeType recipeType,
                    ItemStack[] recipe,
                    ItemStack recipeOutput,
                    java.lang.String[] keys,
                    java.lang.Object[] values)

Method Detail

getID

public java.lang.String getID()

Returns the identifier of this SlimefunItem.

Returns:

the identifier of this SlimefunItem

getState

public ItemState getState()

This method returns the ItemState this SlimefunItem is currently in. This can be used to determine whether a SlimefunItem is enabled or disabled. VanillaItem represents a special case here.

Returns:

The ItemState of this SlimefunItem

getItem

public ItemStack getItem()

This returns the ItemStack of this SlimefunItem. The ItemStack describes the look and feel of this SlimefunItem.

Returns:

The ItemStack that this SlimefunItem represents

getCategory

public Category getCategory()

This returns the Category of our SlimefunItem, every SlimefunItem is associated with exactly one Category.

Returns:

The Category that this SlimefunItem belongs to

getRecipe

public ItemStack[] getRecipe()

getRecipeType

public RecipeType getRecipeType()

getRecipeOutput

public ItemStack getRecipeOutput()

getResearch

public Research getResearch()

isEnchantable

public boolean isEnchantable()

isDisenchantable

public boolean isDisenchantable()

isHidden

public boolean isHidden()

This method returns whether this SlimefunItem was hidden from the SlimefunGuide.

Returns:

Whether this SlimefunItem is hidden.

isAddonItem

public boolean isAddonItem()

This method returns whether this SlimefunItem was added by an addon.

Returns:

Whether this SlimefunItem was added by an addon.

getAddon

public SlimefunAddon getAddon()

This method returns the SlimefunAddon that registered this SlimefunItem. If this Item is from Slimefun itself, the current instance of SlimefunPlugin will be returned. Use an instanceof check or isAddonItem() to account for that.

Returns:

The SlimefunAddon that registered this SlimefunItem

getBlockTicker

public BlockTicker getBlockTicker()

getEnergyTicker

public GeneratorTicker getEnergyTicker()

isDisabled

public boolean isDisabled()

This method returns whether this SlimefunItem is disabled.

Returns:

Whether this SlimefunItem is disabled.

register

public void register(SlimefunAddon addon)

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

Parameters:

addon - The SlimefunAddon that this SlimefunItem belongs to.

bindToResearch

public void bindToResearch(Research r)

setRecipe

public void setRecipe(ItemStack[] recipe)

setRecipeType

public void setRecipeType(RecipeType type)

setCategory

public void setCategory(Category category)

setRecipeOutput

public void setRecipeOutput(ItemStack output)

isUseableInWorkbench

public boolean isUseableInWorkbench()

This method returns whether or not this SlimefunItem is allowed to be used in a Crafting Table. Items of type VanillaItem may be used in workbenches for example.

Returns:

Whether this SlimefunItem may be used in a Workbench.

See Also:

setUseableInWorkbench(boolean)

setUseableInWorkbench

public SlimefunItem setUseableInWorkbench(boolean useable)

This sets whether or not this SlimefunItem is allowed to be used in a normal Crafting Table.

Parameters:

useable - Whether this SlimefunItem should be useable in a workbench

Returns:

This instance of SlimefunItem

isItem

public boolean isItem(ItemStack item)

This method checks whether the provided ItemStack represents this SlimefunItem.

Parameters:

item - The ItemStack to compare

Returns:

Whether the given ItemStack represents this SlimefunItem

load

public void load()

This method is used for internal purposes only.

addItemHandler

public void addItemHandler(ItemHandler... handlers)

preRegister

public void preRegister()

This method is called before register(SlimefunAddon). Override this method to add any additional setup, adding an ItemHandler for example.

postRegister

public void postRegister()

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

addOficialWikipage

public void addOficialWikipage(java.lang.String page)

This method will assign the given wiki page to this Item. Note that you only need to provide the page name itself, the URL to our wiki is prepended automatically.

Parameters:

page - The associated wiki page

hasWikipage

public boolean hasWikipage()

This method returns whether this item has been assigned a wiki page.

Returns:

Whether this Item has a wiki page

See Also:

addOficialWikipage(String)

getWikipage

public java.lang.String getWikipage()

This method returns the wiki page that has been asigned to this item. It will return null, if no wiki page was found.

Returns:

This item's wiki page

See Also:

addOficialWikipage(String)

getItemName

public final java.lang.String getItemName()

This method will return this Item's Name (The name that is displayed when hovering over this ItemStack in an Inventory).

Returns:

This item's name in ItemStack form

getHandlers

public java.util.Collection<ItemHandler> getHandlers()

This method returns a Set of item handlers associated with this Item.

Returns:

The Set of item handlers

callItemHandler

public <T extends ItemHandler> boolean callItemHandler(java.lang.Class<T> c,
                                                       java.util.function.Consumer<T> callable)

This method calls every ItemHandler of the given Class and performs the action as specified via the Consumer.

Parameters:

c - The Class of the ItemHandler to call.

callable - A Consumer that is called for any found ItemHandler.

Returns:

Whether or not an ItemHandler was found.

isTicking

public boolean isTicking()

This returns whether or not we are scheduling a ticking task for this block.

Returns:

Whether this SlimefunItem is a ticking block

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getDrops

public java.util.Collection<ItemStack> getDrops()

Specified by:

getDrops in interface Placeable

getDrops

public java.util.Collection<ItemStack> getDrops(Player p)

Specified by:

getDrops in interface Placeable

info

public void info(java.lang.String message)

warn

public void warn(java.lang.String message)

error

public void error(java.lang.String message,
                  java.lang.Throwable throwable)

This will throw a Throwable to the console and signal that this was caused by this SlimefunItem.

Parameters:

message - The message to display alongside this Stacktrace

throwable - The Throwable to throw as a stacktrace.

getByID

public static SlimefunItem getByID(java.lang.String id)

getByItem

public static SlimefunItem getByItem(ItemStack item)

getItem

public static ItemStack getItem(java.lang.String id)

getPublicItemHandlers

public static java.util.Set<ItemHandler> getPublicItemHandlers(java.lang.Class<? extends ItemHandler> identifier)

registerBlockHandler

public static void registerBlockHandler(java.lang.String id,
                                        SlimefunBlockHandler handler)