16552051255

Committed 27 Jul 2025 01:58PM UTC coverage: 53.206% (+8.0%) from 45.161%

Build # 16552051255

Build Type

push

github

Committed by

rubensworks

Commit Message

Resolve minor TODOs

Run Details

2888 of 8740 branches covered (33.04%)

Branch coverage included in aggregate %.

17341 of 29280 relevant lines covered (59.22%)

3.08 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

77.01

/src/main/java/org/cyclops/integrateddynamics/core/helper/CableHelpers.java

package org.cyclops.integrateddynamics.core.helper;

import com.google.common.collect.Lists;
import com.google.common.collect.Maps;
import com.google.common.collect.Sets;
import net.minecraft.core.BlockPos;
import net.minecraft.core.Direction;
import net.minecraft.resources.ResourceKey;
import net.minecraft.world.InteractionResult;
import net.minecraft.world.entity.LivingEntity;
import net.minecraft.world.entity.player.Player;
import net.minecraft.world.item.ItemStack;
import net.minecraft.world.level.Level;
import net.minecraft.world.level.block.Block;
import net.minecraft.world.level.block.entity.BlockEntity;
import net.minecraft.world.level.block.state.BlockState;
import net.neoforged.neoforge.common.NeoForge;
import net.neoforged.neoforge.common.extensions.ILevelExtension;
import org.apache.commons.lang3.tuple.Pair;
import org.cyclops.cyclopscore.helper.IModHelpers;
import org.cyclops.cyclopscore.helper.IModHelpersNeoForge;
import org.cyclops.integrateddynamics.Capabilities;
import org.cyclops.integrateddynamics.api.block.IFacadeable;
import org.cyclops.integrateddynamics.api.block.cable.ICable;
import org.cyclops.integrateddynamics.api.block.cable.ICableFakeable;
import org.cyclops.integrateddynamics.api.network.INetwork;
import org.cyclops.integrateddynamics.api.network.INetworkCarrier;
import org.cyclops.integrateddynamics.api.network.INetworkElement;
import org.cyclops.integrateddynamics.api.network.INetworkElementProvider;
import org.cyclops.integrateddynamics.api.part.IPartContainer;
import org.cyclops.integrateddynamics.api.part.IPartType;
import org.cyclops.integrateddynamics.api.path.IPathElement;
import org.cyclops.integrateddynamics.core.network.event.NetworkInitializedEvent;
import org.cyclops.integrateddynamics.item.ItemBlockCable;

import javax.annotation.Nullable;
import java.lang.ref.WeakReference;
import java.util.*;

/**
 * Helpers related to cables.
 * @author rubensworks
 */
public class CableHelpers {

    public static final Collection<Direction> ALL_SIDES = Sets.newIdentityHashSet();
    static {
        for (Direction side : Direction.values()) {
            ALL_SIDES.add(side);
        }
    }

    /**
     * Get the cable capability at the given position.
     * @param world The world.
     * @param pos The position.
     * @param side The side.
     * @return The optional cable capability.
     */
    @Deprecated // TODO: attempt to migrate all calls to method with BlockState param
    public static Optional<ICable> getCable(ILevelExtension world, BlockPos pos, @Nullable Direction side) {
        return IModHelpersNeoForge.get().getCapabilityHelpers().getCapability(world, pos, side, Capabilities.Cable.BLOCK);
    }

    /**
     * Get the cable capability at the given position.
     * @param world The world.
     * @param pos The position.
     * @param side The side.
     * @param blockState The block state.
     * @return The optional cable capability.
     */
    public static Optional<ICable> getCable(ILevelExtension world, BlockPos pos, @Nullable Direction side, @Nullable BlockState blockState) {
        return Optional.ofNullable(world.getCapability(Capabilities.Cable.BLOCK, pos, blockState, null, side));
    }

    /**
     * Get the fakeable cable capability at the given position.
     * @param world The world.
     * @param pos The position.
     * @param side The side.
     * @return The optional fakeable cable capability.
     */
    @Deprecated // TODO: attempt to migrate all calls to method with BlockState param
    public static Optional<ICableFakeable> getCableFakeable(ILevelExtension world, BlockPos pos, @Nullable Direction side) {
        return IModHelpersNeoForge.get().getCapabilityHelpers().getCapability(world, pos, side, Capabilities.CableFakeable.BLOCK);
    }

