From 4691f83274d8a5d7dc8afe6eba6152128ef9ac36 Mon Sep 17 00:00:00 2001 From: Chris Anderson Date: Sat, 22 Jul 2017 21:47:10 -0600 Subject: [PATCH] Add JavaDoc to MultipartTileNetworkJoiner --- .../multipart/MultipartTileNetworkJoiner.java | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/src/main/java/mekanism/common/integration/multipart/MultipartTileNetworkJoiner.java b/src/main/java/mekanism/common/integration/multipart/MultipartTileNetworkJoiner.java index ea24d7fcc..166e4d4fc 100644 --- a/src/main/java/mekanism/common/integration/multipart/MultipartTileNetworkJoiner.java +++ b/src/main/java/mekanism/common/integration/multipart/MultipartTileNetworkJoiner.java @@ -13,10 +13,25 @@ import mekanism.common.base.ITileNetwork; import net.minecraft.tileentity.TileEntity; import net.minecraft.world.IBlockAccess; +/** + * Used to route {@link ITileNetwork} packets sent to multipart containers with more than one possible recipient.
+ *
+ * When MCMP is enabled single byte EnumFacing ordinal headers are added to packets sent by glow panels and + * transmitters that are then used by this class to route packets to the part attached to the appropriate side.
+ *
+ * In this case, since transmitters do not attach to a side and therefore have no matching EnumFacing the special + * value 6 is used to represent the center slot. + */ public class MultipartTileNetworkJoiner implements ITileNetwork { private final HashMap tileSideMap; + /** + * Called by MCMP's multipart container when more than one part implements {@link ITileNetwork}.
+ *
+ * Builds an internal map of part slots to {@link ITileNetwork} implementations in order to route packets. + * @param tileList A list of the tile entities that implement {@link ITileNetwork} in the container. + */ public MultipartTileNetworkJoiner(List tileList) { tileSideMap = new HashMap<>();