Package io.github.thebusybiscuit.slimefun4.api.items

Class HashedArmorpiece

java.lang.Object

io.github.thebusybiscuit.slimefun4.api.items.HashedArmorpiece

public final class HashedArmorpiece
extends Object

This class serves as a way of checking whether a Player has changed their armor between ticks. We do that by storing the hash of their armor and a reference to the corresponding SlimefunArmorPiece if such a correlation exists. This gives us a significant performance improvement as we only need to check for a SlimefunArmorPiece if the item diverged in the first place.

Author:

TheBusyBiscuit

See Also:

• SlimefunArmorPiece
• SlimefunArmorTask

Constructor Summary

Constructors

Constructor	Description
HashedArmorpiece()	This initializes a new HashedArmorpiece with no SlimefunArmorPiece and a zero hash.

Method Summary

Modifier and Type	Method	Description
Optional<SlimefunArmorPiece>	getItem()	Returns the SlimefunArmorPiece that corresponds to this HashedArmorpiece, or an empty Optional
boolean	hasDiverged(ItemStack stack)	This method checks whether the given ItemStack is no longer similar to the one represented by this HashedArmorpiece.
String	toString()
void	update(ItemStack stack, SlimefunItem item)	This will update this HashedArmorpiece with the given ItemStack and the corresponding SlimefunItem

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

HashedArmorpiece

public HashedArmorpiece()

This initializes a new HashedArmorpiece with no SlimefunArmorPiece and a zero hash.

Method Details

update

public void update(@Nullable
 ItemStack stack,
 @Nullable
 SlimefunItem item)

This will update this HashedArmorpiece with the given ItemStack and the corresponding SlimefunItem

Parameters:

stack - The new armorpiece to be stored in this HashedArmorpiece

item - The SlimefunItem corresponding to the provided ItemStack, may be null

hasDiverged

public boolean hasDiverged(@Nullable
 ItemStack stack)

This method checks whether the given ItemStack is no longer similar to the one represented by this HashedArmorpiece.

Parameters:

stack - The ItemStack to compare

Returns:

Whether the HashedArmorpiece and the given ItemStack mismatch

getItem

@Nonnull
public Optional<SlimefunArmorPiece> getItem()

Returns the SlimefunArmorPiece that corresponds to this HashedArmorpiece, or an empty Optional

Returns:

An Optional describing the result

toString

public String toString()

Overrides:

toString in class Object