    /**
     * Get the fakeable cable capability at the given position.
     * @param world The world.
     * @param pos The position.
     * @param side The side.
     * @param blockState The block state.
     * @return The optional fakeable cable capability.
     */
    public static Optional<ICableFakeable> getCableFakeable(ILevelExtension world, BlockPos pos, @Nullable Direction side, BlockState blockState) {
        return Optional.ofNullable(world.getCapability(Capabilities.CableFakeable.BLOCK, pos, blockState, null, side));
    }

    /**
     * Get the path element capability at the given position.
     * @param world The world.
     * @param pos The position.
     * @param side The side.
     * @return The optional path element capability.
     */
    @Deprecated // TODO: attempt to migrate all calls to method with BlockState param
    public static Optional<IPathElement> getPathElement(ILevelExtension world, BlockPos pos, @Nullable Direction side) {
        return IModHelpersNeoForge.get().getCapabilityHelpers().getCapability(world, pos, side, Capabilities.PathElement.BLOCK);
    }

    /**
     * Get the path element capability at the given position.
     * @param world The world.
     * @param pos The position.
     * @param side The side.
     * @return The optional path element capability.
     */
    public static Optional<IPathElement> getPathElement(ILevelExtension world, BlockPos pos, @Nullable Direction side, BlockState blockState) {
        return Optional.ofNullable(world.getCapability(Capabilities.PathElement.BLOCK, pos, blockState, null, side));
    }

    /**
     * Request to update the cable connections of all neighbours of the given position.
     * @param world The world.
     * @param pos The center position.
     * @param sides The sides to update connections for.
     */
    public static void updateConnectionsNeighbours(ILevelExtension world, BlockPos pos, Collection<Direction> sides) {
        for(Direction side : sides) {
            updateConnections(world, pos.relative(side), side.getOpposite());
        }
    }

    /**
     * Request to update the cable connections at the given position.
     * @param world The world.
     * @param pos The position.
     * @param side The side.
     */
    public static void updateConnections(ILevelExtension world, BlockPos pos, @Nullable Direction side) {
        getCable(world, pos, side)
                .ifPresent(ICable::updateConnections);
    }

    /**
     * Check if there is a cable at the given position AND if it is connected for the given side.
     * @param world The world.
     * @param pos The position.
     * @param side The side to check a connection for.
     * @return If there is a cable that is connected.
     */
    @Deprecated // TODO: attempt to migrate all calls to method with BlockState param
    public static boolean isCableConnected(ILevelExtension world, BlockPos pos, Direction side) {
        return getCable(world, pos, side)
                .map(cable -> cable.isConnected(side))
                .orElse(false);
    }

    /**
     * Check if there is a cable at the given position AND if it is connected for the given side.
     * @param world The world.
     * @param pos The position.
     * @param side The side to check a connection for.
     * @param blockState The block state.
     * @return If there is a cable that is connected.
     */
    public static boolean isCableConnected(ILevelExtension world, BlockPos pos, Direction side, BlockState blockState) {
        return getCable(world, pos, side, blockState)
                .map(cable -> cable.isConnected(side))
                .orElse(false);
    }

    /**
     * Check if one side of the given cable at the given position can connect to the given side.
     * To be used when the cable connections are being updated.
     * This will check if the origin cable can connect to that side,
     * if there is a cable at the target side and if that cable can connect with this side.
     * This ignores any current cable connections.
     * @param world The world.
     * @param pos The center position.
     * @param side The side from the center position to check.
     * @param originCable The cable at the center position.
     * @return If it can connect.
     */
    public static boolean canCableConnectTo(ILevelExtension world, BlockPos pos, Direction side, ICable originCable) {
        BlockPos neighbourPos = pos.relative(side);
        return getCable(world, neighbourPos, side.getOpposite())
                .map(neighbourCable -> originCable.canConnect(neighbourCable, side)
                        && neighbourCable.canConnect(originCable, side.getOpposite()))
                .orElse(false);
    }

