li.cil.architect.api.detail

Interface ConverterAPI

All Known Implementing Classes:

ConverterAPIImpl

public interface ConverterAPI

Allows registering and looking up Converters.

When trying to serialize a block in the world, all registered converters will be queried, until one returns true from canSerialize(net.minecraft.world.World, net.minecraft.util.math.BlockPos).

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

Method Detail

addConverter

void addConverter(Converter converter)

Register the specified converter.

Parameters:

converter - the converter to register.

mapToBlock

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

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.

Parameters:

state - the block state to resolve the mapping for.

Returns:

the mapped representation of the block state.

mapToItem

@Nullable
net.minecraft.item.Item mapToItem(net.minecraft.block.Block block)

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

Parameters:

block - the block to get the item for.

Returns:

the item for that block.

getItemCosts

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.

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

Parameters:

data - the data to get the costs for.

Returns:

the list of materials required.

getFluidCosts

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.

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

Parameters:

data - the data to get the costs for.

Returns:

the list of materials required.

getSortIndex

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

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

Parameters:

data - the serialized representation of the block in question.

Returns:

the sort index of the specified data.

See Also:

SortIndex

canSerialize

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.

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

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

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.

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

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

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.

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

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.