de.ellpeck.rockbottom.api

Interface IApiHandler

public interface IApiHandler

The API handler can be used for executing code that is not part of the API through simple methods

Method Summary

Modifier and Type	Method and Description
void	describeItem(IGameInstance game, IAssetManager manager, org.newdawn.slick.Graphics g, ItemInstance instance) Describes an item using a hovering info (drawHoverInfo(IGameInstance, IAssetManager, Graphics, float, float, float, boolean, boolean, int, List))
void	doDefaultEntityUpdate(Entity entity) Updates an Entity's MovableWorldObject.x and MovableWorldObject.y values depending on its MovableWorldObject.motionX and MovableWorldObject.motionY, increases its Entity.ticksExisted value and updates its Entity.fallAmount Not supposed to be used by mods
boolean	doDefaultSlotMovement(IGameInstance game, int button, float x, float y, ComponentSlot slot) Does everything necessary for moving instances of ItemInstance around between slots of a ItemContainer using the ComponentSlot provided Not supposed to be used by mods
void	drawHoverInfo(IGameInstance game, IAssetManager manager, org.newdawn.slick.Graphics g, float x, float y, float scale, boolean firstLineOffset, boolean canLeaveScreen, int maxLength, java.util.List<java.lang.String> text) Draws a hovering info at the specified coordinates
void	drawHoverInfoAtMouse(IGameInstance game, IAssetManager manager, org.newdawn.slick.Graphics g, boolean firstLineOffset, int maxLength, java.util.List<java.lang.String> text) Draws a hovering info (drawHoverInfo(IGameInstance, IAssetManager, Graphics, float, float, float, boolean, boolean, int, List)) at the specified mouse coordinates
void	drawHoverInfoAtMouse(IGameInstance game, IAssetManager manager, org.newdawn.slick.Graphics g, boolean firstLineOffset, int maxLength, java.lang.String... text) Draws a hovering info (drawHoverInfo(IGameInstance, IAssetManager, Graphics, float, float, float, boolean, boolean, int, List)) at the specified mouse coordinates
org.newdawn.slick.Color	getColorByLight(int light, TileLayer layer)
int[]	interpolateLight(IWorld world, int x, int y)
org.newdawn.slick.Color[]	interpolateWorldColor(int[] interpolatedLight, TileLayer layer)
void	readDataSet(DataSet set, java.io.File file) Reads the specified DataSet from the specified File
DataPart	readPart(java.io.DataInput stream) Reads a DataPart from the specified DataInput and returns it
void	readSet(java.io.DataInput stream, DataSet set) Reads the specified DataSet from the specified DataInput
void	renderItemInGui(IGameInstance game, IAssetManager manager, org.newdawn.slick.Graphics g, ItemInstance slot, float x, float y, float scale, org.newdawn.slick.Color color) Renders an ItemInstance in a Gui at the specified x and y coordinates
void	renderSlotInGui(IGameInstance game, IAssetManager manager, org.newdawn.slick.Graphics g, ItemInstance slot, float x, float y, float scale) Renders a slot icon in a Gui at the specified x and y coordinates containg the specified ItemInstance
void	writeDataSet(DataSet set, java.io.File file) Writes the specified DataSet to the specified File
void	writePart(java.io.DataOutput stream, DataPart part) Writes the specified DataPart to the specified DataOutput
void	writeSet(java.io.DataOutput stream, DataSet set) Writes the specified DataSet to the specified DataOutput

Method Detail

writeDataSet

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

Writes the specified DataSet to the specified File

Parameters:

set - The set

file - The file

readDataSet

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

Reads the specified DataSet from the specified File

Parameters:

set - The set

file - The file

writeSet

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

Writes the specified DataSet to the specified DataOutput

Parameters:

stream - The output to write to

set - The set

Throws:

java.lang.Exception - If writing to the output fails in some way

readSet

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

Reads the specified DataSet from the specified DataInput

Parameters:

stream - The input to read from

set - The set

Throws:

java.lang.Exception - If reading from the input fails in some way

writePart

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

Writes the specified DataPart to the specified DataOutput

Parameters:

stream - The output to write to

part - The part

Throws:

java.lang.Exception - If writing to the output fails in some way

readPart

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

Reads a DataPart from the specified DataInput and returns it

Parameters:

stream - The input to read from

Returns:

The read DataPart

Throws:

java.lang.Exception - If reading from the input fails in some way

doDefaultEntityUpdate

void doDefaultEntityUpdate(Entity entity)