    /**
     * Check if the given position is not a fake cable.
     * This can mean that there is no cable at all!
     * But if there is a cable, this method will return true only if it is a real cable.
     * @param world The world.
     * @param pos The position.
     * @param side The side.
     * @return If there is no fake cable.
     */
    @Deprecated // TODO: attempt to migrate all calls to method with BlockState param
    public static boolean isNoFakeCable(ILevelExtension world, BlockPos pos, @Nullable Direction side) {
        return getCableFakeable(world, pos, side)
                .map(ICableFakeable::isRealCable)
                .orElse(true);
    }

    /**
     * Check if the given position is not a fake cable.
     * This can mean that there is no cable at all!
     * But if there is a cable, this method will return true only if it is a real cable.
     * @param world The world.
     * @param pos The position.
     * @param side The side.
     * @param blockState The block state.
     * @return If there is no fake cable.
     */
    public static boolean isNoFakeCable(ILevelExtension world, BlockPos pos, @Nullable Direction side, BlockState blockState) {
        return getCableFakeable(world, pos, side, blockState)
                .map(ICableFakeable::isRealCable)
                .orElse(true);
    }

    /**
     * Disconnect a cable's side.
     * @param world The cable world.
     * @param pos The cable position.
     * @param side The cable side.
     * @param cable The cable to disconnect.
     * @param disconnectSide The side to disconnect.
     */
    public static void disconnectCable(Level world, BlockPos pos, Direction side, ICable cable, Direction disconnectSide) {
        // Store the disconnection in the part entity
        cable.disconnect(disconnectSide);

        // Signal changes
        cable.updateConnections();
        Collection<Direction> sidesToUpdate = getCableConnections(cable);
        sidesToUpdate.add(disconnectSide);
        CableHelpers.updateConnectionsNeighbours(world, pos, sidesToUpdate);

        // Reinit the networks for this block and the disconnected neighbour.
        NetworkHelpers.initNetwork(world, pos, side);
        NetworkHelpers.initNetwork(world, pos.relative(disconnectSide), side.getOpposite());
    }

    /**
     * Actions to be performed when a player right clicks on a cable.
     * @param world The world  of the cable.
     * @param pos The position of the cable.
     * @param state The blockstate of the cable.
     * @param player The player activating the cable.
     * @param heldItem The item with which the player is right-clicking.
     * @param side The side of the block the player right-clicked on.
     * @param cableConnectionHit The side identifying the cable connection that is being activated,
     *                           this will be null if the center part of the cable is activated.
     * @return Action result.
     */
    public static InteractionResult onCableActivated(Level world, BlockPos pos, BlockState state, Player player,
                                                    ItemStack heldItem, Direction side, @Nullable Direction cableConnectionHit) {
        ICable cable = CableHelpers.getCable(world, pos, side).orElse(null);
        if (cable == null) {
            return InteractionResult.PASS;
        }

        if(WrenchHelpers.isWrench(player, heldItem, world, pos, side)) {
            if (world.isClientSide()) {
                return InteractionResult.SUCCESS; // Don't do anything client-side
            }
            if (player.isSecondaryUseActive()) {
                removeCable(world, pos, player);
            } else if (cableConnectionHit != null) {
                disconnectCable(world, pos, side, cable, cableConnectionHit);
            } else if (cableConnectionHit == null) {
                // Reconnect cable side
                BlockPos neighbourPos = pos.relative(side);
                ICable neighbourCable = CableHelpers.getCable(world, neighbourPos, side.getOpposite()).orElse(null);
                if(neighbourCable != null && !cable.isConnected(side) &&
                        (cable.canConnect(neighbourCable, side) || neighbourCable.canConnect(cable, side.getOpposite()))
                        ) {
                    // Notify the reconnection in the part entity of this and the neighbour block,
                    // since we don't know in which one the disconnection was made.
                    cable.reconnect(side);
                    neighbourCable.reconnect(side.getOpposite());

                    // Signal changes
                    cable.updateConnections();
                    Collection<Direction> sidesToUpdate = getCableConnections(cable);
                    sidesToUpdate.add(side);
                    CableHelpers.updateConnectionsNeighbours(world, pos, sidesToUpdate);

                    // Reinit the networks for this block and the connected neighbour.
                    NetworkHelpers.initNetwork(world, pos, side);
                    NetworkHelpers.initNetwork(world, neighbourPos, side.getOpposite());
                }
            }
            return InteractionResult.SUCCESS;
        }
        return InteractionResult.PASS;
    }

