IGameInstance (RockBottomAPI 0.0.25-179 API)

All Superinterfaces:

IMod
```
public interface IGameInstance
extends IMod
```
The current instance of the game
Use this to access important game functions and variables

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`exit()`
`IAssetManager`	`getAssetManager()`
`IChatLog`	`getChatLog()`
`java.net.URLClassLoader`	`getClassLoader()`
`IDataManager`	`getDataManager()`
`int`	`getFpsAverage()`
`IGuiManager`	`getGuiManager()`
`int`	`getGuiScale()`
`double`	`getHeightInGui()`
`double`	`getHeightInWorld()`
`org.newdawn.slick.Input`	`getInput()`
`IInteractionManager`	`getInteractionManager()`
`float`	`getMouseInGuiX()`
`float`	`getMouseInGuiY()`
`IParticleManager`	`getParticleManager()`
`AbstractEntityPlayer`	`getPlayer()`
`IPlayerDesign`	`getPlayerDesign()`
`Settings`	`getSettings()`
`IToaster`	`getToaster()`
`int`	`getTotalTicks()`
`int`	`getTpsAverage()`
`java.util.UUID`	`getUniqueId()`
`double`	`getWidthInGui()`
`double`	`getWidthInWorld()`
`IWorld`	`getWorld()`
`int`	`getWorldScale()`
`boolean`	`isBackgroundDebug()`
`boolean`	`isChunkBorderDebug()`
`boolean`	`isDebug()`
`boolean`	`isDedicatedServer()`
`boolean`	`isForegroundDebug()`
`boolean`	`isItemInfoDebug()`
`boolean`	`isLightDebug()`
`void`	`joinWorld(DataSet playerSet, WorldInfo info, DynamicRegistryInfo regInfo)` Joins a `IWorld` with a specified `DataSet` storing the player information, a `WorldInfo` and a specified `NameToIndexInfo` storing the mapping of tiles to their ids on disk.
`void`	`openIngameMenu()` Opens the ingame `Gui` Not supposed to be used by mods
`void`	`quitWorld()` Quits the current `IWorld` Not supposed to be used by mods
`void`	`scheduleAction(IAction action)` Schedules an `IAction` to be executed next tick Useful for use with `IPacket` as it prevents concurrent modification
`void`	`setFullscreen(boolean fullscreen)`
`void`	`setUniqueId(java.util.UUID id)`
`void`	`startWorld(java.io.File worldFile, WorldInfo info)` Starts up a `IWorld` from a specified `File` and `WorldInfo` and puts the player into it Not supposed to be used by mods

Methods inherited from interface de.ellpeck.rockbottom.api.mod.IMod
getDescription, getDisplayName, getId, getModGuiClass, getResourceLocation, getSortingPriority, getVersion, init, initAssets, isCompatibleWithModVersion, isDisableable, isRequiredOnClient, isRequiredOnServer, postInit, preInit

- Method Detail
  - startWorld
```
void startWorld(java.io.File worldFile,
                WorldInfo info)
```
    Starts up a IWorld from a specified File and WorldInfo and puts the player into it
    Not supposed to be used by mods
    
    Parameters:
    
    worldFile - The world's directory
    
    info - The world info
  - joinWorld
```
void joinWorld(DataSet playerSet,
               WorldInfo info,
               DynamicRegistryInfo regInfo)
```
    Joins a IWorld with a specified DataSet storing the player information, a WorldInfo and a specified NameToIndexInfo storing the mapping of tiles to their ids on disk.
    Not supposed to be used by mods
    
    Parameters:
    
    playerSet - The player data
    
    info - The world info
  - quitWorld
```
void quitWorld()
```
    Quits the current IWorld
    Not supposed to be used by mods
  - openIngameMenu
```
void openIngameMenu()
```
    Opens the ingame Gui
    Not supposed to be used by mods
  - scheduleAction
```
void scheduleAction(IAction action)
```
    Schedules an IAction to be executed next tick
    Useful for use with IPacket as it prevents concurrent modification
    
    Parameters:
    
    action - The action to be executed
  - getGuiScale
```
int getGuiScale()
```
  - getWorldScale
```
int getWorldScale()
```
  - getWidthInWorld
```
double getWidthInWorld()
```
    Returns:
    
    The width of the current visible screen area when applying getWorldScale()
  - getHeightInWorld
```
double getHeightInWorld()
```
    Returns:
    
    The height of the current visible screen area when applying getWorldScale()
  - getWidthInGui
```
double getWidthInGui()
```
    Returns:
    
    The width of the current visible screen area when applying getGuiScale()
  - getHeightInGui
```
double getHeightInGui()
```
    Returns:
    
    The height of the current visible screen area when applying getGuiScale()
  - getMouseInGuiX
```
float getMouseInGuiX()
```
    Returns:
    
    The x coordinate of the Mouse when applying getGuiScale()
  - getMouseInGuiY
```
float getMouseInGuiY()
```
    Returns:
    
    The y coordinate of the Mouse when applying getGuiScale()
  - getDataManager
```
IDataManager getDataManager()
```
    Returns:
    
    The IDataManager containing the game location and save locations
  - getSettings
```
Settings getSettings()
```
    Returns:
    
    The Settings of the game
  - getPlayer
```
AbstractEntityPlayer getPlayer()
```
    Returns:
    
    The current AbstractEntityPlayer of null if there is none
  - getGuiManager
```
IGuiManager getGuiManager()
```
    Returns:
    
    The IGuiManager of the game that can be used to open Gui
  - getInteractionManager
```
IInteractionManager getInteractionManager()
```
    Returns:
    
    The IInteractionManager of the game
  - getChatLog
```
IChatLog getChatLog()
```
    Returns:
    
    The IChatLog that can be used to send and query chat messages
  - getWorld
```
IWorld getWorld()
```
    Returns:
    
    The current IWorld of the game or null if there is none
  - getAssetManager
```
IAssetManager getAssetManager()
```
    Returns:
    
    The IAssetManager that can be used to get and modify game assets
  - getParticleManager
```
IParticleManager getParticleManager()
```
    Returns:
    
    The IParticleManager of the game
  - getUniqueId
```
java.util.UUID getUniqueId()
```
    Returns:
    
    The UUID of the game and its AbstractEntityPlayer
  - isDebug
```
boolean isDebug()
```
    Returns:
    
    If the game is in debug mode making the debug menu show (F1)
  - isLightDebug
```
boolean isLightDebug()
```
    Returns:
    
    If the game is in light debug mode making all lighting be equally bright (F2)
  - isForegroundDebug
```
boolean isForegroundDebug()
```
    Returns:
    
    If the game is in foreground debug making the foreground layer disappear (F3)
  - isBackgroundDebug
```
boolean isBackgroundDebug()
```
    Returns:
    
    If the game is in background debug making the background layer disappear (F4)
  - isItemInfoDebug
```
boolean isItemInfoDebug()
```
    Returns:
    
    If the game is in item info debug making the id and data of items show on the tooltip (F5)
  - isChunkBorderDebug
```
boolean isChunkBorderDebug()
```
  - getTpsAverage
```
int getTpsAverage()
```
    Returns:
    
    The average TPS (ticks per second) out of Constants.TARGET_TPS over the last second
  - getFpsAverage
```
int getFpsAverage()
```
    Returns:
    
    The average FPS (frames per second) out of Settings.targetFps over the last second
  - getClassLoader
```
java.net.URLClassLoader getClassLoader()
```
    Returns:
    
    The ClassLoader used to load vanilla game and IMod classes
  - setFullscreen
```
void setFullscreen(boolean fullscreen)
```
  - getTotalTicks
```
int getTotalTicks()
```
  - getPlayerDesign
```
IPlayerDesign getPlayerDesign()
```
  - isDedicatedServer
```
boolean isDedicatedServer()
```
  - setUniqueId
```
void setUniqueId(java.util.UUID id)
```
  - getInput
```
org.newdawn.slick.Input getInput()
```
  - exit
```
void exit()
```
  - getToaster
```
IToaster getToaster()
```

Interface IGameInstance

Method Summary

Methods inherited from interface de.ellpeck.rockbottom.api.mod.IMod

Method Detail

startWorld

joinWorld

quitWorld

openIngameMenu

scheduleAction

getGuiScale

getWorldScale

getWidthInWorld

getHeightInWorld

getWidthInGui

getHeightInGui

getMouseInGuiX

getMouseInGuiY

getDataManager

getSettings

getPlayer

getGuiManager

getInteractionManager

getChatLog

getWorld

getAssetManager

getParticleManager

getUniqueId

isDebug

isLightDebug

isForegroundDebug

isBackgroundDebug

isItemInfoDebug

isChunkBorderDebug

getTpsAverage

getFpsAverage

getClassLoader

setFullscreen

getTotalTicks

getPlayerDesign

isDedicatedServer

setUniqueId

getInput

exit

getToaster