buildcraft.api.blueprints

Class BptBlock

java.lang.Object

buildcraft.api.blueprints.BptBlock

Direct Known Subclasses:

BptBlockAutoWorkbench, BptBlockBed, BptBlockCustomStack, BptBlockDelegate, BptBlockDirt, BptBlockDoor, BptBlockEngine, BptBlockFluid, BptBlockFrame, BptBlockIgnore, BptBlockIgnoreMeta, BptBlockInventory, BptBlockPipe, BptBlockPumpkin, BptBlockRedstoneRepeater, BptBlockRefinery, BptBlockRotateMeta, BptBlockSign, BptBlockStairs, BptBlockTank, BptBlockWallSide

Deprecated.

@Deprecated
public class BptBlock
extends java.lang.Object

This class allow to specify specific behavior for blocks stored in blueprints: - what items needs to be used to create that block - how the block has to be built on the world - how to rotate the block - what extra data to store / load in the blueprint Default implementations of this can be seen in the package buildcraft.api.bptblocks. The class BptBlockUtils provide some additional utilities. Blueprints perform "id translation" in case the block ids between a blueprint and the world installation are different. In order to translate block ids, blocks needs to be uniquely identified. By default, this identification is done by: - the block simple class name - the tile simple class name (if any) - the block name In certain circumstances, the above is not enough (e.g. if several blocks share the same class and the same name, with no tile). In this case, additional data may be provided by children of this class: - mod name - custom signature At blueprint load time, BuildCraft will check that each block id of the blueprint corresponds to the block id in the installation. If not, it will perform a search through the block list, and upon matching signature, it will translate all blocks ids of the blueprint to the installation ones. If no such block id is found, BuildCraft will assume that the block is not installed and will not load the blueprint.

Field Summary

Fields

Modifier and Type	Field and Description
int	blockId Deprecated.

Constructor Summary

Constructors

Constructor and Description
BptBlock(int blockId) Deprecated.

Method Summary

Methods

Modifier and Type	Method and Description
void	addRequirements(BptSlotInfo slot, IBptContext context, java.util.LinkedList<net.minecraft.item.ItemStack> requirements) Deprecated. Returns the requirements needed to build this block.
void	buildBlock(BptSlotInfo slot, IBptContext context) Deprecated. Places the block in the world, at the location specified in the slot.
BlockSignature	getSignature(net.minecraft.block.Block block) Deprecated. By default, block class name, block tile name and block name are used to define block signature.
boolean	ignoreBuilding(BptSlotInfo slot) Deprecated. Return true if the block should not be placed to the world.
void	initializeFromWorld(BptSlotInfo slot, IBptContext context, int x, int y, int z) Deprecated. Initializes a slot from the blueprint according to an objet placed on {x, y, z} on the world.
boolean	isValid(BptSlotInfo slot, IBptContext context) Deprecated. Return true if the block on the world correspond to the block stored in the blueprint at the location given by the slot.
boolean	match(net.minecraft.block.Block block, BlockSignature sig) Deprecated. By default, block name, block and tile classes, mod name and custom signature are matched to verify if a blueprint block corresponds to the installation block - except for the default blocks which don't check for classes.
void	postProcessing(BptSlotInfo slot, IBptContext context) Deprecated. Called on a block when the blueprint has finished to place all the blocks.
void	rotateLeft(BptSlotInfo slot, IBptContext context) Deprecated. Perform a 90 degree rotation to the slot.
net.minecraft.item.ItemStack	useItem(BptSlotInfo slot, IBptContext context, net.minecraft.item.ItemStack req, net.minecraft.item.ItemStack stack) Deprecated. This is called each time an item matches a reqquirement, that is: (req id == stack id) for damageable items (req id == stack id && req dmg == stack dmg) for other items by default, it will increase damage of damageable items by the amount of damage of the requirement, and remove the intended amount of non damageable item.

Methods inherited from class java.lang.Object

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

Field Detail

blockId

public final int blockId

Deprecated.

Constructor Detail

BptBlock

public BptBlock(int blockId)

Deprecated.

Method Detail

addRequirements

public void addRequirements(BptSlotInfo slot,
                   IBptContext context,
                   java.util.LinkedList<net.minecraft.item.ItemStack> requirements)

Deprecated.

Returns the requirements needed to build this block. When the requirements are met, they will be removed all at once from the builder, before calling buildBlock.

useItem

public net.minecraft.item.ItemStack useItem(BptSlotInfo slot,
                                   IBptContext context,
                                   net.minecraft.item.ItemStack req,
                                   net.minecraft.item.ItemStack stack)

Deprecated.

This is called each time an item matches a reqquirement, that is: (req id == stack id) for damageable items (req id == stack id && req dmg == stack dmg) for other items by default, it will increase damage of damageable items by the amount of damage of the requirement, and remove the intended amount of non damageable item. Client may override this behavior for default items. Note that this subprogram may be called twice with the same parameters, once with a copy of requirements and stack to check if the entire requirements can be fullfilled, and once with the real inventory. Implementer is responsible for updating req (with the remaining requirements if any) and stack (after usage) returns: what was used (similer to req, but created from stack, so that any NBT based differences are drawn from the correct source)

isValid

public boolean isValid(BptSlotInfo slot,
              IBptContext context)

Deprecated.

Return true if the block on the world correspond to the block stored in the blueprint at the location given by the slot. By default, this subprogram is permissive and doesn't take into account metadata. Added metadata sensitivity //Krapht

rotateLeft

public void rotateLeft(BptSlotInfo slot,
              IBptContext context)

Deprecated.

Perform a 90 degree rotation to the slot.

buildBlock

public void buildBlock(BptSlotInfo slot,
              IBptContext context)

Deprecated.

Places the block in the world, at the location specified in the slot.

ignoreBuilding

public boolean ignoreBuilding(BptSlotInfo slot)

Deprecated.

Return true if the block should not be placed to the world. Requirements will not be asked on such a block, and building will not be called.

initializeFromWorld

public void initializeFromWorld(BptSlotInfo slot,
                       IBptContext context,
                       int x,
                       int y,
                       int z)

Deprecated.

Initializes a slot from the blueprint according to an objet placed on {x, y, z} on the world. This typically means adding entries in slot.cpt. Note that "id" and "meta" will be set automatically, corresponding to the block id and meta. By default, if the block is a BlockContainer, tile information will be to save / load the block.

postProcessing

public void postProcessing(BptSlotInfo slot,
                  IBptContext context)

Deprecated.

Called on a block when the blueprint has finished to place all the blocks. This may be useful to adjust variable depending on surrounding blocks that may not be there already at initial building.

getSignature

public BlockSignature getSignature(net.minecraft.block.Block block)

Deprecated.

By default, block class name, block tile name and block name are used to define block signature. Overriding this subprogram may allow to replace some of these with stars, specify the mod that this block kind is coming from or add custom data to the signature.

match

public boolean match(net.minecraft.block.Block block,
            BlockSignature sig)

Deprecated.

By default, block name, block and tile classes, mod name and custom signature are matched to verify if a blueprint block corresponds to the installation block - except for the default blocks which don't check for classes. For any value, * means match with anything. For compatibilty and evolution reasons, mods may want to write a different policy, allowing to migrate one format to the other.