Class InventoryComponent

java.lang.Object

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

All Implemented Interfaces:

Component<EntityStore>, Cloneable

Direct Known Subclasses:

ActiveSlotInventoryComponent, InventoryComponent.AbilitySlots, InventoryComponent.Armor, InventoryComponent.Backpack, InventoryComponent.RuneBag, InventoryComponent.Storage

public abstract class InventoryComponent
extends Object
implements Component<EntityStore>

Base component for all inventory types on an entity. Each inventory type (hotbar, armor, etc.) is a separate ECS component, allowing entities to have any combination of inventories.

The static combined-type arrays (e.g. HOTBAR_FIRST, EVERYTHING) define priority-ordered groupings used by operations that span multiple inventories, such as item insertion or sorting. The array order determines which inventory is tried first.

See Also:

• InventoryComponent.Combined
• getCombined(ComponentAccessor, Ref, ComponentType[])

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	InventoryComponent.AbilitySlots	Ability rune slots laid out in ABILITIES_LINES lines of ABILITIES_LINE_WIDTH: the first slot of each line holds the castable Primary ability (line 1 casts on Ability2, line 2 on Ability3), the remaining slots hold Support abilities.
static class	InventoryComponent.Armor	Armor equipment slots (helmet, chestplate, leggings, boots).
static class	InventoryComponent.Backpack	Extended overflow storage (backpack).
static class	InventoryComponent.Combined	Non-serialized helper component that caches CombinedItemContainer instances keyed by the component-type arrays used to create them.
static class	InventoryComponent.Hotbar	Quick-access hotbar slots with a tracked active (selected) slot.
static class	InventoryComponent.RuneBag	The player's rune bag: general storage for ability rune items, shown in the ability bench.
static class	InventoryComponent.Storage	General-purpose storage inventory (main inventory grid).
static class	InventoryComponent.Tool	Tool slots with a tracked active slot and a flag indicating whether the tool item is currently being used.
static class	InventoryComponent.Utility	Utility item slots (e.g. torches) with a tracked active slot.

Field Summary

Fields

Modifier and Type	Field	Description
static final short	ABILITIES_LINE_WIDTH
static final short	ABILITIES_LINES
static final int	ABILITIES_SECTION_ID
static ComponentType<EntityStore, ? extends InventoryComponent>[]	ARMOR_HOTBAR_UTILITY_STORAGE
static final int	ARMOR_SECTION_ID
static ComponentType<EntityStore, ? extends InventoryComponent>[]	BACKPACK_HOTBAR_STORAGE
static final int	BACKPACK_SECTION_ID
static ComponentType<EntityStore, ? extends InventoryComponent>[]	BACKPACK_STORAGE_HOTBAR
static final BuilderCodec<InventoryComponent>	CODEC
static final short	DEFAULT_ABILITIES_CAPACITY
static final short	DEFAULT_ARMOR_CAPACITY
static final short	DEFAULT_HOTBAR_CAPACITY
static final short	DEFAULT_RUNE_BAG_CAPACITY
static final short	DEFAULT_STORAGE_CAPACITY
static final short	DEFAULT_STORAGE_COLUMNS
static final short	DEFAULT_STORAGE_ROWS
static final short	DEFAULT_TOOLS_CAPACITY
static final short	DEFAULT_UTILITY_CAPACITY
static final int	DUMMY_SECTION_ID
static ComponentType<EntityStore, ? extends InventoryComponent>[]	EVERYTHING
static ComponentType<EntityStore, ? extends InventoryComponent>[]	HOTBAR_FIRST
static final int	HOTBAR_SECTION_ID
static ComponentType<EntityStore, ? extends InventoryComponent>[]	HOTBAR_STORAGE_BACKPACK
static ComponentType<EntityStore, ? extends InventoryComponent>[]	HOTBAR_UTILITY_CONSUMABLE_STORAGE
static final byte	INACTIVE_SLOT_INDEX
static final int	RUNE_BAG_SECTION_ID
static ComponentType<EntityStore, ? extends InventoryComponent>[]	STORAGE_FIRST
static ComponentType<EntityStore, ? extends InventoryComponent>[]	STORAGE_HOTBAR_BACKPACK
static final int	STORAGE_SECTION_ID
static final int	TOOLS_SECTION_ID
static final int	UTILITY_SECTION_ID

Fields inherited from interface Component

EMPTY_ARRAY

Constructor Summary

Constructors

Constructor	Description
InventoryComponent()
InventoryComponent(short capacity)

Method Summary

