li.cil.oc.api.internal

Interface Wrench

public interface Wrench

Implemented on items that are wrench-like tools.

Method Summary

Modifier and Type	Method and Description
boolean	useWrenchOnBlock(net.minecraft.entity.player.EntityPlayer player, net.minecraft.world.World world, net.minecraft.util.BlockPos pos, boolean simulate) Called when the wrench is used.

Method Detail

useWrenchOnBlock

boolean useWrenchOnBlock(net.minecraft.entity.player.EntityPlayer player,
                         net.minecraft.world.World world,
                         net.minecraft.util.BlockPos pos,
                         boolean simulate)

Called when the wrench is used.

This is called in two scenarios, once when testing whether the wrench can be used on a certain block, in which case the simulate argument will be true, and once when actually used on a block, in which case the simulate argument will be false, allowing the tool to damage itself, for example.

This is usually called from blocks' activation logic.

Parameters:

player - the player using the tool

world - the world containing the block the wrench is used on.

pos - the position of the block.

simulate - whether to simulate the usage.

Returns:

whether the wrench can be used on the block.