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

A schematic is a piece of a blueprint. It allows to stock blocks or entities to blueprints, and can have a state that moves from a blueprint referential to a world referential. Although default schematic behavior will be OK for a lot of objects, specific blocks and entities may be associated with a dedicated schematic class, which will be instantiated automatically. Schematic perform "id translation" in case the block ids between a blueprint and the world installation are different. Mapping is done through the builder context. Detailed documentation on the schematic behavior can be found on http://www.mod-buildcraft.com/wiki/doku.php?id=builder_support Example of schematics for minecraft blocks are available in the package buildcraft.core.schematics.

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

Modifier and Type	Method and Description
int	buildTime() Returns the number of cycles to wait after building this schematic.
boolean	canPlaceInWorld(IBuilderContext context, int x, int y, int z) Can the block be placed in the world at these coordinates now? This function is only used to *delay* block placement until other prerequisites are met.
boolean	doNotBuild() Return true if the block should not be placed to the world.
boolean	doNotUse() Return true if the schematic should not be used at all.
BuildingPermission	getBuildingPermission() Return the maximium building permission for blueprint containing this schematic.
Schematic.BuildingStage	getBuildStage() Return the stage where this schematic has to be built.
int	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.
void	getRequirementsForPlacement(IBuilderContext context, java.util.LinkedList<net.minecraft.item.ItemStack> requirements) Returns the requirements needed to build this block.
java.util.LinkedList<net.minecraft.item.ItemStack>	getStacksToDisplay(java.util.LinkedList<net.minecraft.item.ItemStack> stackConsumed) Returns the flying stacks to display in the builder animation.
void	idsToBlueprint(MappingRegistry registry) Translates blocks and item ids to the blueprint referential
void	idsToWorld(MappingRegistry registry) Translates blocks and item ids to the world referential
void	initializeFromObjectAt(IBuilderContext context, int x, int y, int z) Initializes a schematic for blueprint according to an objet placed on {x, y, z} on 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	placeInWorld(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
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	readSchematicFromNBT(net.minecraft.nbt.NBTTagCompound nbt, MappingRegistry registry) Loads this schematic from the blueprint NBT.
void	rotateLeft(IBuilderContext context) Perform a 90 degree rotation to the slot.
void	storeRequirements(IBuilderContext context, int x, int y, int z) Write specific requirements coming from the world to the blueprint.
void	translateToBlueprint(Translation transform) Applies translations to all positions in the schematic to center in the blueprint referential
void	translateToWorld(Translation transform) Apply translations to all positions in the schematic to center in the builder referential
net.minecraft.item.ItemStack	useItem(IBuilderContext context, net.minecraft.item.ItemStack req, IInvSlot slot) This is called each time an item matches a requirement.
void	writeSchematicToNBT(net.minecraft.nbt.NBTTagCompound nbt, MappingRegistry registry) Saves this schematic to the blueprint NBT.

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

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 requirement. By default, it will increase damage of items that can be damaged by the amount of the requirement, and remove the intended amount of items that can't be damaged. Client may override this behavior. 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 slot (after usage). returns what was used (similar to req, but created from slot, 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.

translateToBlueprint

public void translateToBlueprint(Translation transform)

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

translateToWorld

public void translateToWorld(Translation transform)

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

idsToBlueprint

public void idsToBlueprint(MappingRegistry registry)

Translates blocks and item ids to the blueprint referential

idsToWorld

public void idsToWorld(MappingRegistry registry)

Translates blocks and item ids to the world referential

initializeFromObjectAt

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

Initializes a schematic for blueprint according to an objet placed on {x, y, z} on the world. For blocks, block and meta fields will be initialized automatically.

canPlaceInWorld

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

Can the block be placed in the world at these coordinates now? This function is only used to *delay* block placement until other prerequisites are met. This should probably be used sparingly, in cases where the BuildStage distinction is not enough.

placeInWorld

public void placeInWorld(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

storeRequirements

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

Write specific requirements coming from the world to the blueprint.

getRequirementsForPlacement

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

getEnergyRequirement

public int 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.

getStacksToDisplay

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

Returns the flying stacks to display in the builder animation.

getBuildStage

public Schematic.BuildingStage getBuildStage()

Return the stage where this schematic has to be built.

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

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 be called on these blocks.

doNotUse

public boolean doNotUse()

Return true if the schematic should not be used at all. This is computed straight after readFromNBT can be used to deactivate schematics in which an inconsistency is detected. It will be considered as a block of air instead. Post processing will *not* be called on these blocks.

getBuildingPermission

public BuildingPermission getBuildingPermission()

Return the maximium building permission for blueprint containing this schematic.

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.

writeSchematicToNBT

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

Saves this schematic to the blueprint NBT.

readSchematicFromNBT

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

Loads this schematic from the blueprint NBT.

buildTime

public int buildTime()

Returns the number of cycles to wait after building this schematic. Tiles and entities typically require more wait, around 5 cycles.