38 lines
1.5 KiB
Java
38 lines
1.5 KiB
Java
/*
|
|
* This file is part of the public ComputerCraft API - http://www.computercraft.info
|
|
* Copyright Daniel Ratcliffe, 2011-2020. This API may be redistributed unmodified and in full only.
|
|
* For help using the API, and posting your mods, visit the forums at computercraft.info.
|
|
*/
|
|
package dan200.computercraft.api.peripheral;
|
|
|
|
import net.minecraft.tileentity.TileEntity;
|
|
import net.minecraft.util.Direction;
|
|
import net.minecraft.util.math.BlockPos;
|
|
import net.minecraft.world.World;
|
|
|
|
import javax.annotation.Nonnull;
|
|
import javax.annotation.Nullable;
|
|
|
|
/**
|
|
* This interface is used to create peripheral implementations for blocks.
|
|
*
|
|
* If you have a {@link TileEntity} which acts as a peripheral, you may alternatively implement {@link IPeripheralTile}.
|
|
*
|
|
* @see dan200.computercraft.api.ComputerCraftAPI#registerPeripheralProvider(IPeripheralProvider)
|
|
*/
|
|
@FunctionalInterface
|
|
public interface IPeripheralProvider
|
|
{
|
|
/**
|
|
* Produce an peripheral implementation from a block location.
|
|
*
|
|
* @param world The world the block is in.
|
|
* @param pos The position the block is at.
|
|
* @param side The side to get the peripheral from.
|
|
* @return A peripheral, or {@code null} if there is not a peripheral here you'd like to handle.
|
|
* @see dan200.computercraft.api.ComputerCraftAPI#registerPeripheralProvider(IPeripheralProvider)
|
|
*/
|
|
@Nullable
|
|
IPeripheral getPeripheral( @Nonnull World world, @Nonnull BlockPos pos, @Nonnull Direction side );
|
|
}
|