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

Class GEOMiner

java.lang.Object

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

io.github.thebusybiscuit.slimefun4.implementation.items.geo.GEOMiner

All Implemented Interfaces:

EnergyNetComponent, HologramOwner, ItemAttribute, MachineProcessHolder<GEOMiningOperation>, Placeable, RecipeDisplayItem, InventoryBlock

public class GEOMiner
extends SlimefunItem
implements RecipeDisplayItem, EnergyNetComponent, InventoryBlock, HologramOwner, MachineProcessHolder<GEOMiningOperation>

The GEOMiner is an electrical machine that allows you to obtain a GEOResource.

Author:

TheBusyBiscuit

See Also:

• GEOResource

Field Summary

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

addon, disenchantable, enchantable, hidden, recipeOutput, useableInWorkbench

Constructor Summary

Constructors

Constructor	Description
GEOMiner(ItemGroup itemGroup, SlimefunItemStack item, RecipeType recipeType, ItemStack[] recipe)

Method Summary

Modifier and Type	Method	Description
protected void	constructMenu(BlockMenuPreset preset)
int	getCapacity()	This method returns the max amount of electricity this machine can hold.
List<ItemStack>	getDisplayRecipes()	This is the list of items to display alongside this SlimefunItem.
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.
int[]	getInputSlots()	This method returns an Array of slots that serve as the input for the Inventory of this block.
String	getLabelLocalPath()
MachineProcessor<GEOMiningOperation>	getMachineProcessor()	This method returns our MachineProcessor instance.
int[]	getOutputSlots()	This method returns an Array of slots that serve as the output for the Inventory of this block.
int	getSpeed()	This method returns the speed at which this machine will operate.
void	preRegister()	This method is called before SlimefunItem.register(SlimefunAddon).
void	register(SlimefunAddon addon)	This method registers this SlimefunItem.
final GEOMiner	setCapacity(int capacity)	This sets the energy capacity for this machine.
final GEOMiner	setEnergyConsumption(int energyConsumption)	This method sets the energy consumed by this machine per tick.
final GEOMiner	setProcessingSpeed(int speed)	This sets the speed of this machine.
protected void	tick(Block b)

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

addItemHandler, addItemSetting, addOfficialWikipage, callItemHandler, canUse, 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, postRegister, 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, isChargeable, removeCharge, setCharge

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

getHologramOffset, removeHologram, updateHologram

Methods inherited from interface me.mrCookieSlime.Slimefun.Objects.SlimefunItem.interfaces.InventoryBlock

createPreset, createPreset

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

GEOMiner

@ParametersAreNonnullByDefault
public GEOMiner(ItemGroup itemGroup,
 SlimefunItemStack item,
 RecipeType recipeType,
 ItemStack[] recipe)

Method Details

getMachineProcessor

@Nonnull
public MachineProcessor<GEOMiningOperation> getMachineProcessor()

Description copied from interface: MachineProcessHolder

This method returns our MachineProcessor instance.

Specified by:

getMachineProcessor in interface MachineProcessHolder<GEOMiningOperation>

Returns:

Our MachineProcessor

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

getSpeed

public int getSpeed()

This method returns the speed at which this machine will operate. This can be implemented on an instantiation-level to create different tiers of machines.

Returns:

The speed of this machine

setCapacity

public final GEOMiner 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 GEOMiner, so that can be chained.

setProcessingSpeed

public final GEOMiner setProcessingSpeed(int speed)

This sets the speed of this machine.

Parameters:

speed - The speed multiplier for this machine, must be above zero

Returns:

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

setEnergyConsumption

public final GEOMiner 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 GEOMiner, so that 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.

getInputSlots

@Nonnull
public int[] getInputSlots()

Description copied from interface: InventoryBlock

This method returns an Array of slots that serve as the input for the Inventory of this block.

Specified by:

getInputSlots in interface InventoryBlock

Returns:

The input slots for the Inventory of this block

getOutputSlots

@Nonnull
public int[] getOutputSlots()

Description copied from interface: InventoryBlock

This method returns an Array of slots that serve as the output for the Inventory of this block.

Specified by:

getOutputSlots in interface InventoryBlock

Returns:

The output slots for the Inventory of this block

getDisplayRecipes

@Nonnull
public List<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

getLabelLocalPath

@Nonnull
public String getLabelLocalPath()

Specified by:

getLabelLocalPath in interface RecipeDisplayItem

getEnergyComponentType

public 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.

constructMenu

protected void constructMenu(@Nonnull
 BlockMenuPreset preset)

preRegister

public void preRegister()

Description copied from class: SlimefunItem

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

Overrides:

preRegister in class SlimefunItem

tick

protected void tick(@Nonnull
 Block b)