li.cil.architect.common.api

Class ConverterAPIImpl

java.lang.Object

li.cil.architect.common.api.ConverterAPIImpl

All Implemented Interfaces:

ConverterAPI

public final class ConverterAPIImpl
extends java.lang.Object
implements ConverterAPI

Constructor Summary

Constructors

Constructor and Description
ConverterAPIImpl()

Method Summary

Modifier and Type	Method and Description
void	addConverter(Converter converter) Register the specified converter.
boolean	canSerialize(net.minecraft.world.World world, net.minecraft.util.math.BlockPos pos) Checks if the block at the specified world position can be serialized.
void	deserialize(net.minecraft.world.World world, net.minecraft.util.math.BlockPos pos, net.minecraft.util.Rotation rotation, net.minecraft.nbt.NBTTagCompound data) Deserialize the specified serialized block data into the world at the specified world position.
java.lang.Iterable<net.minecraftforge.fluids.FluidStack>	getFluidCosts(net.minecraft.nbt.NBTTagCompound data) Get a list of materials required to deserialize the block described by the specified data.
java.lang.Iterable<net.minecraft.item.ItemStack>	getItemCosts(net.minecraft.nbt.NBTTagCompound data) Get a list of materials required to deserialize the block described by the specified data.
int	getSortIndex(net.minecraft.nbt.NBTTagCompound data) A sort index used to control in which order blocks are deserialized.
static boolean	isValidPosition(net.minecraft.world.World world, net.minecraft.util.math.BlockPos pos)
net.minecraft.block.state.IBlockState	mapToBlock(net.minecraft.block.state.IBlockState state) Map a block to a potential replacement, based on current mapping configuration.
net.minecraft.item.Item	mapToItem(net.minecraft.block.Block block) Get the item associated with the specified block.
boolean	preDeserialize(MaterialSource materialSource, net.minecraft.world.World world, net.minecraft.util.math.BlockPos pos, net.minecraft.util.Rotation rotation, net.minecraft.nbt.NBTTagCompound data) Called when a job for deserialization should be created.
net.minecraft.nbt.NBTTagCompound	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

ConverterAPIImpl

public ConverterAPIImpl()

Method Detail

addConverter

public void addConverter(Converter converter)

Description copied from interface: ConverterAPI

Register the specified converter.

Specified by:

addConverter in interface ConverterAPI

Parameters:

converter - the converter to register.

mapToBlock

public net.minecraft.block.state.IBlockState mapToBlock(net.minecraft.block.state.IBlockState state)

Description copied from interface: ConverterAPI

Map a block to a potential replacement, based on current mapping configuration. Generally used to replace state-dependent representations with their default one, e.g. lit_furnace to furnace.

Specified by:

mapToBlock in interface ConverterAPI

Parameters:

state - the block state to resolve the mapping for.

Returns:

the mapped representation of the block state.

mapToItem

public net.minecraft.item.Item mapToItem(net.minecraft.block.Block block)

Description copied from interface: ConverterAPI

Get the item associated with the specified block. Takes into account custom registered mappings, falls back to built-in item from block lookup via the Item.getItemFromBlock(Block).

Specified by:

mapToItem in interface ConverterAPI

Parameters:

block - the block to get the item for.

Returns:

the item for that block.

getItemCosts

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

Description copied from interface: ConverterAPI

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 ConverterAPI.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 ConverterAPI

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.NBTTagCompound data)

Description copied from interface: ConverterAPI

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 ConverterAPI.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 ConverterAPI

Parameters:

data - the data to get the costs for.

Returns:

the list of materials required.

getSortIndex

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

Description copied from interface: ConverterAPI

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 ConverterAPI

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: ConverterAPI

Checks if the block at the specified world position can be serialized.

Specified by:

canSerialize in interface ConverterAPI

Parameters:

world - the world containing the block to serialize.

pos - the position of the block to serialize.

Returns:

true if the block can be serialized; false otherwise.

serialize

@Nullable
public net.minecraft.nbt.NBTTagCompound serialize(net.minecraft.world.World world,
                                                            net.minecraft.util.math.BlockPos pos)

Description copied from interface: ConverterAPI

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

Specified by:

serialize in interface ConverterAPI

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.NBTTagCompound data)

Description copied from interface: ConverterAPI

Called when a job for deserialization should be created.

The data passed along is guaranteed to be a value that was previously produced by this converter's ConverterAPI.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 ConverterAPI

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.NBTTagCompound data)

Description copied from interface: ConverterAPI

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 ConverterAPI.serialize(net.minecraft.world.World, net.minecraft.util.math.BlockPos) method.

Specified by:

deserialize in interface ConverterAPI

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.

isValidPosition

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