buildcraft.api.builder

Class BlockHandler

java.lang.Object

buildcraft.api.builder.BlockHandler

Direct Known Subclasses:

MaskHandler

public class BlockHandler
extends java.lang.Object

BlockHandlers are used to serialize blocks for saving/loading from Blueprints. To implement your own, you should extend this class and override the functions as needed.

Constructor Summary

Constructors

Constructor and Description
BlockHandler()
BlockHandler(int id)

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	areItemsEqual(net.minecraft.item.ItemStack stack1, net.minecraft.item.ItemStack stack2)
boolean	buildBlockFromSchematic(net.minecraft.world.World world, BlueprintBuilder.SchematicBuilder builder, IBlueprintBuilderAgent builderAgent) This function handles the placement of the block in the world.
boolean	canPlaceNow(net.minecraft.world.World world, int x, int y, int z, net.minecraftforge.common.util.ForgeDirection blueprintOrientation, net.minecraft.nbt.NBTTagCompound data) Can the block be placed currently or is it waiting on some other block to be placed first?
boolean	canSaveToSchematic(net.minecraft.item.ItemStack stack) By default we will ignore all blocks with Tile Entities.
boolean	canSaveToSchematic(net.minecraft.world.World world, int x, int y, int z) By default we will ignore all blocks with Tile Entities.
boolean	doesBlockMatchSchematic(net.minecraft.world.World world, int x, int y, int z, net.minecraftforge.common.util.ForgeDirection blueprintOrientation, net.minecraft.nbt.NBTTagCompound data) Checks if the block matches the schematic.
static BlockHandler	get(net.minecraft.block.Block block)
static BlockHandler	get(int id)
static BlockHandler	get(net.minecraft.item.Item item)
java.util.List<net.minecraft.item.ItemStack>	getCostForSchematic(net.minecraft.nbt.NBTTagCompound data) Provide a list of all the items that must be present to build this schematic.
boolean	isComplete(net.minecraft.world.World worldObj, BlueprintBuilder.SchematicBuilder schematicBuilder)
static void	registerHandler(net.minecraft.block.Block block, BlockHandler handler)
static void	registerHandler(int id, BlockHandler handler)
static void	registerHandler(net.minecraft.item.Item item, BlockHandler handler)
void	saveToSchematic(net.minecraft.item.ItemStack stack, net.minecraft.nbt.NBTTagCompound data) It is assumed that Blueprints always face North on save.
void	saveToSchematic(net.minecraft.world.World world, int x, int y, int z, net.minecraft.nbt.NBTTagCompound data) It is assumed that Blueprints always face North on save.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BlockHandler

public BlockHandler()

BlockHandler

public BlockHandler(int id)

Method Detail

get

public static BlockHandler get(net.minecraft.item.Item item)

get

public static BlockHandler get(net.minecraft.block.Block block)

get

public static BlockHandler get(int id)

registerHandler

public static void registerHandler(net.minecraft.block.Block block,
                   BlockHandler handler)

registerHandler

public static void registerHandler(net.minecraft.item.Item item,
                   BlockHandler handler)

registerHandler

public static void registerHandler(int id,
                   BlockHandler handler)

canSaveToSchematic

public boolean canSaveToSchematic(net.minecraft.world.World world,
                         int x,
                         int y,
                         int z)

By default we will ignore all blocks with Tile Entities. We will also skip any blocks that drop actual items like Ore blocks.

canSaveToSchematic

public boolean canSaveToSchematic(net.minecraft.item.ItemStack stack)

By default we will ignore all blocks with Tile Entities. We will also ignore anything that's not a ItemBlock. We will also skip any blocks that drop actual items like Ore blocks.

saveToSchematic

public void saveToSchematic(net.minecraft.world.World world,
                   int x,
                   int y,
                   int z,
                   net.minecraft.nbt.NBTTagCompound data)

It is assumed that Blueprints always face North on save. Store any info you need to reproduce the block in the data tag.

saveToSchematic

public void saveToSchematic(net.minecraft.item.ItemStack stack,
                   net.minecraft.nbt.NBTTagCompound data)

It is assumed that Blueprints always face North on save. Store any info you need to reproduce the block from this ItemStack in the data tag.

getCostForSchematic

public java.util.List<net.minecraft.item.ItemStack> getCostForSchematic(net.minecraft.nbt.NBTTagCompound data)

Provide a list of all the items that must be present to build this schematic. If you need axillary items like a painter or gate, list them as well. Items will be consumed in the readBlockFromSchematic() function below. This default implementation will only work for simple blocks without tile entities and will in fact break on Ore blocks as well. Which is why those blocks can't be saved by default.

areItemsEqual

protected final boolean areItemsEqual(net.minecraft.item.ItemStack stack1,
                    net.minecraft.item.ItemStack stack2)

canPlaceNow

public boolean canPlaceNow(net.minecraft.world.World world,
                  int x,
                  int y,
                  int z,
                  net.minecraftforge.common.util.ForgeDirection blueprintOrientation,
                  net.minecraft.nbt.NBTTagCompound data)

Can the block be placed currently or is it waiting on some other block to be placed first?

buildBlockFromSchematic

public boolean buildBlockFromSchematic(net.minecraft.world.World world,
                              BlueprintBuilder.SchematicBuilder builder,
                              IBlueprintBuilderAgent builderAgent)

This function handles the placement of the block in the world. The ForgeDirection parameter can be use to determine the orientation of the blueprint. Blueprints are always saved facing North. This function will have to rotate the block accordingly. The builder's inventory is passed in so you can consume the items you need. Use them as you see fit. If the function returns false, the block was not placed. You should not modify any ItemStack in the inventory until you have determined that everything you require is present.

doesBlockMatchSchematic

public boolean doesBlockMatchSchematic(net.minecraft.world.World world,
                              int x,
                              int y,
                              int z,
                              net.minecraftforge.common.util.ForgeDirection blueprintOrientation,
                              net.minecraft.nbt.NBTTagCompound data)

Checks if the block matches the schematic.

isComplete

public boolean isComplete(net.minecraft.world.World worldObj,
                 BlueprintBuilder.SchematicBuilder schematicBuilder)