li.cil.architect.api

Class ConverterAPI

java.lang.Object

li.cil.architect.api.ConverterAPI

public final class ConverterAPI
extends java.lang.Object

API entry point for registering and looking up Converters.

When trying to serialize a block in the world, all registered converters will be queried, until one returns something not null from their Converter.serialize(World, BlockPos) method.

This is made available in the init phase, so you'll either have to (soft) depend on the mod, or you must not make calls to this before the init phase.

Method Summary

Modifier and Type	Method and Description
static void	addConverter(Converter converter) Register the specified converter.
static 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.
static 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.
static 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.
static 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.
static int	getSortIndex(net.minecraft.nbt.NBTTagCompound data) A sort index used to control in which order blocks are deserialized.
static net.minecraft.block.state.IBlockState	mapToBlock(net.minecraft.block.state.IBlockState state) Map a block to a potential replacement, based on current mapping configuration.
static net.minecraft.item.Item	mapToItem(net.minecraft.block.Block block) Get the item associated with the specified block.
static boolean	preDeserialize(MaterialSource itemSource, 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.
static 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

Method Detail

addConverter

public static void addConverter(Converter converter)

Register the specified converter.

Parameters:

converter - the converter to register.

mapToBlock

@Nullable
public static 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
public static 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

public static 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

public static 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

public static 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

public static 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
public static 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

public static boolean preDeserialize(MaterialSource itemSource,
                                     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 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.

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:

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