    private static WeakReference<LivingEntity> CABLE_PLACER_SNAPSHOT = new WeakReference<>(null);

    /**
     * This should be called when a cable is added.
     * This method automatically notifies the neighbours and (re-)initializes the network if this cable carries one.
     * This should in most cases only be called server-side.
     * @param world The world.
     * @param pos The position.
     */
    public static void onCableAdded(Level world, BlockPos pos) {
        LivingEntity placer = CABLE_PLACER_SNAPSHOT.get();
        if (placer != null) {
            CableHelpers.onCableAddedByPlayer(world, pos, placer);
            CABLE_PLACER_SNAPSHOT = new WeakReference<>(null);
        } else {
            onCableAddedByPlayerActual(world, pos, null);
        }
    }

    /**
     * This should be called when a cable was added by a player.
     * This should be called after {@link CableHelpers#onCableAdded(Level, BlockPos)}.
     * It simply emits an player-sensitive init event on the network bus.
     * @param world The world.
     * @param pos The position.
     * @param placer The entity who placed the cable.
     */
    public static void onCableAddedByPlayer(Level world, BlockPos pos, @Nullable LivingEntity placer) {
        if (world.captureBlockSnapshots) {
            CABLE_PLACER_SNAPSHOT = new WeakReference<>(placer);
        } else {
            onCableAddedByPlayerActual(world, pos, placer);
        }
    }

    /**
     * This should be called when a cable was added by a player.
     * This should be called after {@link CableHelpers#onCableAdded(Level, BlockPos)}.
     * It simply emits an player-sensitive init event on the network bus.
     * @param world The world.
     * @param pos The position.
     * @param placer The entity who placed the cable.
     */
    public static void onCableAddedByPlayerActual(Level world, BlockPos pos, @Nullable LivingEntity placer) {
        CableHelpers.updateConnectionsNeighbours(world, pos, CableHelpers.ALL_SIDES);
        if(!world.isClientSide()) {
            NetworkHelpers.initNetwork(world, pos, null)
                    .ifPresent(network -> NeoForge.EVENT_BUS.post(new NetworkInitializedEvent(network, world, pos, placer)));
        }
    }

    private static final Map<Pair<ResourceKey<Level>, BlockPos>, Collection<Direction>> CABLE_REMOVING_CONNECTIONS = Maps.newConcurrentMap();

    public static void overrideCableRemovingConnections(Level level, BlockPos pos, Collection<Direction> sides) {
        CABLE_REMOVING_CONNECTIONS.put(Pair.of(level.dimension(), pos), sides);
    }

    /**
     * This should be called when a cable is being removed, while the part entity is still present.
     * This method won't do anything when called client-side.
     *
     * @param world           The world.
     * @param pos             The position.
     * @param dropMainElement If the main part element should be dropped.
     * @param saveState       If the element state should be saved in the item.
     * @param blockState      The block state.
     * @param blockEntity     The block entity.
     * @return If the cable was removed from the network.
     */
    public static boolean onCableRemoving(Level world, BlockPos pos, boolean dropMainElement, boolean saveState, BlockState blockState, BlockEntity blockEntity) {
        CABLE_REMOVING_CONNECTIONS.put(Pair.of(world.dimension(), pos), CableHelpers.getExternallyConnectedCables(world, pos));
        if (!world.isClientSide() && CableHelpers.isNoFakeCable(world, pos, null)) {
            INetworkCarrier networkCarrier = NetworkHelpers.getNetworkCarrier(world, pos, null, blockState).orElse(null);

            // Get all drops from the network elements this cable provides.
            List<ItemStack> itemStacks = Lists.newLinkedList();
            INetworkElementProvider networkElementProvider = NetworkHelpers.getNetworkElementProvider(world, pos, null, blockState).orElse(null);
            if (networkElementProvider != null) {
                for (INetworkElement networkElement : networkElementProvider.createNetworkElements(world, pos)) {
                    networkElement.addDrops(blockState, blockEntity, itemStacks, dropMainElement, saveState);
                }
                for (ItemStack itemStack : itemStacks) {
                    Block.popResource(world, pos, itemStack);
                }
            }

            // If the cable has a network, remove it from the network.
            if(networkCarrier != null && networkCarrier.getNetwork() != null) {
                IPathElement pathElement = getPathElement(world, pos, null, blockState)
                        .orElseThrow(() -> new IllegalStateException("Could not find a valid path element capability"));
                return onCableRemovingNetwork(blockState, blockEntity, networkCarrier, pathElement);
            }
        }
        return true;
    }

