buildcraft.api.transport

Interface IItemPluggable

All Known Implementing Classes:

ItemPluggableFacade, ItemPluggableGate, ItemPluggableLens, ItemPluggablePulsar, ItemPluggableSimple

public interface IItemPluggable

Designates an item that can be placed onto a pipe as a PipePluggable.

Method Summary

Modifier and Type	Method and Description
PipePluggable	onPlace(net.minecraft.item.ItemStack stack, IPipeHolder holder, net.minecraft.util.EnumFacing side, net.minecraft.entity.player.EntityPlayer player, net.minecraft.util.EnumHand hand) Called when this item is placed onto a pipe holder.

Method Detail

onPlace

@Nullable
PipePluggable onPlace(@Nonnull
                                net.minecraft.item.ItemStack stack,
                                IPipeHolder holder,
                                net.minecraft.util.EnumFacing side,
                                net.minecraft.entity.player.EntityPlayer player,
                                net.minecraft.util.EnumHand hand)

Called when this item is placed onto a pipe holder. This can return null if this item does not make a valid pluggable. Note that if you return a non-null pluggable then it will *definitely* be added to the pipe, and you are responsible for making all the effects yourself (like the sound effect).

Parameters:

stack - The stack that holds this item

holder - The pipe holder

side - The side that the pluggable should be placed on

Returns:

A pluggable to place onto the pipe