li.cil.architect.api.prefab.converter

Class AbstractConverter

java.lang.Object

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

All Implemented Interfaces:

Converter

Direct Known Subclasses:

AbstractMultiBlockConverter, ConverterChiseledBlock, ConverterDoubleSlab, ConverterFallingBlock, ConverterFluidBlock, ConverterSimpleBlock, ConverterTileEntity

public abstract class AbstractConverter
extends java.lang.Object
implements Converter

Base implementation of a converter.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractConverter(java.util.UUID uuid)

Method Summary

Modifier and Type	Method and Description
void	cancelDeserialization(net.minecraft.world.World world, net.minecraft.util.math.BlockPos pos, net.minecraft.util.Rotation rotation, net.minecraft.nbt.NBTBase data) Cancel a pending deserialization that has already been prepared.
boolean	canSerialize(net.minecraft.world.World world, net.minecraft.util.math.BlockPos pos) Checks if this converter can be used to serialize the block at the specified world position.
protected abstract boolean	canSerialize(net.minecraft.world.World world, net.minecraft.util.math.BlockPos pos, net.minecraft.block.state.IBlockState state)
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.
protected net.minecraft.block.state.IBlockState	getBlockState(net.minecraft.nbt.NBTBase data) Get the block state serialized in the specified data.
java.lang.Iterable<net.minecraftforge.fluids.FluidStack>	getFluidCosts(net.minecraft.nbt.NBTBase data) Get a list of materials required to deserialize the block described by the specified data.
protected net.minecraftforge.fluids.FluidStack	getFluidStack(net.minecraft.nbt.NBTBase data) Get the fluid stack required as materials to deserialize the block stored in the specified data.
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 net.minecraft.item.ItemStack	getItemStack(net.minecraft.item.Item item, net.minecraft.block.state.IBlockState state, net.minecraft.nbt.NBTBase data) Resolve an item to an actual item stack.
protected net.minecraft.item.ItemStack	getItemStack(net.minecraft.nbt.NBTBase data) Get the item stack required as materials to deserialize the block stored in the specified data.
int	getSortIndex(net.minecraft.nbt.NBTBase data) A sort index used to control in which order blocks are deserialized.
java.util.UUID	getUUID() A constant UUID representing this converter.
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.
protected void	postSerialize(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 serialization process, adding additional NBT data to the tag compound returned from the basic serialization.
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.
net.minecraft.nbt.NBTBase	serialize(net.minecraft.world.World world, net.minecraft.util.math.BlockPos pos) Creates a serialized representation of the block at the specified world position.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractConverter

protected AbstractConverter(java.util.UUID uuid)

Method Detail

canSerialize

protected abstract boolean canSerialize(net.minecraft.world.World world,
                                        net.minecraft.util.math.BlockPos pos,
                                        net.minecraft.block.state.IBlockState state)

getUUID

public java.util.UUID getUUID()

Description copied from interface: Converter

A constant UUID representing this converter.

This is used to look up a converter for deserialization, so the returned value must be the same across any number of game starts.

Specified by:

getUUID in interface Converter

Returns:

the UUID of this converter.

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

Parameters:

data - the data to get the costs for.

Returns:

the list of materials required.

getFluidCosts

public java.lang.Iterable<net.minecraftforge.fluids.FluidStack> getFluidCosts(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:

getFluidCosts in interface Converter

Parameters:

data - the data to get the costs for.

Returns:

the list of materials required.

getSortIndex

public int getSortIndex(net.minecraft.nbt.NBTBase data)

Description copied from interface: Converter

A sort index used to control in which order blocks are deserialized.

Blocks being deserialized using converters that provide lower numbers here will be processed first.

This allows deserialization of solid blocks (e.g. cobble) before non- solid blocks (e.g. levers, water).

Specified by:

getSortIndex in interface Converter

Parameters:

data - the serialized representation of the block in question.

Returns:

the sort index of the specified data.

See Also:

SortIndex

canSerialize

public boolean canSerialize(net.minecraft.world.World world,
                            net.minecraft.util.math.BlockPos pos)

Description copied from interface: Converter

Checks if this converter can be used to serialize the block at the specified world position.

Specified by:

canSerialize in interface Converter

Parameters:

world - the world containing the block to serialize.

pos - the position of the block to serialize.

Returns:

true if the converter can serialize the block; false otherwise;

serialize

public net.minecraft.nbt.NBTBase serialize(net.minecraft.world.World world,
                                           net.minecraft.util.math.BlockPos pos)

Description copied from interface: Converter

Creates a serialized representation of the block at the specified world position.

This is guaranteed to only called if Converter.canSerialize(net.minecraft.world.World, net.minecraft.util.math.BlockPos) returned true for the passed parameters.

Specified by:

serialize in interface Converter

Parameters:

world - the world containing the block to serialize.

pos - the position of the block to serialize.

Returns:

a serialized representation of the block.

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

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

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.

cancelDeserialization

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

Cancel a pending deserialization that has already been prepared.

This is called if the location to deserialize into has become occupied after Converter.preDeserialize(li.cil.architect.api.converter.MaterialSource, net.minecraft.world.World, net.minecraft.util.math.BlockPos, net.minecraft.util.Rotation, net.minecraft.nbt.NBTBase) was called, but before Converter.deserialize(net.minecraft.world.World, net.minecraft.util.math.BlockPos, net.minecraft.util.Rotation, net.minecraft.nbt.NBTBase) could be called.

To avoid destruction of materials consumed in pre-deserialization, this method should spawn the consumed materials as EntityItems in the world, preferably at or around the location the deserialization would have taken place at.

Specified by:

cancelDeserialization in interface Converter

Parameters:

world - the world the deserialization would have occurred in.

pos - the position the deserialization would have occurred at.

rotation - the rotation the deserialization would have occurred with.

data - the serialized representation of the block that would have been deserialized.

postSerialize

protected void postSerialize(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 serialization process, adding additional NBT data to the tag compound returned from the basic serialization.

Note that the tags name and meta will already be set in the passed NBTTagCompound, and should usually not be overwritten.

Parameters:

world - the world the block to serialize lives in.

pos - the position of the block to serialize.

state - the block state of the block to serialize.

data - the tag generated from the serialization process so far.

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)

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.

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

getBlockState

@Nullable
protected net.minecraft.block.state.IBlockState getBlockState(net.minecraft.nbt.NBTBase data)

Get the block state serialized in the specified data.

Parameters:

data - the serialized representation of the block.

Returns:

the block state stored in the specified data.

getItemStack

@Nullable
protected net.minecraft.item.ItemStack getItemStack(net.minecraft.nbt.NBTBase data)

Get the item stack required as materials to deserialize the block stored in the specified data.

Parameters:

data - the serialized representation of the block.

Returns:

the material cost for the block.

getItemStack

protected net.minecraft.item.ItemStack getItemStack(net.minecraft.item.Item item,
                                                    net.minecraft.block.state.IBlockState state,
                                                    net.minecraft.nbt.NBTBase data)

Resolve an item to an actual item stack. Override this in case this is not correct in your converter (e.g. dropped item is NBT dependent).

Parameters:

item - the item to create an item stack for.

state - the block state based on which to create the item.

data - the serialized representation of the block.

Returns:

the item stack representing the costs of the block.

getFluidStack

@Nullable
protected net.minecraftforge.fluids.FluidStack getFluidStack(net.minecraft.nbt.NBTBase data)

Get the fluid stack required as materials to deserialize the block stored in the specified data.

Parameters:

data - the serialized representation of the block.

Returns:

the material cost for the block.