Class ActiveSlotInventoryComponent

java.lang.Object

com.hypixel.hytale.server.core.inventory.InventoryComponent

com.hypixel.hytale.server.core.inventory.ActiveSlotInventoryComponent

All Implemented Interfaces:

Component<EntityStore>, Cloneable

Direct Known Subclasses:

InventoryComponent.Hotbar, InventoryComponent.Tool, InventoryComponent.Utility

public abstract class ActiveSlotInventoryComponent
extends InventoryComponent

Base class for InventoryComponent subtypes that maintain a tracked active (selected) slot.

Nested Class Summary

Nested classes/interfaces inherited from class InventoryComponent

InventoryComponent.AbilitySlots, InventoryComponent.Armor, InventoryComponent.Backpack, InventoryComponent.Combined, InventoryComponent.Hotbar, InventoryComponent.RuneBag, InventoryComponent.Storage, InventoryComponent.Tool, InventoryComponent.Utility

Field Summary

Fields

Modifier and Type	Field	Description
static final BuilderCodec<ActiveSlotInventoryComponent>	CODEC	The codec used to parse the ActiveSlotInventoryComponent component.

Fields inherited from class InventoryComponent

ABILITIES_LINE_WIDTH, ABILITIES_LINES, ABILITIES_SECTION_ID, ARMOR_HOTBAR_UTILITY_STORAGE, ARMOR_SECTION_ID, BACKPACK_HOTBAR_STORAGE, BACKPACK_SECTION_ID, BACKPACK_STORAGE_HOTBAR, DEFAULT_ABILITIES_CAPACITY, DEFAULT_ARMOR_CAPACITY, DEFAULT_HOTBAR_CAPACITY, DEFAULT_RUNE_BAG_CAPACITY, DEFAULT_STORAGE_CAPACITY, DEFAULT_STORAGE_COLUMNS, DEFAULT_STORAGE_ROWS, DEFAULT_TOOLS_CAPACITY, DEFAULT_UTILITY_CAPACITY, DUMMY_SECTION_ID, EVERYTHING, HOTBAR_FIRST, HOTBAR_SECTION_ID, HOTBAR_STORAGE_BACKPACK, HOTBAR_UTILITY_CONSUMABLE_STORAGE, INACTIVE_SLOT_INDEX, RUNE_BAG_SECTION_ID, STORAGE_FIRST, STORAGE_HOTBAR_BACKPACK, STORAGE_SECTION_ID, TOOLS_SECTION_ID, UTILITY_SECTION_ID

Fields inherited from interface Component

EMPTY_ARRAY

Method Summary

Modifier and Type	Method	Description
void	ensureCapacity(short capacity, List<ItemStack> remainder)	Resizes the inventory and clamps activeSlot to InventoryComponent.INACTIVE_SLOT_INDEX if it falls out of range.
ItemStack	getActiveItem()
byte	getActiveSlot()
abstract int	getSectionId()	Returns the inventory section ID that identifies this component (e.g.
void	setActiveSlot(byte slot, Holder<EntityStore> holder, ComponentAccessor<EntityStore> componentAccessor)	Sets the active slot and fires a InventorySetActiveSlotEvent via the holder event system so registered ECS holder event systems can react.
void	setActiveSlot(byte slot, Ref<EntityStore> ref, ComponentAccessor<EntityStore> accessor)	Sets the active slot and fires a InventorySetActiveSlotEvent so registered ECS event systems can react.

Methods inherited from class InventoryComponent

clone, consumeIsDirty, consumeNeedsSaving, getChangeEvents, getCombined, getCombined, getComponentTypeById, getInventory, getItemInHand, getItemInHand, markDirty, setupCombined

Methods inherited from class Object

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

Methods inherited from interface Component

cloneSerializable

Field Details

CODEC

@Nonnull
public static final BuilderCodec<ActiveSlotInventoryComponent> CODEC

The codec used to parse the ActiveSlotInventoryComponent component.

Method Details

getSectionId

public abstract int getSectionId()

Returns the inventory section ID that identifies this component (e.g. InventoryComponent.HOTBAR_SECTION_ID).

Returns:

The section ID for this inventory component.

ensureCapacity

public void ensureCapacity(short capacity,
 @Nonnull
 List<ItemStack> remainder)

Resizes the inventory and clamps activeSlot to InventoryComponent.INACTIVE_SLOT_INDEX if it falls out of range.

Overrides:

ensureCapacity in class InventoryComponent

Parameters:

capacity - The new capacity.

remainder - Items that no longer fit are added here.

getActiveSlot

public byte getActiveSlot()

Returns:

the index of the currently active slot, or InventoryComponent.INACTIVE_SLOT_INDEX if none.

setActiveSlot

public void setActiveSlot(byte slot,
 @Nonnull
 Ref<EntityStore> ref,
 @Nonnull
 ComponentAccessor<EntityStore> accessor)

Sets the active slot and fires a InventorySetActiveSlotEvent so registered ECS event systems can react.

Parameters:

slot - The slot index to make active.

ref - The entity reference that owns this component.

accessor - The ComponentAccessor for component access.

setActiveSlot

public void setActiveSlot(byte slot,
 @Nonnull
 Holder<EntityStore> holder,
 @Nonnull
 ComponentAccessor<EntityStore> componentAccessor)

Sets the active slot and fires a InventorySetActiveSlotEvent via the holder event system so registered ECS holder event systems can react.

Parameters:

slot - The slot index to make active.

holder - The holder that owns this component.

componentAccessor - The Store to use for event dispatch.

getActiveItem

@Nullable
public ItemStack getActiveItem()

Returns:

the item currently in the active slot, or null if no slot is active or the slot is empty.