Class ImmersiveChest

java.lang.Object
com.hammy275.immersivemc.client.immersive.AbstractImmersive<ChestInfo, ChestRenderState, ListOfItemsStorage>
com.hammy275.immersivemc.client.immersive.ImmersiveChest
All Implemented Interfaces:
Immersive<ChestInfo, ChestRenderState, ListOfItemsStorage>
public class ImmersiveChest extends AbstractImmersive<ChestInfo, ChestRenderState, ListOfItemsStorage>

  • Field Details

  • Constructor Details

    • ImmersiveChest

      public ImmersiveChest()

  • Method Details

    • globalTick

      public void globalTick()
      Description copied from interface: Immersive
      This is the same as Immersive.tick(ImmersiveInfo), but called once per tick, instead of called once per tick per info.

    • buildInfo

      public ChestInfo buildInfo(net.minecraft.core.BlockPos pos, net.minecraft.world.level.Level level)
      Description copied from interface: Immersive
      Constructs a new ImmersiveInfo based on the provided block position. It's best to calculate initial hitboxes, etc. in this method to make the Immersive available for interaction as soon as possible.
      Parameters:
      pos - The position of a block that matches this Immersive.
      level - The level in which this info is being built.
      Returns:
      An instance of an ImmersiveInfo implementation with the same position as provided.

    • handleHitboxInteract

      public int handleHitboxInteract(ChestInfo info, net.minecraft.client.player.LocalPlayer player, List<Integer> hitboxIndices, net.minecraft.world.InteractionHand hand, boolean modifierPressed)
      Description copied from interface: Immersive
      The method called when a player interacts with a hitbox.
      If multiple hitboxes are being interacted with at the same time, only the first hitbox in iteration order from ImmersiveInfo.getAllHitboxes() that is being interacted with will have this function called.
      Parameters:
      info - The info containing the hitbox that was interacted with.
      player - The player that interacted with the hitbox. This player is always the player currently controlling the game window.
      hitboxIndices - The indices into ImmersiveInfo.getAllHitboxes() that were interacted with. The list is guaranteed to contain at least one element and all elements are not null.
      hand - The hand used for interaction.
      modifierPressed - Whether the modifier key (usually the button mapped to breaking blocks) was held for the interaction.
      Returns:
      A number representing the number of ticks of cooldown to apply before the player can interact with any Immersive again, or a negative number to denote no actual interaction has happened, such as obtaining items from an output slot of an Immersive when the output slot has no items. This cooldown should be the cooldown for desktop users if Immersive.isVROnly() returns false, and it should be the cooldown for VR users if Immersive.isVROnly() returns true. ImmersiveMC will modify this cooldown time to accommodate situations, such as VR users requiring an increased cooldown time.

    • shouldRender

      public boolean shouldRender(ChestRenderState renderState)
      Description copied from interface: Immersive
      Whether the provided render state should render in the world. It's good to return false here if this Immersive does not have its data ready for rendering.
      Parameters:
      renderState - The render state to check.
      Returns:
      Whether the provided render state should render to the world, which includes calling Immersive.render(ImmersiveRenderState, PoseStack, ImmersiveRenderHelpers, float).

    • render

      public void render(ChestRenderState renderState, com.mojang.blaze3d.vertex.PoseStack stack, ImmersiveRenderHelpers helpers, float partialTick)
      Description copied from interface: Immersive
      Render the provided render state.
      Parameters:
      renderState - The render state to render.
      stack - The pose stack being rendered with.
      helpers - Some helper functions for rendering.
      partialTick - The fraction of time between the last tick and the current tick.

    • tick

      public void tick(ChestInfo info)
      Description copied from interface: Immersive
      This method is called once per game tick. This is where you should, for example, recalculate hitboxes if needed.
      Specified by:
      tick in interface Immersive<ChestInfo, ChestRenderState, ListOfItemsStorage>
      Overrides:
      tick in class AbstractImmersive<ChestInfo, ChestRenderState, ListOfItemsStorage>
      Parameters:
      info - The info being ticked.

    • getDragHitbox

      @Nullable public @Nullable net.minecraft.world.phys.AABB getDragHitbox(ChestInfo info)
      Returns:
      The hitbox that determines whether dragging between multiple slots should continue or not. Can return null here to not allow dragging. If non-null, the hitbox should contain all hitboxes where Immersive.isInputHitbox(ImmersiveInfo, int) returns true.

    • isInputHitbox

      public boolean isInputHitbox(ChestInfo info, int hitboxIndex)
      Parameters:
      info - The info being checked with.
      hitboxIndex - The hitbox index being checked.
      Returns:
      Whether the provided hitbox index is an input, such as for inputting items.

    • getHandler

      public ImmersiveHandler<ListOfItemsStorage> getHandler()
      Returns:
      The ImmersiveHandler this Immersive uses.

    • configScreenInfo

      @Nullable public @Nullable ImmersiveConfigScreenInfo configScreenInfo()
      Description copied from interface: Immersive
      The info needed to build a config screen button for this Immersive. If this method returns null, ImmersiveMC will not add a setting for this Immersive to its in-game configuration. Reasons to possibly return null from this method include, but are not limited to:
      • This Immersive cannot be controlled via a config.
      • Another mod already handles configuring this Immersive.
      Returns:
      An ImmersiveConfigScreenInfo instance used for ImmersiveMC to add this Immersive to its in-game configuration screens, or null if ImmersiveMC should not do so.

    • shouldDisableRightClicksWhenVanillaInteractionsDisabled

      public boolean shouldDisableRightClicksWhenVanillaInteractionsDisabled(ChestInfo info)
      Description copied from interface: Immersive
      Whether normal right-click behavior for this block should be disabled when the option to disable interactions is enabled in ImmersiveMC. This should usually return true if the block opens a GUI on right-click.
      Parameters:
      info - The info for the block that may want to disable right-clicks.
      Returns:
      Whether to skip right-click behavior for this block when the option to disable click interactions is enabled in ImmersiveMC.

    • processStorageFromNetwork

      public void processStorageFromNetwork(ChestInfo info, ListOfItemsStorage storage)
      Description copied from interface: Immersive
      Process the storage from the server for this Immersive. Not called for Immersives that return true for Immersive.getHandler()'s ImmersiveHandler.clientAuthoritative().
      Parameters:
      info - The info with storage being processed.
      storage - The storage to be processed.

    • isVROnly

      public boolean isVROnly()
      Returns:
      Whether this Immersive should only exist for VR users. The same value should always be returned by this method.

    • createRenderState

      public ChestRenderState createRenderState()
      Description copied from interface: Immersive
      Creates a new render state not populated with any rendering-related details.
      Returns:
      Created render state, as described.

    • extractRenderState

      public void extractRenderState(ChestInfo info, ChestRenderState renderState, float partialTicks)
      Description copied from interface: Immersive
      Extract render state from the info into the provided render state object.

      The extracted render state must be independent of the info it comes from such that mutations to the info do not affect the render state. For example, if the info contains a list of hitboxes, a modification to that list must NOT modify the list of hitboxes stored in the render state.

      Specified by:
      extractRenderState in interface Immersive<ChestInfo, ChestRenderState, ListOfItemsStorage>
      Overrides:
      extractRenderState in class AbstractImmersive<ChestInfo, ChestRenderState, ListOfItemsStorage>
      Parameters:
      info - Info to extract render state from.
      renderState - Render state to populate from the info. Note that the API does NOT cover the state of this object when this function is called. It only defines that this should be fully populated from the provided info for rendering. As such, it's recommended to set the values for all fields in this object based on the provided info every time this method is called.
      partialTicks - The fraction of time between the last tick and the current tick.

    • chestsValid

      public boolean chestsValid(ChestInfo info)

    • findImmersive

      public static ChestInfo findImmersive(net.minecraft.world.level.block.entity.BlockEntity chest)

    • openChest

      public static void openChest(ChestInfo info)

    • slotVisible

      public static boolean slotVisible(float openness, int slot)