li.cil.architect.api.prefab.converter

Class AbstractMultiBlockConverter

java.lang.Object

li.cil.architect.api.prefab.converter.AbstractConverter

li.cil.architect.api.prefab.converter.AbstractMultiBlockConverter

All Implemented Interfaces:

Converter

Direct Known Subclasses:

ConverterBed, ConverterDoor, ConverterDoublePlant

public abstract class AbstractMultiBlockConverter
extends AbstractConverter

Base class for converters of blocks spanning two block spaces, such as beds, doors and double plants.

These typically will only want to actually store one of the two positions (the "primary" on, bottom part of double plants e.g.), and also only require the block item as a material once for both parts.

Constructor Summary

Constructors

Constructor and Description
AbstractMultiBlockConverter(java.util.UUID uuid)

Method Summary

Modifier and Type	Method and Description
void	deserialize(net.minecraft.world.World world, net.minecraft.util.math.BlockPos pos, net.minecraft.util.Rotation rotation, net.minecraft.nbt.NBTBase data) Deserialize the specified serialized block data into the world at the specified world position.
java.lang.Iterable<net.minecraft.item.ItemStack>	getItemCosts(net.minecraft.nbt.NBTBase data) Get a list of materials required to deserialize the block described by the specified data.
protected abstract net.minecraft.util.math.BlockPos	getSecondaryPos(net.minecraft.util.math.BlockPos pos, net.minecraft.block.state.IBlockState state) Get the world position of the secondary part.
protected abstract net.minecraft.block.state.IBlockState	getSecondaryState(net.minecraft.block.state.IBlockState state) Get the block state representing the secondary part from the primary one.
protected abstract boolean	isSecondaryState(net.minecraft.block.state.IBlockState state) Check whether the specified block state is the secondary part.
protected void	postDeserialize(net.minecraft.world.World world, net.minecraft.util.math.BlockPos pos, net.minecraft.block.state.IBlockState state, net.minecraft.nbt.NBTTagCompound data) Allows hooking into the deserialization process, applying further changes to the deserialized block.
boolean	preDeserialize(MaterialSource materialSource, net.minecraft.world.World world, net.minecraft.util.math.BlockPos pos, net.minecraft.util.Rotation rotation, net.minecraft.nbt.NBTBase data) Called when a job for deserialization should be created.

Methods inherited from class li.cil.architect.api.prefab.converter.AbstractConverter

cancelDeserialization, canSerialize, canSerialize, getBlockState, getFluidCosts, getFluidStack, getItemStack, getItemStack, getSortIndex, getUUID, postSerialize, serialize

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractMultiBlockConverter

public AbstractMultiBlockConverter(java.util.UUID uuid)

Method Detail

isSecondaryState

protected abstract boolean isSecondaryState(net.minecraft.block.state.IBlockState state)

Check whether the specified block state is the secondary part.

Parameters:

state - the state to check.

Returns:

true if the state represents the secondary part; false otherwise.

getSecondaryState

protected abstract net.minecraft.block.state.IBlockState getSecondaryState(net.minecraft.block.state.IBlockState state)

Get the block state representing the secondary part from the primary one.

Parameters:

state - the primary block state.

Returns:

the secondary block state.

getSecondaryPos

protected abstract net.minecraft.util.math.BlockPos getSecondaryPos(net.minecraft.util.math.BlockPos pos,
                                                                    net.minecraft.block.state.IBlockState state)

Get the world position of the secondary part.

Parameters:

pos - the position of the primary part.

state - the state of the primary part.

Returns:

the position of the secondary part.

getItemCosts

public java.lang.Iterable<net.minecraft.item.ItemStack> getItemCosts(net.minecraft.nbt.NBTBase data)

Description copied from interface: Converter

Get a list of materials required to deserialize the block described by the specified data.

The data passed along is guaranteed to be a value that was previously produced by this converter's Converter.serialize(net.minecraft.world.World, net.minecraft.util.math.BlockPos) method.

This will typically return a singleton list or an empty list, but for more complex converters, e.g. ones handling multi-part blocks this returns an iterable.

This is not used for logic, purely for user feedback, e.g. in tooltips.

Specified by:

getItemCosts in interface Converter

Overrides:

getItemCosts in class AbstractConverter

Parameters:

data - the data to get the costs for.

Returns:

the list of materials required.

preDeserialize

public boolean preDeserialize(MaterialSource materialSource,
                              net.minecraft.world.World world,
                              net.minecraft.util.math.BlockPos pos,
                              net.minecraft.util.Rotation rotation,
                              net.minecraft.nbt.NBTBase data)

Description copied from interface: Converter

Called when a job for deserialization should be created.

The passed NBTBase passed along is guaranteed to be a value that was previously produced by this converter's Converter.serialize(net.minecraft.world.World, net.minecraft.util.math.BlockPos) method.

This serves as a filter for which blocks in a blueprint actually can be deserialized, in particular with respect to available materials which are consumed from the specified IItemHandler.

Specified by:

preDeserialize in interface Converter

Overrides:

preDeserialize in class AbstractConverter

Parameters:

materialSource - access to building materials available for deserialization.

world - the world into which to deserialize the block.

pos - the position at which to deserialize the block.

rotation - the rotation to deserialize with.

data - the serialized representation of the block to deserialize.

Returns:

true if the data can be deserialized; false otherwise.

deserialize

public void deserialize(net.minecraft.world.World world,
                        net.minecraft.util.math.BlockPos pos,
                        net.minecraft.util.Rotation rotation,
                        net.minecraft.nbt.NBTBase data)

Description copied from interface: Converter

Deserialize the specified serialized block data into the world at the specified world position.

The passed NBTBase passed along is guaranteed to be a value that was previously produced by this converter's Converter.serialize(net.minecraft.world.World, net.minecraft.util.math.BlockPos) method.

Specified by:

deserialize in interface Converter

Overrides:

deserialize in class AbstractConverter

Parameters:

world - the world to deserialize the block into.

pos - the position to deserialize the block at.

rotation - the rotation to deserialize with.

data - the serialized representation of the block to deserialize.

postDeserialize

protected void postDeserialize(net.minecraft.world.World world,
                               net.minecraft.util.math.BlockPos pos,
                               net.minecraft.block.state.IBlockState state,
                               net.minecraft.nbt.NBTTagCompound data)

Description copied from class: AbstractConverter

Allows hooking into the deserialization process, applying further changes to the deserialized block. This is called after the block has already been created in the world.

Overrides:

postDeserialize in class AbstractConverter

Parameters:

world - the world the block is being deserialized into.

pos - the position the block is being deserialized at.

state - the block state of the deserialized block.

data - the serialized representation of the block to