    public static boolean onCableRemovingNetwork(BlockState blockState, BlockEntity blockEntity, INetworkCarrier networkCarrier, IPathElement pathElement) {
        INetwork network = networkCarrier.getNetwork();
        networkCarrier.setNetwork(null);
        return network.removePathElement(pathElement, null, blockState, blockEntity);
    }

    /**
     * This should be called AFTER a cable is removed, at this stage the part entity will not exist anymore.
     * This method won't do anything when called client-side.
     * @param world The world.
     * @param pos The position.
     * @return If the cable was removed from the network.
     */
    public static boolean onCableRemoved(Level world, BlockPos pos) {
        Collection<Direction> sides = CABLE_REMOVING_CONNECTIONS.remove(Pair.of(world.dimension(), pos));
        if (sides == null) {
            sides = Collections.emptyList();
        }
        updateConnectionsNeighbours(world, pos, sides);
        if (!world.isClientSide()) {
            // Reinit neighbouring networks.
            for(Direction side : sides) {
                BlockPos sidePos = pos.relative(side);
                NetworkHelpers.initNetwork(world, sidePos, side.getOpposite());
            }
        }
        return true;
    }

    private static boolean removingCable = false;
    /**
     * @return If {@link #removeCable} is currently being called.
     */
    public static boolean isRemovingCable() {
        return removingCable;
    }
    /**
     * @param removingCable If the removing cable flag should be set
     */
    public static void setRemovingCable(boolean removingCable) {
        CableHelpers.removingCable = removingCable;
    }

    /**
     * Remove a cable.
     * This will automatically handle sounds, drops,
     * fakeable cables, network element removal and network (re)intialization.
     * @param world The world.
     * @param pos The position.
     * @param player The player removing the cable or null.
     */
    public static void removeCable(Level world, BlockPos pos, @Nullable Player player) {
        removingCable = true;
        ICable cable = getCable(world, pos, null).orElse(null);
        ICableFakeable cableFakeable = getCableFakeable(world, pos, null).orElse(null);
        IPartContainer partContainer = PartHelpers.getPartContainer(world, pos, null).orElse(null);
        BlockState blockState = world.getBlockState(pos);
        BlockEntity blockEntity = world.getBlockEntity(pos);
        if (cable == null) {
            removingCable = false;
            return;
        }

        CableHelpers.onCableRemoving(world, pos, false, false, blockState, blockEntity);
        // If the cable has no parts or is not fakeable, remove the block,
        // otherwise mark the cable as being fake.
        if (cableFakeable == null || partContainer == null || !partContainer.hasParts()) {
            cable.destroy();
        } else {
            cableFakeable.setRealCable(false);
        }
        if (player == null) {
            IModHelpers.get().getItemStackHelpers().spawnItemStack(world, pos, cable.getItemStack());
        } else if (!player.isCreative()) {
            IModHelpers.get().getItemStackHelpers().spawnItemStackToPlayer(world, pos, cable.getItemStack(), player);
        }
        CableHelpers.onCableRemoved(world, pos);

        ItemBlockCable.playBreakSound(world, pos, blockState);

        removingCable = false;
    }

