Package com.hammy275.immersivemc.api.common.immersive

Interface MultiblockImmersiveHandler<S extends NetworkStorage>

All Superinterfaces:
ImmersiveHandler<S>
All Known Implementing Classes:
ChestHandler
public interface MultiblockImmersiveHandler<S extends NetworkStorage> extends ImmersiveHandler<S>
A version of the ImmersiveHandler with support for multiblock structures. Multiblocks in this context are Immersives that consist of multiple blocks that should be treated as one Immersive and also need to be treated as such. For example, a double chest IS a multiblock since it consists of multiple blocks and needs to be treated as one Immersive "instance". On the other hand, a beacon is NOT a multiblock by this definition, as the only block that players interact with immersively is the beacon block itself, rather than any of the pyramid blocks that are placed below the beacon.
All ImmersiveHandler methods that take a block position now represent some block position in the multiblock. Which block position is passed is not specified by the API, so it may be any block position in your multiblock.
Immersives that are built for MultiblockImmersiveHandlers may need to be ready to adjust if a new part of the multiblock is suddenly added. For example, if a chest Immersive's info stored a value containing the secondary chest of a double chest, this field may need to be updated on every tick in case such a second chest is placed, or if a second chest is removed.

  • Method Details

    • getHandledBlocks

      @Nullable @Nullable Set<net.minecraft.core.BlockPos> getHandledBlocks(net.minecraft.core.BlockPos pos, net.minecraft.world.level.Level level)
      This method should return all blocks that are part of this multiblock, given the position of one block in this multiblock. For example, if this multiblock was for a double-chest, the position provided to calls of this function may be either the left chest or the right chest, and should return a set that contains BOTH the left chest AND the right chest. Note that if the multiblock is in a correct state (no part of the multiblock has been broken), ImmersiveHandler.isValidBlock(BlockPos, Level) should return true for all blocks of the multiblock. This way, when a block in the multiblock breaks, the aforementioned function will return false, thus alerting ImmersiveMC that the multiblock is no longer valid.
      If your multiblock isn't always a multiblock (such as chests, which can sometimes simply be single-chests), you can simply return a set containing the provided block position.
      Some additional rules about this function:
      • If the block provided is unable to make a valid multiblock (such as if the multiblock is still under construction, or it was broken), you may return null. You may also simply return a set which contains at least one element that returns false for ImmersiveHandler.isValidBlock(BlockPos, Level).
      • You are not required to check if all blocks of the multiblock are valid. ImmersiveMC will check if every block in your multiblock is valid.
      • Rarely, a multiblock may change shape while never ending up in an invalid state. For example, the left chest of a double chest may become the right chest of a double chest via command blocks. Your Immersive should handle this gracefully.
      • This function should NOT return an empty set or a set containing null elements.
      Parameters:
      pos - The position of one block in this multiblock.
      level - The level where one block of this multiblock is found.
      Returns:
      All blocks that make up this multiblock, or null if the provided position cannot make a valid multiblock. This set will not be modified by ImmersiveMC, and it should NOT contain null nor should it be an empty set.