Package de.ellpeck.rockbottom.api

Interface IApiHandler

public interface IApiHandler

This class exposes a multitude of utility methods that are too big to be inside the API's code and are, as such, inside of the game. To access the API handler, use RockBottomAPI.getApiHandler().

Method Summary

Modifier and Type	Method	Description
java.util.List<ItemInstance>	construct(AbstractEntityPlayer player, Inventory inputInventory, Inventory outputInventory, IRecipe recipe, int amount, java.util.List<IUseInfo> inputs, java.util.function.Function<java.util.List<ItemInstance>,java.util.List<ItemInstance>> outputGetter, float skillReward)	This is a utility method that you can call for custom construction of items via the compendium, if you, for example, create a custom, more complex, IRecipe class, or if you create a machine that should automatically construct something.
java.util.logging.Logger	createLogger(java.lang.String name)	Creates a Logger with the specified name that will output to the main logger and also written to the log file.
int	getColorByLight(int light, TileLayer layer)	Gets a color in the world based on a light value between 0 and Constants.MAX_LIGHT.
int[]	interpolateLight(IWorld world, int x, int y)	Interpolates the light at a position in the world.
int[]	interpolateWorldColor(int[] interpolatedLight, TileLayer layer)	Interpolates the four colors of the corners of a position in the world based on the TileLayer and the interpolated light from interpolateLight(IWorld, int, int).
INoiseGen	makeSimplexNoise(long seed)	Returns a new INoiseGen of the Simplex Noise kind based on the specified seed.
DataPart	readDataPart(com.google.gson.JsonElement element)
void	readDataSet(com.google.gson.JsonObject main, AbstractDataSet set)	Reads a data set directly from a json object head, throwing an exception if something fails.
void	readDataSet(AbstractDataSet set, java.io.File file, boolean asJson)	Reads a data set from the given file either as binary or as a json and stores the data in the set.
void	readDataSet(java.io.DataInput stream, AbstractDataSet set)	Reads a data set directly from a data input of any kind, throwing an exception if something fails.
void	writeDataSet(com.google.gson.JsonObject main, AbstractDataSet set)	Writes a data set directly to a json object head, throwing an exception if something fails.
void	writeDataSet(AbstractDataSet set, java.io.File file, boolean asJson)	Writes a data set to the given file either as binary or as a json
void	writeDataSet(java.io.DataOutput stream, AbstractDataSet set)	Writes a data set directly to a data output of any kind, throwing an exception if something fails.

Method Detail

writeDataSet

void writeDataSet(AbstractDataSet set,
                  java.io.File file,
                  boolean asJson)

Writes a data set to the given file either as binary or as a json

Parameters:

set - The data set to write to file

file - The file to write to

asJson - Wether it should be stored as json

readDataSet

void readDataSet(AbstractDataSet set,
                 java.io.File file,
                 boolean asJson)

Reads a data set from the given file either as binary or as a json and stores the data in the set.

Parameters:

set - The set to store the data in

file - The file to read from

asJson - Wether or not it should be stored as json

writeDataSet

void writeDataSet(java.io.DataOutput stream,
                  AbstractDataSet set)
           throws java.lang.Exception

Writes a data set directly to a data output of any kind, throwing an exception if something fails.

Parameters:

stream - The output to write to

set - The set to write to the output

Throws:

java.lang.Exception - if writing fails for some reason

readDataSet

void readDataSet(java.io.DataInput stream,
                 AbstractDataSet set)
          throws java.lang.Exception

Reads a data set directly from a data input of any kind, throwing an exception if something fails.

Parameters:

stream - The input to read from

set - The set to save the input in

Throws:

java.lang.Exception - if reading fails for some reason

writeDataSet

void writeDataSet(com.google.gson.JsonObject main,
                  AbstractDataSet set)
           throws java.lang.Exception

Writes a data set directly to a json object head, throwing an exception if something fails.

Parameters:

main - The json object to write to

set - The set to write

Throws:

java.lang.Exception - if writing fails for some reason

readDataSet

void readDataSet(com.google.gson.JsonObject main,
                 AbstractDataSet set)
          throws java.lang.Exception

Reads a data set directly from a json object head, throwing an exception if something fails.

Parameters:

main - The json object to read from

set - The set to save the input in

Throws:

java.lang.Exception - if reading fails for some reason

readDataPart

DataPart readDataPart(com.google.gson.JsonElement element)
               throws java.lang.Exception

Throws:

java.lang.Exception

interpolateLight

int[] interpolateLight(IWorld world,
                       int x,
                       int y)

Interpolates the light at a position in the world. The four integers in the returned array specify the light at each four corners of the tile at the position.

Parameters:

world - The world

x - The x coordinate

y - The y coordinate

Returns:

The interpolated light

interpolateWorldColor

int[] interpolateWorldColor(int[] interpolatedLight,
                            TileLayer layer)

Interpolates the four colors of the corners of a position in the world based on the TileLayer and the interpolated light from interpolateLight(IWorld, int, int).

Parameters:

interpolatedLight - The interpolated light

layer - The layer

Returns:

The four colors

construct

java.util.List<ItemInstance> construct(AbstractEntityPlayer player,
                                       Inventory inputInventory,
                                       Inventory outputInventory,
                                       IRecipe recipe,
                                       int amount,
                                       java.util.List<IUseInfo> inputs,
                                       java.util.function.Function<java.util.List<ItemInstance>,java.util.List<ItemInstance>> outputGetter,
                                       float skillReward)

This is a utility method that you can call for custom construction of items via the compendium, if you, for example, create a custom, more complex, IRecipe class, or if you create a machine that should automatically construct something.

Parameters:

player - The player doing this construction. Can be null if the construction is automated. Note that the skill reward is not used then.

inputInventory - The inventory that the construction takes items from

outputInventory - The inventory that the output items go into

recipe - The recipe to be constructed

amount - The amount of times this recipe should be constructed

inputs - The items that are input into the recipe

outputGetter - A function that is called to get the outputs of the recipe based on the inputs that were actually taken from the inventory

skillReward - The amount of skill points you get for constructing this recipe

Returns:

A list of items that couldn't fit into the output inventory specified

getColorByLight

int getColorByLight(int light,
                    TileLayer layer)

Gets a color in the world based on a light value between 0 and Constants.MAX_LIGHT.

Parameters:

light - The light

layer - The layer

Returns:

The color

makeSimplexNoise

INoiseGen makeSimplexNoise(long seed)

Returns a new INoiseGen of the Simplex Noise kind based on the specified seed.

Parameters:

seed - The seed

Returns:

The noise generator

createLogger

java.util.logging.Logger createLogger(java.lang.String name)

Creates a Logger with the specified name that will output to the main logger and also written to the log file.

Parameters:

name - The name

Returns:

The new logger