    /**
     * Check if the target has a facade.
     * @param world The world.
     * @param pos The position.
     * @return If it has a facade.
     */
    @Deprecated // TODO: attempt to migrate all calls to method with BlockState param
    public static boolean hasFacade(ILevelExtension world, BlockPos pos) {
        return IModHelpersNeoForge.get().getCapabilityHelpers().getCapability(world, pos, null, Capabilities.Facadeable.BLOCK)
                .map(IFacadeable::hasFacade)
                .orElse(false);
    }

    /**
     * Check if the target has a facade.
     * @param world The world.
     * @param pos The position.
     * @param blockState The block state.
     * @return If it has a facade.
     */
    public static boolean hasFacade(ILevelExtension world, BlockPos pos, BlockState blockState) {
        return Optional.ofNullable(world.getCapability(Capabilities.Facadeable.BLOCK, pos, blockState, null, null))
                .map(IFacadeable::hasFacade)
                .orElse(false);
    }

    /**
     * Get the target's facade
     * @param world The world.
     * @param pos The position.
     * @return The optional facade.
     */
    @Deprecated // TODO: attempt to migrate all calls to method with BlockState param
    public static Optional<BlockState> getFacade(ILevelExtension world, BlockPos pos) {
        return IModHelpersNeoForge.get().getCapabilityHelpers().getCapability(world, pos, null, Capabilities.Facadeable.BLOCK)
                .flatMap(facadeable -> Optional.ofNullable(facadeable.getFacade()));
    }

    /**
     * Get the target's facade
     * @param world The world.
     * @param pos The position.
     * @param blockState The block state.
     * @return The optional facade.
     */
    public static Optional<BlockState> getFacade(ILevelExtension world, BlockPos pos, BlockState blockState) {
        return Optional.ofNullable(world.getCapability(Capabilities.Facadeable.BLOCK, pos, blockState, null, null))
                .flatMap(facadeable -> Optional.ofNullable(facadeable.getFacade()));
    }

    @Deprecated // TODO: attempt to migrate all calls to method with BlockState param
    public static boolean isLightTransparent(Level world, BlockPos pos, @Nullable Direction side) {
        return PartHelpers.getPartContainer(world, pos, side)
                .map(partContainer -> {
                    for (Map.Entry<Direction, IPartType<?, ?>> entry : partContainer.getParts().entrySet()) {
                        IPartType part = entry.getValue();
                        if (part.forceLightTransparency(partContainer.getPartState(entry.getKey()))) {
                            return true;
                        }
                    }
                    return false;
                })
                .orElse(false);
    }

    public static boolean isLightTransparent(Level world, BlockPos pos, @Nullable Direction side, BlockState blockState) {
        return PartHelpers.getPartContainer(world, pos, side, blockState)
                .map(partContainer -> {
                    for (Map.Entry<Direction, IPartType<?, ?>> entry : partContainer.getParts().entrySet()) {
                        IPartType part = entry.getValue();
                        if (part.forceLightTransparency(partContainer.getPartState(entry.getKey()))) {
                            return true;
                        }
                    }
                    return false;
                })
                .orElse(false);
    }

    /**
     * Get the sides the cable is currently connected to.
     * @param cable A cable.
     * @return The cable connections.
     */
    public static Collection<Direction> getCableConnections(ICable cable) {
        Collection<Direction> sides = Sets.newIdentityHashSet();
        for (Direction side : Direction.values()) {
            if (cable.isConnected(side)) {
                sides.add(side);
            }
        }
        return sides;
    }

    /**
     * Get the sides that are externally connected to the given position.
     * @param world The world.
     * @param pos The position.
     * @return The sides.
     */
    public static Collection<Direction> getExternallyConnectedCables(Level world, BlockPos pos) {
        Collection<Direction> sides = Sets.newIdentityHashSet();
        for (Direction side : Direction.values()) {
            if (CableHelpers.isCableConnected(world, pos.relative(side), side.getOpposite(), null)) {
                sides.add(side);
            }
        }
        return sides;
    }
}

CyclopsMC / IntegratedDynamics / 16552051255

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous