buildcraft.api.blueprints

Class SchematicBlock

java.lang.Object

buildcraft.api.blueprints.Schematic

buildcraft.api.blueprints.SchematicBlockBase

buildcraft.api.blueprints.SchematicBlock

All Implemented Interfaces:

java.lang.Comparable<SchematicBlock>

Direct Known Subclasses:

SchematicBed, SchematicCustomStack, SchematicDirt, SchematicDoor, SchematicFarmland, SchematicFire, SchematicFluid, SchematicGravel, SchematicIgnore, SchematicIgnoreMeta, SchematicPortal, SchematicPumpkin, SchematicRail, SchematicRedstoneDiode, SchematicSeeds, SchematicStairs, SchematicStone, SchematicTile, SchematicWallSide

public class SchematicBlock
extends SchematicBlockBase
implements java.lang.Comparable<SchematicBlock>

Field Summary

Fields

Modifier and Type	Field and Description
net.minecraft.block.Block	block
int	meta
net.minecraft.item.ItemStack[]	storedRequirements This field contains requirements for a given block when stored in the blueprint.

Constructor Summary

Constructors

Constructor and Description
SchematicBlock()

Method Summary

Methods

Modifier and Type	Method and Description
void	addRequirements(IBuilderContext context, java.util.LinkedList<net.minecraft.item.ItemStack> requirements) Returns the requirements needed to build this block.
int	compareTo(SchematicBlock o)
boolean	ignoreBuilding() Return true if the block should not be placed to the world.
boolean	isAlreadyBuilt(IBuilderContext context, int x, int y, int z) Return true if the block on the world correspond to the block stored in the blueprint at the location given by the slot.
void	readFromNBT(net.minecraft.nbt.NBTTagCompound nbt, MappingRegistry registry)
void	readFromWorld(IBuilderContext context, int x, int y, int z) Initializes a slot from the blueprint according to an objet placed on {x, y, z} on the world.
void	rotateLeft(IBuilderContext context) Perform a 90 degree rotation to the slot.
net.minecraft.item.ItemStack	useItem(IBuilderContext context, net.minecraft.item.ItemStack req, net.minecraft.item.ItemStack stack) This is called each time an item matches a requirement, 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.
void	writeToNBT(net.minecraft.nbt.NBTTagCompound nbt, MappingRegistry registry)
void	writeToWorld(IBuilderContext context, int x, int y, int z, java.util.LinkedList<net.minecraft.item.ItemStack> stacks) Places the block in the world, at the location specified in the slot.

Methods inherited from class buildcraft.api.blueprints.SchematicBlockBase

writeCompleted

Methods inherited from class buildcraft.api.blueprints.Schematic

getRequirements, inventorySlotsToBlueprint, inventorySlotsToBlueprint, inventorySlotsToWorld, inventorySlotsToWorld, postProcessing, transformToBlueprint, transformToWorld

Methods inherited from class java.lang.Object

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

Field Detail

block

public net.minecraft.block.Block block

meta

public int meta

storedRequirements

public net.minecraft.item.ItemStack[] storedRequirements

This field contains requirements for a given block when stored in the blueprint. Modders can either rely on this list or compute their own int Schematic.

Constructor Detail

SchematicBlock

public SchematicBlock()

Method Detail

addRequirements

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

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.

Overrides:

addRequirements in class Schematic

useItem

public net.minecraft.item.ItemStack useItem(IBuilderContext context,
                                   net.minecraft.item.ItemStack req,
                                   net.minecraft.item.ItemStack stack)

This is called each time an item matches a requirement, 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 fulfilled, 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 (similar to req, but created from stack, so that any NBT based differences are drawn from the correct source)

Overrides:

useItem in class Schematic

isAlreadyBuilt

public boolean isAlreadyBuilt(IBuilderContext context,
                     int x,
                     int y,
                     int z)

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.

Overrides:

isAlreadyBuilt in class Schematic

rotateLeft

public void rotateLeft(IBuilderContext context)

Perform a 90 degree rotation to the slot.

Overrides:

rotateLeft in class Schematic

writeToWorld

public void writeToWorld(IBuilderContext context,
                int x,
                int y,
                int z,
                java.util.LinkedList<net.minecraft.item.ItemStack> stacks)

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

Overrides:

writeToWorld in class Schematic

ignoreBuilding

public boolean ignoreBuilding()

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.

Overrides:

ignoreBuilding in class SchematicBlockBase

readFromWorld

public void readFromWorld(IBuilderContext context,
                 int x,
                 int y,
                 int z)

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.

Overrides:

readFromWorld in class Schematic

writeToNBT

public void writeToNBT(net.minecraft.nbt.NBTTagCompound nbt,
              MappingRegistry registry)

Overrides:

writeToNBT in class Schematic

readFromNBT

public void readFromNBT(net.minecraft.nbt.NBTTagCompound nbt,
               MappingRegistry registry)

Overrides:

readFromNBT in class Schematic

compareTo

public int compareTo(SchematicBlock o)

Specified by:

compareTo in interface java.lang.Comparable<SchematicBlock>