Package org.geysermc.geyser.translator.inventory

Class AbstractBlockInventoryTranslator<Type extends Container>

java.lang.Object

org.geysermc.geyser.translator.inventory.InventoryTranslator<Type>

org.geysermc.geyser.translator.inventory.BaseInventoryTranslator<Type>

org.geysermc.geyser.translator.inventory.AbstractBlockInventoryTranslator<Type>

Direct Known Subclasses:

AbstractFurnaceInventoryTranslator, AnvilInventoryTranslator, BeaconInventoryTranslator, BrewingInventoryTranslator, CartographyInventoryTranslator, CrafterInventoryTranslator, CraftingInventoryTranslator, EnchantingInventoryTranslator, Generic3X3InventoryTranslator, GrindstoneInventoryTranslator, HopperInventoryTranslator, LecternInventoryTranslator, LoomInventoryTranslator, OldSmithingTableTranslator, ShulkerInventoryTranslator, SmithingInventoryTranslator, StonecutterInventoryTranslator

public abstract class AbstractBlockInventoryTranslator<Type extends Container>
extends BaseInventoryTranslator<Type>

Provided as a base for any inventory that requires a block for opening it

Nested Class Summary

Nested classes/interfaces inherited from class org.geysermc.geyser.translator.inventory.InventoryTranslator

InventoryTranslator.CraftState

Field Summary

Fields inherited from class org.geysermc.geyser.translator.inventory.InventoryTranslator

PLAYER_INVENTORY_OFFSET, PLAYER_INVENTORY_SIZE, PLAYER_INVENTORY_TRANSLATOR, size

Constructor Summary

Constructors

Constructor	Description
AbstractBlockInventoryTranslator(int size, InventoryHolder holder, InventoryUpdater updater)
AbstractBlockInventoryTranslator(int size, Block javaBlock, org.cloudburstmc.protocol.bedrock.data.inventory.ContainerType containerType, InventoryUpdater updater, Block... additionalValidBlocks)
AbstractBlockInventoryTranslator(int size, BlockState javaBlockState, org.cloudburstmc.protocol.bedrock.data.inventory.ContainerType containerType, InventoryUpdater updater, Block... additionalValidBlocks)

Method Summary

Modifier and Type	Method	Description
boolean	canReuseInventory(GeyserSession session, @NonNull Inventory newInventory, @NonNull Inventory previous)	Whether a new inventory should be prepared - or if we can re-use the previous one.
abstract @Nullable org.cloudburstmc.protocol.bedrock.data.inventory.ContainerType	closeContainerType(Type container)
void	closeInventory(GeyserSession session, Type container, boolean force)	Closes the inventory, and if necessary, cleans up the prepared inventory.
void	openInventory(GeyserSession session, Type container)	Opens the previously prepared inventory.
boolean	prepareInventory(GeyserSession session, Type container)	Prepares the inventory before opening it.
boolean	requiresOpeningDelay(GeyserSession session, Type container)
void	updateInventory(GeyserSession session, Type container)	Updates the inventory by re-sending items for all slots of the inventory.
void	updateSlot(GeyserSession session, Type container, int slot)	Updates a specific slot by re-sending the item.

Methods inherited from class org.geysermc.geyser.translator.inventory.BaseInventoryTranslator

bedrockSlotToJava, createInventory, getSlotType, javaSlotToBedrock, javaSlotToBedrockContainer, updateProperty

Methods inherited from class org.geysermc.geyser.translator.inventory.InventoryTranslator

acceptRequest, checkNetId, dumpStackRequestDetails, getGridSize, inventoryTranslator, isCursor, makeContainerEntries, rejectRequest, rejectRequest, shouldHandleRequestFirst, shouldRejectItemPlace, translateAutoCraftingRequest, translateCraftingRequest, translateCreativeRequest, translateRequest, translateRequests, translateSpecialRequest

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractBlockInventoryTranslator

public AbstractBlockInventoryTranslator(int size,
 Block javaBlock,
 org.cloudburstmc.protocol.bedrock.data.inventory.ContainerType containerType,
 InventoryUpdater updater,
 Block... additionalValidBlocks)

Parameters:

javaBlock - a Java block that is used as a temporary block

AbstractBlockInventoryTranslator

public AbstractBlockInventoryTranslator(int size,
 BlockState javaBlockState,
 org.cloudburstmc.protocol.bedrock.data.inventory.ContainerType containerType,
 InventoryUpdater updater,
 Block... additionalValidBlocks)

Parameters:

size - the amount of slots that the inventory adds alongside the base inventory slots

javaBlockState - a Java block state that is used as a temporary block

containerType - the container type of this inventory

updater - updater

additionalValidBlocks - any other blocks that can safely use this inventory without a fake block

AbstractBlockInventoryTranslator

public AbstractBlockInventoryTranslator(int size,
 InventoryHolder holder,
 InventoryUpdater updater)

Parameters:

size - the amount of slots that the inventory adds alongside the base inventory slots

holder - the custom block holder

updater - updater

Method Details

requiresOpeningDelay

public boolean requiresOpeningDelay(GeyserSession session,
 Type container)

Overrides:

requiresOpeningDelay in class InventoryTranslator<Type extends Container>

canReuseInventory

public boolean canReuseInventory(GeyserSession session,
 @NonNull Inventory newInventory,
 @NonNull Inventory previous)

Description copied from class: InventoryTranslator

Whether a new inventory should be prepared - or if we can re-use the previous one.

Overrides:

canReuseInventory in class InventoryTranslator<Type extends Container>

prepareInventory

public boolean prepareInventory(GeyserSession session,
 Type container)

Description copied from class: InventoryTranslator

Prepares the inventory before opening it. Bedrock requires the inventory to "exist" before opening it - that can be either a real block (e.g. chest), or an entity (e.g. horse)

Specified by:

prepareInventory in class InventoryTranslator<Type extends Container>

Returns:

whether the inventory was successfully prepared

openInventory

public void openInventory(GeyserSession session,
 Type container)

Description copied from class: InventoryTranslator

Opens the previously prepared inventory.

Specified by:

openInventory in class InventoryTranslator<Type extends Container>

closeInventory

public void closeInventory(GeyserSession session,
 Type container,
 boolean force)

Description copied from class: InventoryTranslator

Closes the inventory, and if necessary, cleans up the prepared inventory.

Specified by:

closeInventory in class InventoryTranslator<Type extends Container>

updateInventory

public void updateInventory(GeyserSession session,
 Type container)

Description copied from class: InventoryTranslator

Updates the inventory by re-sending items for all slots of the inventory.

Specified by:

updateInventory in class InventoryTranslator<Type extends Container>

updateSlot

public void updateSlot(GeyserSession session,
 Type container,
 int slot)

Description copied from class: InventoryTranslator

Updates a specific slot by re-sending the item.

Specified by:

updateSlot in class InventoryTranslator<Type extends Container>

closeContainerType

public abstract @Nullable org.cloudburstmc.protocol.bedrock.data.inventory.ContainerType closeContainerType(Type container)