public class SlimefunItem extends java.lang.Object implements Placeable
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) |
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> |
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()
|
java.util.List<java.lang.String> |
getNoPermissionTooltip() |
java.lang.String |
getPermission() |
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) |
void |
install()
Deprecated.
|
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) |
boolean |
isTicking() |
static boolean |
isTicking(java.lang.String item) |
boolean |
isUseableInWorkbench()
This method returns whether or not this
SlimefunItem is allowed to
be used in a Crafting Table. |
void |
load() |
void |
postRegister()
This method is called after
register(SlimefunAddon) . |
void |
preRegister()
This method is called before
register(SlimefunAddon) . |
void |
register()
Deprecated.
Use
register(SlimefunAddon) instead. |
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) |
java.lang.String |
toString() |
void |
warn(java.lang.String message) |
public SlimefunItem(Category category, SlimefunItemStack item, RecipeType recipeType, ItemStack[] recipe)
public SlimefunItem(Category category, SlimefunItemStack item, RecipeType recipeType, ItemStack[] recipe, ItemStack recipeOutput)
public SlimefunItem(Category category, SlimefunItemStack item, RecipeType recipeType, ItemStack[] recipe, java.lang.String[] keys, java.lang.Object[] values)
public SlimefunItem(Category category, SlimefunItemStack item, RecipeType recipeType, ItemStack[] recipe, ItemStack recipeOutput, java.lang.String[] keys, java.lang.Object[] values)
public java.lang.String getID()
SlimefunItem
.SlimefunItem
public ItemState getState()
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.ItemState
of this SlimefunItem
public ItemStack getItem()
ItemStack
of this SlimefunItem
.
The ItemStack
describes the look and feel of this SlimefunItem
.ItemStack
that this SlimefunItem
representspublic Category getCategory()
Category
of our SlimefunItem
, every SlimefunItem
is associated with exactly one Category
.Category
that this SlimefunItem
belongs topublic ItemStack[] getRecipe()
public RecipeType getRecipeType()
public ItemStack getRecipeOutput()
public Research getResearch()
public boolean isEnchantable()
public boolean isDisenchantable()
public boolean isHidden()
SlimefunItem
was hidden from the
SlimefunGuide
.SlimefunItem
is hidden.public boolean isAddonItem()
SlimefunItem
was added by an addon.SlimefunItem
was added by an addon.public SlimefunAddon getAddon()
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.SlimefunAddon
that registered this SlimefunItem
public java.lang.String getPermission()
public java.util.List<java.lang.String> getNoPermissionTooltip()
public BlockTicker getBlockTicker()
public GeneratorTicker getEnergyTicker()
public boolean isDisabled()
SlimefunItem
is disabled.SlimefunItem
is disabled.@Deprecated public void register()
register(SlimefunAddon)
instead.slimefun
- public void register(SlimefunAddon addon)
SlimefunItem
.
Always call this method after your SlimefunItem
has been initialized.
Never call it more than once!addon
- The SlimefunAddon
that this SlimefunItem
belongs to.public void bindToResearch(Research r)
public void setRecipe(ItemStack[] recipe)
public void setRecipeType(RecipeType type)
public void setCategory(Category category)
public void setRecipeOutput(ItemStack output)
public boolean isUseableInWorkbench()
SlimefunItem
is allowed to
be used in a Crafting Table.
Items of type VanillaItem
may be used in workbenches for example.SlimefunItem
may be used in a Workbench.setUseableInWorkbench(boolean)
public SlimefunItem setUseableInWorkbench(boolean useable)
public static SlimefunItem getByID(java.lang.String id)
public static SlimefunItem getByItem(ItemStack item)
public boolean isItem(ItemStack item)
public void load()
@Deprecated public void install()
public void addItemHandler(ItemHandler... handlers)
public static java.util.Set<ItemHandler> getPublicItemHandlers(java.lang.Class<? extends ItemHandler> identifier)
public static ItemStack getItem(java.lang.String id)
public void preRegister()
register(SlimefunAddon)
.
Override this method to add any additional setup, adding an ItemHandler
for example.public void postRegister()
register(SlimefunAddon)
.
Override this method to add any additional setup that needs to happen after
the original registration of this SlimefunItem
.public static boolean isTicking(java.lang.String item)
public static void registerBlockHandler(java.lang.String id, SlimefunBlockHandler handler)
public void addOficialWikipage(java.lang.String page)
page
- The associated wiki pagepublic boolean hasWikipage()
addOficialWikipage(String)
public java.lang.String getWikipage()
addOficialWikipage(String)
public final java.lang.String getItemName()
ItemStack
in an Inventory
).ItemStack
formpublic java.util.Collection<ItemHandler> getHandlers()
public <T extends ItemHandler> boolean callItemHandler(java.lang.Class<T> c, java.util.function.Consumer<T> callable)
ItemHandler
of the given Class
and performs the action as specified via the Consumer
.c
- The Class
of the ItemHandler
to call.callable
- A Consumer
that is called for any found ItemHandler
.ItemHandler
was found.public boolean isTicking()
public java.lang.String toString()
toString
in class java.lang.Object
public java.util.Collection<ItemStack> getDrops()
public void info(java.lang.String message)
public void warn(java.lang.String message)
public void error(java.lang.String message, java.lang.Throwable throwable)
Throwable
to the console and signal that
this was caused by this SlimefunItem
.message
- The message to display alongside this Stacktracethrowable
- The Throwable
to throw as a stacktrace.