Modifier and Type	Method	Description
abstract Component<EntityStore>	clone()
boolean	consumeIsDirty()
boolean	consumeNeedsSaving()
void	ensureCapacity(short capacity, List<ItemStack> remainder)
ConcurrentLinkedQueue<ItemContainer.ItemContainerChangeEvent>	getChangeEvents()
static CombinedItemContainer	getCombined(CommandBuffer<EntityStore> commandBuffer, ArchetypeChunk<EntityStore> archetypeChunk, int index, ComponentType<EntityStore, ? extends InventoryComponent>... types)	Overload of getCombined(ComponentAccessor, Ref, ComponentType[]) for use within ECS systems that operate on ArchetypeChunk directly.
static CombinedItemContainer	getCombined(ComponentAccessor<EntityStore> accessor, Ref<EntityStore> ref, ComponentType<EntityStore, ? extends InventoryComponent>... types)	Returns a CombinedItemContainer that wraps the inventories of the given component types on the specified entity.
static ComponentType<EntityStore, ? extends InventoryComponent>	getComponentTypeById(int id)	Returns the ComponentType that corresponds to the built-in inventory section with the given negative section ID (e.g.
ItemContainer	getInventory()
static ItemStack	getItemInHand(ComponentAccessor<EntityStore> accessor, Ref<EntityStore> ref)	Returns the item the entity is currently holding.
static ItemStack	getItemInHand(Holder<EntityStore> holder)	Returns the item the entity is currently holding, using holder-based component access.
void	markDirty()
static void	setupCombined(ComponentType<EntityStore, InventoryComponent.Storage> storageInventoryComponentType, ComponentType<EntityStore, InventoryComponent.Armor> armorInventoryComponentType, ComponentType<EntityStore, InventoryComponent.Hotbar> hotbarInventoryComponentType, ComponentType<EntityStore, InventoryComponent.Utility> utilityInventoryComponentType, ComponentType<EntityStore, InventoryComponent.Backpack> backpackInventoryComponentType, ComponentType<EntityStore, InventoryComponent.Tool> ignoredToolInventoryComponentType)	Initializes the combined-type arrays after all inventory component types have been registered.

Methods inherited from class Object

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

Methods inherited from interface Component

cloneSerializable

Field Details

INACTIVE_SLOT_INDEX

public static final byte INACTIVE_SLOT_INDEX

See Also:

• Constant Field Values

DEFAULT_HOTBAR_CAPACITY

public static final short DEFAULT_HOTBAR_CAPACITY

See Also:

• Constant Field Values

DEFAULT_UTILITY_CAPACITY

public static final short DEFAULT_UTILITY_CAPACITY

See Also:

• Constant Field Values

DEFAULT_TOOLS_CAPACITY

public static final short DEFAULT_TOOLS_CAPACITY

See Also:

• Constant Field Values

DEFAULT_ARMOR_CAPACITY

public static final short DEFAULT_ARMOR_CAPACITY

DEFAULT_STORAGE_ROWS

public static final short DEFAULT_STORAGE_ROWS

See Also:

• Constant Field Values

DEFAULT_STORAGE_COLUMNS

public static final short DEFAULT_STORAGE_COLUMNS

See Also:

• Constant Field Values

DEFAULT_STORAGE_CAPACITY

public static final short DEFAULT_STORAGE_CAPACITY

See Also:

• Constant Field Values

ABILITIES_LINE_WIDTH

public static final short ABILITIES_LINE_WIDTH

See Also:

• Constant Field Values

ABILITIES_LINES

public static final short ABILITIES_LINES

See Also:

• Constant Field Values

DEFAULT_ABILITIES_CAPACITY

public static final short DEFAULT_ABILITIES_CAPACITY

See Also:

• Constant Field Values

DEFAULT_RUNE_BAG_CAPACITY

public static final short DEFAULT_RUNE_BAG_CAPACITY

See Also:

• Constant Field Values

HOTBAR_SECTION_ID

public static final int HOTBAR_SECTION_ID

See Also:

• Constant Field Values

STORAGE_SECTION_ID

public static final int STORAGE_SECTION_ID

See Also:

• Constant Field Values

ARMOR_SECTION_ID

public static final int ARMOR_SECTION_ID

See Also:

• Constant Field Values

UTILITY_SECTION_ID

public static final int UTILITY_SECTION_ID

See Also:

• Constant Field Values

TOOLS_SECTION_ID

public static final int TOOLS_SECTION_ID

See Also:

• Constant Field Values

BACKPACK_SECTION_ID

public static final int BACKPACK_SECTION_ID

See Also:

• Constant Field Values

DUMMY_SECTION_ID

public static final int DUMMY_SECTION_ID

See Also:

• Constant Field Values

ABILITIES_SECTION_ID

public static final int ABILITIES_SECTION_ID

See Also:

• Constant Field Values

RUNE_BAG_SECTION_ID

public static final int RUNE_BAG_SECTION_ID

See Also:

• Constant Field Values

CODEC

public static final BuilderCodec<InventoryComponent> CODEC

HOTBAR_STORAGE_BACKPACK

public static ComponentType<EntityStore, ? extends InventoryComponent>[] HOTBAR_STORAGE_BACKPACK

HOTBAR_FIRST

public static ComponentType<EntityStore, ? extends InventoryComponent>[] HOTBAR_FIRST

STORAGE_FIRST

public static ComponentType<EntityStore, ? extends InventoryComponent>[] STORAGE_FIRST

BACKPACK_STORAGE_HOTBAR

public static ComponentType<EntityStore, ? extends InventoryComponent>[] BACKPACK_STORAGE_HOTBAR

BACKPACK_HOTBAR_STORAGE

public static ComponentType<EntityStore, ? extends InventoryComponent>[] BACKPACK_HOTBAR_STORAGE

STORAGE_HOTBAR_BACKPACK

public static ComponentType<EntityStore, ? extends InventoryComponent>[] STORAGE_HOTBAR_BACKPACK

ARMOR_HOTBAR_UTILITY_STORAGE

public static ComponentType<EntityStore, ? extends InventoryComponent>[] ARMOR_HOTBAR_UTILITY_STORAGE

HOTBAR_UTILITY_CONSUMABLE_STORAGE

public static ComponentType<EntityStore, ? extends InventoryComponent>[] HOTBAR_UTILITY_CONSUMABLE_STORAGE

EVERYTHING

public static ComponentType<EntityStore, ? extends InventoryComponent>[] EVERYTHING

Constructor Details

InventoryComponent

public InventoryComponent()

InventoryComponent

public InventoryComponent(short capacity)

Method Details

ensureCapacity

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

markDirty

public void markDirty()

consumeIsDirty

public boolean consumeIsDirty()

consumeNeedsSaving

public boolean consumeNeedsSaving()

getInventory

public ItemContainer getInventory()

getChangeEvents

public ConcurrentLinkedQueue<ItemContainer.ItemContainerChangeEvent> getChangeEvents()

clone

@Nullable
public abstract Component<EntityStore> clone()

Specified by:

clone in interface Component<EntityStore>

Returns:

a clone instance of the original component instance.

setupCombined

public static void setupCombined(@Nonnull
 ComponentType<EntityStore, InventoryComponent.Storage> storageInventoryComponentType,
 @Nonnull
 ComponentType<EntityStore, InventoryComponent.Armor> armorInventoryComponentType,
 @Nonnull
 ComponentType<EntityStore, InventoryComponent.Hotbar> hotbarInventoryComponentType,
 @Nonnull
 ComponentType<EntityStore, InventoryComponent.Utility> utilityInventoryComponentType,
 @Nonnull
 ComponentType<EntityStore, InventoryComponent.Backpack> backpackInventoryComponentType,
 @Nonnull
 ComponentType<EntityStore, InventoryComponent.Tool> ignoredToolInventoryComponentType)

Initializes the combined-type arrays after all inventory component types have been registered. Called during EntityModule setup.

getComponentTypeById

@Nullable
public static ComponentType<EntityStore, ? extends InventoryComponent> getComponentTypeById(int id)

Returns the ComponentType that corresponds to the built-in inventory section with the given negative section ID (e.g. HOTBAR_SECTION_ID). Returns null for non-negative IDs (window IDs) or unrecognised section IDs.

Parameters:

id - The section ID to look up.

Returns:

the matching ComponentType, or null if there is no built-in section for id.

getCombined

@Nonnull
@SafeVarargs
public static CombinedItemContainer getCombined(@Nonnull
 ComponentAccessor<EntityStore> accessor,
 @Nonnull
 Ref<EntityStore> ref,
 @Nonnull
 ComponentType<EntityStore, ? extends InventoryComponent>... types)

Returns a CombinedItemContainer that wraps the inventories of the given component types on the specified entity. Results are cached on the entity's InventoryComponent.Combined component so repeated calls with the same type array instance within a tick are free.

Parameters:

accessor - The ComponentAccessor for component access.

ref - The entity reference of the associated entity.

types - The inventory component types to combine, in priority order.

Returns:

a combined view over the specified inventories.

getCombined

@Nonnull
@SafeVarargs
public static CombinedItemContainer getCombined(@Nonnull
 CommandBuffer<EntityStore> commandBuffer,
 @Nonnull
 ArchetypeChunk<EntityStore> archetypeChunk,
 int index,
 @Nonnull
 ComponentType<EntityStore, ? extends InventoryComponent>... types)

Overload of getCombined(ComponentAccessor, Ref, ComponentType[]) for use within ECS systems that operate on ArchetypeChunk directly.

Parameters:

commandBuffer - The command buffer used to add the InventoryComponent.Combined cache component if absent.

archetypeChunk - The chunk containing the entity.

index - The index of the entity within archetypeChunk.

types - The inventory component types to combine, in priority order.

Returns:

a combined view over the specified inventories.

getItemInHand

@Nullable
public static ItemStack getItemInHand(@Nonnull
 ComponentAccessor<EntityStore> accessor,
 @Nonnull
 Ref<EntityStore> ref)

Returns the item the entity is currently holding.

If the entity has a InventoryComponent.Tool component and is actively using a tool item, the active tool item is returned; otherwise the active InventoryComponent.Hotbar item is returned.

Parameters:

accessor - The ComponentAccessor for component access.

ref - The entity reference.

Returns:

the held ItemStack, or null if no item is held.

getItemInHand

@Nullable
public static ItemStack getItemInHand(@Nonnull
 Holder<EntityStore> holder)

Returns the item the entity is currently holding, using holder-based component access.

If the entity has a InventoryComponent.Tool component and is actively using a tool item, the active tool item is returned; otherwise the active InventoryComponent.Hotbar item is returned.

Parameters:

holder - The entity holder.

Returns:

the held ItemStack, or null if no item is held.