de.ellpeck.rockbottom.api

Interface IApiHandler

public interface IApiHandler

The API handler is used mostly by the API to unexpose certain methods like the movements of entities that need to be called from the API, but are too complex to be inside of it. However, it also exposes a multitude of methods that can be useful to modders. To access the API handler, use RockBottomAPI.getApiHandler().

Method Summary

Modifier and Type	Method and Description
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.
void	doDefaultEntityUpdate(Entity entity)
void	doDefaultLiquidBehavior(IWorld world, int x, int y, TileLayer layer, TileLiquid tile)
boolean	doDefaultSlotMovement(IGameInstance game, int button, float x, float y, ComponentSlot slot)
void	doWorldObjectMovement(MovableWorldObject object)
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).
boolean	isToolEffective(AbstractEntityPlayer player, ItemInstance instance, Tile tile, TileLayer layer, int x, int y)
java.util.logging.Logger	logger()
INoiseGen	makeSimplexNoise(long seed) Returns a new INoiseGen of the Simplex Noise kind based on the specified seed.
boolean	placeTile(int x, int y, TileLayer layer, AbstractEntityPlayer player, ItemInstance selected, Tile tile, boolean removeItem, boolean simulate)
void	readDataSet(DataSet set, java.io.File file) Reads a DataSet from the location of the specified File.
DataPart	readPart(java.io.DataInput stream) Reads a DataPart from the specified DataInput and returns its instance.
void	readSet(java.io.DataInput stream, DataSet set) Reads a DataSet from the specified DataInput.
void	writeDataSet(DataSet set, java.io.File file) Writes a DataSet to the location of the specified File.
void	writePart(java.io.DataOutput stream, DataPart part) Writes a DataPart to the specified DataOutput.
void	writeSet(java.io.DataOutput stream, DataSet set) Writes a DataSet to the specified DataOutput.

Method Detail

writeDataSet

void writeDataSet(DataSet set,
                  java.io.File file)

Writes a DataSet to the location of the specified File.

Parameters:

set - The data set

file - The file

readDataSet

void readDataSet(DataSet set,
                 java.io.File file)

Reads a DataSet from the location of the specified File.

Parameters:

set - The data set

file - The file

writeSet

void writeSet(java.io.DataOutput stream,
              DataSet set)
       throws java.lang.Exception

Writes a DataSet to the specified DataOutput.

Parameters:

stream - The data output

set - The data set

Throws:

java.lang.Exception - when anything goes wrong during saving

readSet

void readSet(java.io.DataInput stream,
             DataSet set)
      throws java.lang.Exception

Reads a DataSet from the specified DataInput.

Parameters:

stream - The data input

set - The data set

Throws:

java.lang.Exception - when anything goes wrong during saving

writePart

void writePart(java.io.DataOutput stream,
               DataPart part)
        throws java.lang.Exception

Writes a DataPart to the specified DataOutput.

Parameters:

stream - The data output

part - The data part

Throws:

java.lang.Exception - when anything goes wrong during saving

readPart

DataPart readPart(java.io.DataInput stream)
           throws java.lang.Exception

Reads a DataPart from the specified DataInput and returns its instance.

Parameters:

stream - The data input

Returns:

The read data part

Throws:

java.lang.Exception - when anything goes wrong during loading

doDefaultEntityUpdate

@ApiInternal
void doDefaultEntityUpdate(Entity entity)

doWorldObjectMovement

@ApiInternal
void doWorldObjectMovement(MovableWorldObject object)

doDefaultSlotMovement

@ApiInternal
boolean doDefaultSlotMovement(IGameInstance game,
                                           int button,
                                           float x,
                                           float y,
                                           ComponentSlot slot)

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

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

isToolEffective

@ApiInternal
boolean isToolEffective(AbstractEntityPlayer player,
                                     ItemInstance instance,
                                     Tile tile,
                                     TileLayer layer,
                                     int x,
                                     int y)

placeTile

@ApiInternal
boolean placeTile(int x,
                               int y,
                               TileLayer layer,
                               AbstractEntityPlayer player,
                               ItemInstance selected,
                               Tile tile,
                               boolean removeItem,
                               boolean simulate)

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

logger

@ApiInternal
java.util.logging.Logger logger()

doDefaultLiquidBehavior

@ApiInternal
void doDefaultLiquidBehavior(IWorld world,
                                          int x,
                                          int y,
                                          TileLayer layer,
                                          TileLiquid tile)