buildcraft.api.blocks

Interface ICustomPaintHandler

All Known Implementing Classes:

BlockPipeHolder

public interface ICustomPaintHandler

Provides a way to paint blocks from any position. You can either implement this on a block, or register an instance for a block with CustomPaintHelper

Method Summary

Modifier and Type	Method and Description
net.minecraft.util.EnumActionResult	attemptPaint(net.minecraft.world.World world, net.minecraft.util.math.BlockPos pos, net.minecraft.block.state.IBlockState state, net.minecraft.util.math.Vec3d hitPos, net.minecraft.util.EnumFacing hitSide, net.minecraft.item.EnumDyeColor paintColour) Attempts to paint the given block.

Method Detail

attemptPaint

net.minecraft.util.EnumActionResult attemptPaint(net.minecraft.world.World world,
                                                 net.minecraft.util.math.BlockPos pos,
                                                 net.minecraft.block.state.IBlockState state,
                                                 net.minecraft.util.math.Vec3d hitPos,
                                                 @Nullable
                                                 net.minecraft.util.EnumFacing hitSide,
                                                 @Nullable
                                                 net.minecraft.item.EnumDyeColor paintColour)

Attempts to paint the given block. This can also only paint a specific part of the block (as the hit position is given).

Parameters:

world - The world that the block is contained within.

pos - The position of the block.

state - The current state of the block.

hitPos - The absolute hit position of the paintbrush, relative the world's origin.

hitSide - The side of the block that was hit.

paintColour - The paint colour to attempt to paint with, null if the paint should be cleared (so if this was a stained glass block, and null was passed, this would set it to a normal, clear, non-stained glass block.

Returns:

The result of attempting to paint. SUCCESS means that you changed the block from before to a new value, FAIL means you COULD have handled the block, but it was already painted to that colour, or PASS if you have no idea how to handle the block in question.