RockBottomAPI (RockBottomAPI 0.0.29-215 API)

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 NameRegistry<Biome>`	`BIOME_REGISTRY` The registry for `Biome` Use this to register custom biomes
`static IndexRegistry<java.lang.Class<? extends ChatComponent>>`	`CHAT_COMPONENT_REGISTRY` The registry for `ChatComponent` Use `IndexRegistry.getNextFreeId()` to register a custom component
`static java.util.List<CombinerRecipe>`	`COMBINER_RECIPES`
`static java.util.Map<java.lang.String,Command>`	`COMMAND_REGISTRY` The registry for `Command` Use this to register custom commands
`static java.util.List<BasicRecipe>`	`CONSTRUCTION_TABLE_RECIPES`
`static NameRegistry<java.lang.Class<? extends Entity>>`	`ENTITY_REGISTRY` The registry for `Entity` Use this to register custom entity types
`static java.util.Map<IUseInfo,java.lang.Integer>`	`FUEL_REGISTRY` The registry for `IUseInfo`s that can be used in machines as a fuel.
`static NameRegistry<Item>`	`ITEM_REGISTRY` The registry for `Item` Use `Item.register()` to register your items
`static NameRegistry<Keybind>`	`KEYBIND_REGISTRY` The registry for `Keybind` Use this to register custom keybinds
`static java.util.List<IMainMenuTheme>`	`MAIN_MENU_THEMES`
`static java.util.List<BasicRecipe>`	`MANUAL_CONSTRUCTION_RECIPES` The registry for `BasicRecipe` Use this to register construction recipes that can be used in the inventory `Gui`
`static IndexRegistry<java.lang.Class<? extends IPacket>>`	`PACKET_REGISTRY` The registry for `IPacket` Use `IndexRegistry.getNextFreeId()` to register a custom packet
`static IndexRegistry<java.lang.Class<? extends DataPart>>`	`PART_REGISTRY` The registry for `DataSet` parts DO NOT use `IndexRegistry.getNextFreeId()` to register a custom part and try not to register new `DataPart` types in general
`static java.util.List<SeparatorRecipe>`	`SEPARATOR_RECIPES` The registry for `SeparatorRecipe` Use this to register recipes for the separator
`static java.util.List<SmelterRecipe>`	`SMELTER_RECIPES` The registry for `SmelterRecipe` Use this to register recipes for the smelter
`static java.util.List<StamperRecipe>`	`STAMPER_RECIPES`
`static NameRegistry<Tile>`	`TILE_REGISTRY` The registry for `Tile` Use `Tile.register()` to register your tiles
`static NameRegistry<TileState>`	`TILE_STATE_REGISTRY` The registry for `TileState` DO NOT manually register states into this registry, it is populated automatically
`static java.lang.String`	`VERSION` The current API version
`static java.util.List<java.lang.Class<? extends IWorldGenerator>>`	`WORLD_GENERATORS` The registry for `IWorldGenerator` Use this to register custom world generators Every world generator class needs to have an empty constructor to be able to be initialized for the appropriate world

Constructor Summary

Constructors
Constructor and Description

RockBottomAPI()

Constructors
Constructor and Description
`RockBottomAPI()`

Method Summary

All Methods Static Methods Concrete Methods
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 CombinerRecipe`	`getCombinerRecipe(ItemInstance inputOne, ItemInstance inputTwo)`
`static IEventHandler`	`getEventHandler()` See `IEventHandler` for more information
`static int`	`getFuelValue(ItemInstance instance)`
`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 SeparatorRecipe`	`getSeparatorRecipe(ItemInstance input)`
`static SmelterRecipe`	`getSmelterRecipe(ItemInstance input)`
`static StamperRecipe`	`getStamperRecipe(ItemInstance input)`
`static boolean`	`isCombinerInput(ItemInstance instance, ItemInstance other)`
`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
  - 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 Tile.register() to register your tiles
  - ITEM_REGISTRY
```
public static final NameRegistry<Item> ITEM_REGISTRY
```
    The registry for Item
    Use Item.register() to register your 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
    DO NOT use IndexRegistry.getNextFreeId() to register a custom part and try not to register new DataPart types in general
  - PACKET_REGISTRY
```
public static final IndexRegistry<java.lang.Class<? extends IPacket>> PACKET_REGISTRY
```
    The registry for IPacket
    Use IndexRegistry.getNextFreeId() to 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
  - MANUAL_CONSTRUCTION_RECIPES
```
public static final java.util.List<BasicRecipe> MANUAL_CONSTRUCTION_RECIPES
```
    The registry for BasicRecipe
    Use this to register construction recipes that can be used in the inventory Gui
  - CONSTRUCTION_TABLE_RECIPES
```
public static final java.util.List<BasicRecipe> CONSTRUCTION_TABLE_RECIPES
```
  - STAMPER_RECIPES
```
public static final java.util.List<StamperRecipe> STAMPER_RECIPES
```
  - COMBINER_RECIPES
```
public static final java.util.List<CombinerRecipe> COMBINER_RECIPES
```
  - FUEL_REGISTRY
```
public static final java.util.Map<IUseInfo,java.lang.Integer> FUEL_REGISTRY
```
    The registry for IUseInfos that can be used in machines as a fuel. The Integer specified is the amount of time the fuel will burn for
    Use this to register custom fuels
  - SMELTER_RECIPES
```
public static final java.util.List<SmelterRecipe> SMELTER_RECIPES
```
    The registry for SmelterRecipe
    Use this to register recipes for the smelter
  - SEPARATOR_RECIPES
```
public static final java.util.List<SeparatorRecipe> SEPARATOR_RECIPES
```
    The registry for SeparatorRecipe
    Use this to register recipes for the separator
  - WORLD_GENERATORS
```
public static final java.util.List<java.lang.Class<? extends IWorldGenerator>> WORLD_GENERATORS
```
    The registry for IWorldGenerator
    Use this to register custom world generators
    Every world generator class needs to have an empty constructor to be able to be initialized for the appropriate world
  - BIOME_REGISTRY
```
public static final NameRegistry<Biome> BIOME_REGISTRY
```
    The registry for Biome
    Use this to register custom biomes
  - TILE_STATE_REGISTRY
```
public static final NameRegistry<TileState> TILE_STATE_REGISTRY
```
    The registry for TileState
    DO NOT manually register states into this registry, it is populated automatically
  - KEYBIND_REGISTRY
```
public static final NameRegistry<Keybind> KEYBIND_REGISTRY
```
    The registry for Keybind
    Use this to register custom keybinds
  - CHAT_COMPONENT_REGISTRY
```
public static final IndexRegistry<java.lang.Class<? extends ChatComponent>> CHAT_COMPONENT_REGISTRY
```
    The registry for ChatComponent
    Use IndexRegistry.getNextFreeId() to register a custom component
  - MAIN_MENU_THEMES
```
public static final java.util.List<IMainMenuTheme> MAIN_MENU_THEMES
```
- 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
  - getFuelValue
```
public static int getFuelValue(ItemInstance instance)
```
  - getSmelterRecipe
```
public static SmelterRecipe getSmelterRecipe(ItemInstance input)
```
  - getSeparatorRecipe
```
public static SeparatorRecipe getSeparatorRecipe(ItemInstance input)
```
  - getStamperRecipe
```
public static StamperRecipe getStamperRecipe(ItemInstance input)
```
  - getCombinerRecipe
```
public static CombinerRecipe getCombinerRecipe(ItemInstance inputOne,
                                               ItemInstance inputTwo)
```
  - isCombinerInput
```
public static boolean isCombinerInput(ItemInstance instance,
                                      ItemInstance other)
```

Class RockBottomAPI

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

VERSION

TILE_REGISTRY

ITEM_REGISTRY

ENTITY_REGISTRY

PART_REGISTRY

PACKET_REGISTRY

COMMAND_REGISTRY

MANUAL_CONSTRUCTION_RECIPES

CONSTRUCTION_TABLE_RECIPES

STAMPER_RECIPES

COMBINER_RECIPES

FUEL_REGISTRY

SMELTER_RECIPES

SEPARATOR_RECIPES

WORLD_GENERATORS

BIOME_REGISTRY

TILE_STATE_REGISTRY

KEYBIND_REGISTRY

CHAT_COMPONENT_REGISTRY

MAIN_MENU_THEMES

Constructor Detail

RockBottomAPI

Method Detail

getApiHandler

getNet

getEventHandler

getGame

getModLoader

createInternalRes

createRes

createRes

setApiHandler

setNetHandler

setEventHandler

setGameInstance

setModLoader

getFuelValue

getSmelterRecipe

getSeparatorRecipe

getStamperRecipe

getCombinerRecipe

isCombinerInput