Package com.hammy275.immersivemc.client.immersive.info

Class AbstractImmersiveInfo

java.lang.Object
com.hammy275.immersivemc.client.immersive.info.AbstractImmersiveInfo
All Implemented Interfaces:
ImmersiveInfo
Direct Known Subclasses:
BeaconInfo, ChestInfo
public abstract class AbstractImmersiveInfo extends Object implements ImmersiveInfo

  • Field Details

    • hitboxes

      public final List<HitboxItemPair> hitboxes

    • pos

      protected final net.minecraft.core.BlockPos pos

    • slotsHovered

      protected final int[] slotsHovered

    • ticksExisted

      protected long ticksExisted

  • Constructor Details

    • AbstractImmersiveInfo

      public AbstractImmersiveInfo(net.minecraft.core.BlockPos pos)

  • Method Details

    • tick

      public void tick()

    • getAllHitboxes

      public List<HitboxItemPair> getAllHitboxes()
      Specified by:
      getAllHitboxes in interface ImmersiveInfo
      Returns:
      The list of all hitboxes this Immersive uses. This can contain null elements, and can return an immutable list implementation if desired.

    • hasHitboxes

      public boolean hasHitboxes()
      Description copied from interface: ImmersiveInfo
      Whether this ImmersiveInfo contains valid hitboxes that are ready for use by users in-game. ImmersiveInfo.getAllHitboxes() will not be called if this method returns false for a given tick.
      Specified by:
      hasHitboxes in interface ImmersiveInfo
      Returns:
      Whether ImmersiveInfo.getAllHitboxes() can be safely called and contains expected data.

    • getBlockPosition

      public net.minecraft.core.BlockPos getBlockPosition()
      Description copied from interface: ImmersiveInfo
      Gets the block position of the block this ImmersiveInfo represents. This function should always return the same value for an individual ImmersiveInfo instance, and this function may be called after the block at this position no longer matches the Immersive it represents.
      For example, if this ImmersiveInfo was used to represent a furnace that was initially placed at x=1, y=2, and z=3, this function should always return the position x=1, y=2, and z=3, even after the furnace is destroyed or replaced by some other block.
      Specified by:
      getBlockPosition in interface ImmersiveInfo
      Returns:
      The position of the block this ImmersiveInfo represents.

    • setSlotHovered

      public void setSlotHovered(int hitboxIndex, int handIndex)
      Description copied from interface: ImmersiveInfo
      A notification to mark the given slot as hovered by the given hand index.
      Specified by:
      setSlotHovered in interface ImmersiveInfo
      Parameters:
      hitboxIndex - The index into ImmersiveInfo.getAllHitboxes() to mark as hovered, or -1 to indicate no slot is hovered by this hand.
      handIndex - 0 for the primary hand (primary controller in VR or the player hand in non-VR), and 1 for the secondary hand (secondary controller in VR, or nothing in non-VR).

    • getSlotHovered

      public int getSlotHovered(int handIndex)
      Specified by:
      getSlotHovered in interface ImmersiveInfo
      Parameters:
      handIndex - The hand that is checking for a hovered hitbox.
      Returns:
      The hitbox the handIndex is hovering, or -1 if it isn't hovering any slot.

    • isSlotHovered

      public boolean isSlotHovered(int hitboxIndex)

    • getTicksExisted

      public long getTicksExisted()
      Specified by:
      getTicksExisted in interface ImmersiveInfo
      Returns:
      The number of ticks this info has existed for.