buildcraft.api.blueprints

Class SchematicBlock

java.lang.Object

buildcraft.api.blueprints.Schematic

buildcraft.api.blueprints.SchematicBlockBase

buildcraft.api.blueprints.SchematicBlock

Direct Known Subclasses:

SchematicAir, SchematicBed, SchematicBlockCreative, SchematicCactus, SchematicCustomStack, SchematicDirt, SchematicDoor, SchematicFarmland, SchematicFire, SchematicFluid, SchematicFree, SchematicGlassPane, SchematicGravel, SchematicIgnore, SchematicIgnoreMeta, SchematicPortal, SchematicPumpkin, SchematicRail, SchematicRedstoneDiode, SchematicRedstoneLamp, SchematicRedstoneWire, SchematicSeeds, SchematicStairs, SchematicStandalone, SchematicStone, SchematicTile, SchematicTripWireHook, SchematicWallSide

public class SchematicBlock
extends SchematicBlockBase

Nested Class Summary

Nested classes/interfaces inherited from class buildcraft.api.blueprints.Schematic

Schematic.BuildingStage

Field Summary

Fields

Modifier and Type	Field and Description
net.minecraft.block.Block	block
BuildingPermission	defaultPermission
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

Modifier and Type	Method and Description
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	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.
void	getRequirementsForPlacement(IBuilderContext context, java.util.LinkedList<net.minecraft.item.ItemStack> requirements) Returns the requirements needed to build this block.
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
protected void	readBlockFromNBT(net.minecraft.nbt.NBTTagCompound nbt, MappingRegistry registry)
protected void	readRequirementsFromNBT(net.minecraft.nbt.NBTTagCompound nbt, MappingRegistry registry)
void	readSchematicFromNBT(net.minecraft.nbt.NBTTagCompound nbt, MappingRegistry registry) Loads this schematic from the blueprint NBT.
protected void	setBlockInWorld(IBuilderContext context, int x, int y, int z)
void	storeRequirements(IBuilderContext context, int x, int y, int z) Write specific requirements coming from the world to the blueprint.
protected void	writeBlockToNBT(net.minecraft.nbt.NBTTagCompound nbt, MappingRegistry registry)
protected void	writeRequirementsToNBT(net.minecraft.nbt.NBTTagCompound nbt, MappingRegistry registry)
void	writeSchematicToNBT(net.minecraft.nbt.NBTTagCompound nbt, MappingRegistry registry) Saves this schematic to the blueprint NBT.

Methods inherited from class buildcraft.api.blueprints.Schematic

buildTime, doNotBuild, getEnergyRequirement, getStacksToDisplay, idsToBlueprint, idsToWorld, initializeFromObjectAt, postProcessing, rotateLeft, translateToBlueprint, translateToWorld, useItem

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

defaultPermission

public BuildingPermission defaultPermission

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

getRequirementsForPlacement

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

Description copied from class: Schematic

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.

Overrides:

getRequirementsForPlacement in class Schematic

isAlreadyBuilt

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

Description copied from class: Schematic

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.

Overrides:

isAlreadyBuilt in class Schematic

placeInWorld

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

Description copied from class: Schematic

Places the block in the world, at the location specified in the slot, using the stack in parameters

Overrides:

placeInWorld in class Schematic

storeRequirements

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

Description copied from class: Schematic

Write specific requirements coming from the world to the blueprint.

Overrides:

storeRequirements in class Schematic

writeSchematicToNBT

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

Description copied from class: Schematic

Saves this schematic to the blueprint NBT.

Overrides:

writeSchematicToNBT in class Schematic

readSchematicFromNBT

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

Description copied from class: Schematic

Loads this schematic from the blueprint NBT.

Overrides:

readSchematicFromNBT in class Schematic

canPlaceInWorld

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

Description copied from class: Schematic

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.

Overrides:

canPlaceInWorld in class Schematic

getBuildStage

public Schematic.BuildingStage getBuildStage()

Description copied from class: Schematic

Return the stage where this schematic has to be built.

Overrides:

getBuildStage in class Schematic

getBuildingPermission

public BuildingPermission getBuildingPermission()

Description copied from class: Schematic

Return the maximium building permission for blueprint containing this schematic.

Overrides:

getBuildingPermission in class Schematic

setBlockInWorld

protected void setBlockInWorld(IBuilderContext context,
                               int x,
                               int y,
                               int z)

doNotUse

public boolean doNotUse()

Description copied from class: Schematic

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.

Overrides:

doNotUse in class Schematic

readBlockFromNBT

protected void readBlockFromNBT(net.minecraft.nbt.NBTTagCompound nbt,
                                MappingRegistry registry)

readRequirementsFromNBT

protected void readRequirementsFromNBT(net.minecraft.nbt.NBTTagCompound nbt,
                                       MappingRegistry registry)

writeBlockToNBT

protected void writeBlockToNBT(net.minecraft.nbt.NBTTagCompound nbt,
                               MappingRegistry registry)

writeRequirementsToNBT

protected void writeRequirementsToNBT(net.minecraft.nbt.NBTTagCompound nbt,
                                      MappingRegistry registry)