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

Class ClimbingPick

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

All Implemented Interfaces:

DamageableItem, ItemAttribute, Placeable, RecipeDisplayItem

public class ClimbingPick
extends SimpleSlimefunItem<ItemUseHandler>
implements DamageableItem, RecipeDisplayItem

The ClimbingPick launches you 1 block upwards when you right click on a ice Block. Every level of efficiency Enchantment increases the launch by 0.2 blocks.

Author:

Linox, TheBusyBiscuit

Field Summary

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

addon, disenchantable, enchantable, hidden, recipeOutput, useableInWorkbench

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected void	addDefaultSurfaces()	This method adds every surface that is climbable by default.
protected void	addSurface(Material type, double defaultValue)
void	damageItem(Player p, ItemStack item)	This method will damage the given ItemStack once.
Collection<ClimbableSurface>	getClimbableSurfaces()	This method returns a Collection of every ClimbableSurface the ClimbingPick can climb.
double	getClimbingSpeed(ItemStack item, Material type)	This returns the climbing speed for a given Material and the used ItemStack.
double	getClimbingSpeed(Material type)	This returns the climbing speed for a given Material.
List<ItemStack>	getDisplayRecipes()	This is the list of items to display alongside this SlimefunItem.
ItemUseHandler	getItemHandler()	This returns the ItemHandler that will be added to this SlimefunItem.
String	getLabelLocalPath()
boolean	isDamageable()	Implement this method to make the behaviour of this interface dependent on the state of your object.
boolean	isDualWieldingEnabled()	This returns whether the ClimbingPick needs to be held in both arms to work.

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, 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, 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.DamageableItem

evaluateUnbreakingEnchantment

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

ClimbingPick

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

Method Details

addDefaultSurfaces

protected void addDefaultSurfaces()

This method adds every surface that is climbable by default.

addSurface

protected void addSurface(@Nonnull
 Material type,
 double defaultValue)

isDualWieldingEnabled

public boolean isDualWieldingEnabled()

This returns whether the ClimbingPick needs to be held in both arms to work.

Returns:

Whether dual wielding is enabled

getClimbableSurfaces

@Nonnull
public Collection<ClimbableSurface> getClimbableSurfaces()

This method returns a Collection of every ClimbableSurface the ClimbingPick can climb.

Returns:

A Collection of every ClimbableSurface

getClimbingSpeed

public double getClimbingSpeed(@Nonnull
 Material type)

This returns the climbing speed for a given Material.

Parameters:

type - The Material

Returns:

The climbing speed for this Material or 0.

getClimbingSpeed

public double getClimbingSpeed(@Nonnull
 ItemStack item,
 @Nonnull
 Material type)

This returns the climbing speed for a given Material and the used ItemStack.

Parameters:

item - the ClimbingPick's ItemStack

type - The Material

Returns:

The climbing speed or 0.

getItemHandler

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

damageItem

public void damageItem(@Nonnull
 Player p,
 @Nullable
 ItemStack item)

Description copied from interface: DamageableItem

This method will damage the given ItemStack once. It also takes into account the Enchantment Unbreaking. It will only apply the damage if DamageableItem.isDamageable() returned true.

Specified by:

damageItem in interface DamageableItem

Parameters:

p - The Player to which the item belongs

item - The ItemStack to damage

isDamageable

public boolean isDamageable()

Description copied from interface: DamageableItem

Implement this method to make the behaviour of this interface dependent on the state of your object. You could add a Config option to toggle the behaviour for example.

Specified by:

isDamageable in interface DamageableItem

Returns:

Whether this SlimefunItem is damageable

getDisplayRecipes

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

public String getLabelLocalPath()

Specified by:

getLabelLocalPath in interface RecipeDisplayItem