buildcraft.api.blueprints

Class Schematic

java.lang.Object

buildcraft.api.blueprints.Schematic

Direct Known Subclasses:

SchematicBlockBase, SchematicEntity

public abstract class Schematic
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.schematics. The class SchematicUtils provide some additional utilities. Blueprints perform "id translation" in case the block ids between a blueprint and the world installation are different. Mapping is done through the builder context. 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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Schematic.BuildingStage Blocks are build in various stages, in order to make sure that a block can indeed be placed, and that it's unlikely to disturb other blocks.

Constructor Summary

Constructors

Constructor and Description
Schematic()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	doNotBuild() Return true if the block should not be placed to the world.
BuildingPermission	getBuildingPermission() Return the building permission for blueprint containing this schematic.
Schematic.BuildingStage	getBuildStage() Return the stage where this schematic has to be built.
double	getEnergyRequirement(java.util.LinkedList<net.minecraft.item.ItemStack> stacksUsed) Returns the amount of energy required to build this slot, depends on the stacks selected for the build.
java.util.LinkedList<net.minecraft.item.ItemStack>	getStacksToDisplay(java.util.LinkedList<net.minecraft.item.ItemStack> stackConsumed)
void	idsToSchematic(MappingRegistry registry)
void	idsToWorld(MappingRegistry registry)
void	inventorySlotsToSchematic(MappingRegistry registry, net.minecraft.nbt.NBTTagCompound nbt, java.lang.String nbtName)
void	inventorySlotsToWorld(MappingRegistry registry, net.minecraft.nbt.NBTTagCompound nbt, java.lang.String nbtName)
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	postProcessing(IBuilderContext context, int x, int y, int z) Called on a block when the blueprint has finished to place all the blocks.
void	readFromNBT(net.minecraft.nbt.NBTTagCompound nbt, MappingRegistry registry)
void	rotateLeft(IBuilderContext context) Perform a 90 degree rotation to the slot.
void	translateToSchematic(Translation transform) Applies translations to all positions in the schematic to center in the blueprint referencial
void	translateToWorld(Translation transform) Apply translations to all positions in the schematic to center in the builder referencial
net.minecraft.item.ItemStack	useItem(IBuilderContext context, net.minecraft.item.ItemStack req, IInvSlot slot) 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.
void	writeRequirementsToBuilder(IBuilderContext context, java.util.LinkedList<net.minecraft.item.ItemStack> requirements) Returns the requirements needed to build this block.
void	writeRequirementsToSchematic(IBuilderContext context, int x, int y, int z)
void	writeToNBT(net.minecraft.nbt.NBTTagCompound nbt, MappingRegistry registry)
void	writeToSchematic(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	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, using the stack in parameters

Methods inherited from class java.lang.Object

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

Constructor Detail

Schematic

public Schematic()

Method Detail

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.

doNotBuild

public boolean doNotBuild()

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. Post processing will still be called on these blocks though.

useItem

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

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)

rotateLeft

public void rotateLeft(IBuilderContext context)

Perform a 90 degree rotation to the slot.

translateToSchematic

public void translateToSchematic(Translation transform)

Applies translations to all positions in the schematic to center in the blueprint referencial

translateToWorld

public void translateToWorld(Translation transform)

Apply translations to all positions in the schematic to center in the builder referencial

idsToSchematic

public void idsToSchematic(MappingRegistry registry)

idsToWorld

public void idsToWorld(MappingRegistry registry)

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, using the stack in parameters

writeToSchematic

public void writeToSchematic(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.

postProcessing

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

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.

writeRequirementsToSchematic

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

writeRequirementsToBuilder

public void writeRequirementsToBuilder(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.

writeToNBT

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

readFromNBT

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

inventorySlotsToSchematic

public void inventorySlotsToSchematic(MappingRegistry registry,
                             net.minecraft.nbt.NBTTagCompound nbt,
                             java.lang.String nbtName)

inventorySlotsToWorld

public void inventorySlotsToWorld(MappingRegistry registry,
                         net.minecraft.nbt.NBTTagCompound nbt,
                         java.lang.String nbtName)

getStacksToDisplay

public java.util.LinkedList<net.minecraft.item.ItemStack> getStacksToDisplay(java.util.LinkedList<net.minecraft.item.ItemStack> stackConsumed)

getBuildStage

public Schematic.BuildingStage getBuildStage()

Return the stage where this schematic has to be built.

getBuildingPermission

public BuildingPermission getBuildingPermission()

Return the building permission for blueprint containing this schematic.

getEnergyRequirement

public double getEnergyRequirement(java.util.LinkedList<net.minecraft.item.ItemStack> stacksUsed)

Returns the amount of energy required to build this slot, depends on the stacks selected for the build.