Updates an Entity's MovableWorldObject.x and MovableWorldObject.y values depending on its MovableWorldObject.motionX and MovableWorldObject.motionY, increases its Entity.ticksExisted value and updates its Entity.fallAmount
Not supposed to be used by mods

Parameters:

entity - The entity

doDefaultSlotMovement

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

Does everything necessary for moving instances of ItemInstance around between slots of a ItemContainer using the ComponentSlot provided
Not supposed to be used by mods

Parameters:

game - The current game instance

button - The button pressed

x - The x coordinate of the mouse

y - The y coordiante of the mouse

slot - The slot

Returns:

If the movement was successful

renderSlotInGui

void renderSlotInGui(IGameInstance game,
                     IAssetManager manager,
                     org.newdawn.slick.Graphics g,
                     ItemInstance slot,
                     float x,
                     float y,
                     float scale)

Renders a slot icon in a Gui at the specified x and y coordinates containg the specified ItemInstance

Parameters:

game - The current game instance

manager - The current instance of IAssetManager

g - The current graphics context

slot - The ItemInstance to be drawn inside of the slot

x - The x coordinate

y - The y coordinate

scale - The scale

renderItemInGui

void renderItemInGui(IGameInstance game,
                     IAssetManager manager,
                     org.newdawn.slick.Graphics g,
                     ItemInstance slot,
                     float x,
                     float y,
                     float scale,
                     org.newdawn.slick.Color color)

Renders an ItemInstance in a Gui at the specified x and y coordinates

Parameters:

game - The current game instance

manager - The current instance of IAssetManager

g - The current graphics context

slot - The ItemInstance to be drawn inside of the slot

x - The x coordinate

y - The y coordinate

scale - The scale

color - The filter to be applied to the Item renderer

describeItem

void describeItem(IGameInstance game,
                  IAssetManager manager,
                  org.newdawn.slick.Graphics g,
                  ItemInstance instance)

Describes an item using a hovering info (drawHoverInfo(IGameInstance, IAssetManager, Graphics, float, float, float, boolean, boolean, int, List))

Parameters:

game - The current game instance

manager - The current isntance of IAssetManager

g - The current graphics context

instance - The ItemInstance to be described

drawHoverInfoAtMouse

void drawHoverInfoAtMouse(IGameInstance game,
                          IAssetManager manager,
                          org.newdawn.slick.Graphics g,
                          boolean firstLineOffset,
                          int maxLength,
                          java.lang.String... text)

Draws a hovering info (drawHoverInfo(IGameInstance, IAssetManager, Graphics, float, float, float, boolean, boolean, int, List)) at the specified mouse coordinates

Parameters:

game - The current game instance

manager - The current isntance of IAssetManager

g - The current graphics context

firstLineOffset - The offset between the first line and the other lines

maxLength - The maximum length before the info wraps around

text - The text to be displayed

drawHoverInfoAtMouse

void drawHoverInfoAtMouse(IGameInstance game,
                          IAssetManager manager,
                          org.newdawn.slick.Graphics g,
                          boolean firstLineOffset,
                          int maxLength,
                          java.util.List<java.lang.String> text)

Draws a hovering info (drawHoverInfo(IGameInstance, IAssetManager, Graphics, float, float, float, boolean, boolean, int, List)) at the specified mouse coordinates

Parameters:

game - The current game instance

manager - The current isntance of IAssetManager

g - The current graphics context

firstLineOffset - The offset between the first line and the other lines

maxLength - The maximum length before the info wraps around

text - The text to be displayed

drawHoverInfo

void drawHoverInfo(IGameInstance game,
                   IAssetManager manager,
                   org.newdawn.slick.Graphics g,
                   float x,
                   float y,
                   float scale,
                   boolean firstLineOffset,
                   boolean canLeaveScreen,
                   int maxLength,
                   java.util.List<java.lang.String> text)

Draws a hovering info at the specified coordinates

Parameters:

game - The current game instance

manager - The current isntance of IAssetManager

g - The current graphics context

x - The x coordinate

y - The y coordinate

scale - The scale of the info

firstLineOffset - The offset between the first line and the other lines

canLeaveScreen - If the hover info can leave the screen

maxLength - The maximum length before the info wraps around

text - The text to be displayed

interpolateLight

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

interpolateWorldColor

org.newdawn.slick.Color[] interpolateWorldColor(int[] interpolatedLight,
                                                TileLayer layer)

getColorByLight

org.newdawn.slick.Color getColorByLight(int light,
                                        TileLayer layer)