de.ellpeck.rockbottom.api

Class RockBottomAPI

java.lang.Object

de.ellpeck.rockbottom.api.RockBottomAPI

public final class RockBottomAPI
extends java.lang.Object

The main API class
Use this to access important game values

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.Map<java.lang.String,Command>	COMMAND_REGISTRY The registry for Command Use this to register custom commands
static NameRegistry<java.lang.Class<? extends Entity>>	ENTITY_REGISTRY The registry for Entity Use this to register custom entity types
static NameRegistry<Item>	ITEM_REGISTRY The registry for Item Use this to register custom items
static IndexRegistry<java.lang.Class<? extends IPacket>>	PACKET_REGISTRY The registry for IPacket Use IndexRegistry.getNextFreeId() too register a custom packet
static IndexRegistry<java.lang.Class<? extends DataPart>>	PART_REGISTRY The registry for DataSet parts Use IndexRegistry.getNextFreeId() to register a custom part
static java.util.Random	RANDOM An unseeded Random for general use
static NameRegistry<Tile>	TILE_REGISTRY The registry for Tile Use this to register custom tiles
static java.lang.String	VERSION The current API version

Constructor Summary

Constructors

Constructor and Description
RockBottomAPI()

Method Summary

Modifier and Type	Method and Description
static IResourceName	createInternalRes(java.lang.String resource) Creates an internal IResourceName to be used for vanilla game related resources
static IResourceName	createRes(IMod mod, java.lang.String resource) Creates an IResourceName to be used by the specified IMod
static IResourceName	createRes(java.lang.String combined) Creates an IResourceName out of a combined string of the mod id and the resource itself
static IApiHandler	getApiHandler() See IApiHandler for more information
static IEventHandler	getEventHandler() See IEventHandler for more information
static IGameInstance	getGame() See IGameInstance for more information
static IModLoader	getModLoader() See IModLoader for more information
static INetHandler	getNet() See INetHandler for more information
static void	setApiHandler(IApiHandler api) For game internal use only
static void	setEventHandler(IEventHandler event) For game internal use only
static void	setGameInstance(IGameInstance game) For game internal use only
static void	setModLoader(IModLoader mod) For game internal use only
static void	setNetHandler(INetHandler net) For game internal use only

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

RANDOM

public static final java.util.Random RANDOM

An unseeded Random for general use

VERSION

public static final java.lang.String VERSION

The current API version

See Also:

Constant Field Values

TILE_REGISTRY

public static final NameRegistry<Tile> TILE_REGISTRY

The registry for Tile
Use this to register custom tiles

ITEM_REGISTRY

public static final NameRegistry<Item> ITEM_REGISTRY

The registry for Item
Use this to register custom items

ENTITY_REGISTRY

public static final NameRegistry<java.lang.Class<? extends Entity>> ENTITY_REGISTRY

The registry for Entity
Use this to register custom entity types

PART_REGISTRY

public static final IndexRegistry<java.lang.Class<? extends DataPart>> PART_REGISTRY

The registry for DataSet parts
Use IndexRegistry.getNextFreeId() to register a custom part

PACKET_REGISTRY

public static final IndexRegistry<java.lang.Class<? extends IPacket>> PACKET_REGISTRY

The registry for IPacket
Use IndexRegistry.getNextFreeId() too register a custom packet

COMMAND_REGISTRY

public static final java.util.Map<java.lang.String,Command> COMMAND_REGISTRY

The registry for Command
Use this to register custom commands

Constructor Detail

RockBottomAPI

public RockBottomAPI()

Method Detail

getApiHandler

public static IApiHandler getApiHandler()

See IApiHandler for more information

Returns:

The IApiHandler

getNet

public static INetHandler getNet()

See INetHandler for more information

Returns:

The INetHandler

getEventHandler

public static IEventHandler getEventHandler()

See IEventHandler for more information

Returns:

The IEventHandler

getGame

public static IGameInstance getGame()

See IGameInstance for more information

Returns:

The IGameInstance

getModLoader

public static IModLoader getModLoader()

See IModLoader for more information

Returns:

The IModLoader

createInternalRes

public static IResourceName createInternalRes(java.lang.String resource)

Creates an internal IResourceName to be used for vanilla game related resources

Parameters:

resource - The name of the resource to create

Returns:

The IResourceName

createRes

public static IResourceName createRes(IMod mod,
                                      java.lang.String resource)

Creates an IResourceName to be used by the specified IMod

Parameters:

mod - The mod to use this resource name

resource - The name of the resource to create

Returns:

The IResourceName

createRes

public static IResourceName createRes(java.lang.String combined)

Creates an IResourceName out of a combined string of the mod id and the resource itself

Parameters:

combined - The combined name

Returns:

The parsed IResourceName

Throws:

java.lang.IllegalArgumentException - if the specified string cannot be parsed as an IResourceName

setApiHandler

public static void setApiHandler(IApiHandler api)

For game internal use only

setNetHandler

public static void setNetHandler(INetHandler net)

For game internal use only

setEventHandler

public static void setEventHandler(IEventHandler event)

For game internal use only

setGameInstance

public static void setGameInstance(IGameInstance game)

For game internal use only

setModLoader

public static void setModLoader(IModLoader mod)

For game internal use only