de.ellpeck.rockbottom.api

Interface IGameInstance

All Superinterfaces:

IMod

public interface IGameInstance
extends IMod

The game instance that can be used to interact with various game-related values and acces things like IGraphics and IAssetManager. Notice that this instance represents both the server and the client, however some methods that are not implemented on the dedicated server (like graphics and rendering methods) will throw an UnsupportedOperationException. To access any methods from this class, use RockBottomAPI.getGame().

Method Summary

Modifier and Type	Method and Description
void	exit()
IAssetManager	getAssetManager() Gets the IAssetManager of the current game instance.
IChatLog	getChatLog() Gets the IChatLog of the current game instance.
java.net.URLClassLoader	getClassLoader() Gets the URLClassLoader that the game is using to load its own classes and classes from jars out of the mods folder.
IDataManager	getDataManager() Gets the IDataManager of the current game instance.
default float	getDisplayRatio() Deprecated. Use IGraphics.getDisplayRatio()
int	getFpsAverage()
IGraphics	getGraphics() Gets the IGraphics context of the current game instance.
IGuiManager	getGuiManager() Gets the IGuiManager of the current game instance.
default float	getGuiScale() Deprecated. Use IGraphics.getGuiScale()
default float	getHeightInGui() Deprecated. Use IGraphics.getHeightInGui()
default float	getHeightInWorld() Deprecated. Use IGraphics.getHeightInWorld()
org.newdawn.slick.Input	getInput() Gets the Input of the current game instance.
IInteractionManager	getInteractionManager() Gets the IInteractionManager of the current game instance.
default float	getMouseInGuiX() Deprecated. Use IGraphics.getMouseInGuiX()
default float	getMouseInGuiY() Deprecated. Use IGraphics.getMouseInGuiY()
IParticleManager	getParticleManager() Gets the IParticleManager of the current game instance.
AbstractEntityPlayer	getPlayer() Gets the AbstractEntityPlayer of the current game instance.
IPlayerDesign	getPlayerDesign() Gets the IPlayerDesign that defines what the player looks like.
Settings	getSettings() Gets the Settings of the current game instance.
IToaster	getToaster() Gets the IToaster of the current game instance.
int	getTotalTicks() Gets the total amount of ticks the game has been running for.
int	getTpsAverage()
java.util.UUID	getUniqueId() Gets the UUID of the current game instance.
default float	getWidthInGui() Deprecated. Use IGraphics.getWidthInGui()
default float	getWidthInWorld() Deprecated. Use IGraphics.getWidthInWorld()
IWorld	getWorld() Gets the IWorld of the current game instance.
default float	getWorldScale() Deprecated. Use IGraphics.getWorldScale()
default boolean	isChunkBorderDebug() Deprecated. Use IGraphics.isChunkBorderDebug()
default boolean	isDebug() Deprecated. Use IGraphics.isDebug()
boolean	isDedicatedServer() Gets if the game is currently in dedicated server mode.
default boolean	isItemInfoDebug() Deprecated. Use IGraphics.isItemInfoDebug()
default boolean	isLightDebug() Deprecated. Use IGraphics.isLightDebug()
void	joinWorld(DataSet playerSet, WorldInfo info, DynamicRegistryInfo regInfo)
void	openIngameMenu()
void	quitWorld()
void	scheduleAction(java.util.function.Supplier<java.lang.Boolean> action) Schedules an action to be run next tick.
void	setFullscreen(boolean fullscreen)
void	setUniqueId(java.util.UUID id)
void	startWorld(java.io.File worldFile, WorldInfo info, boolean isNewlyCreated)

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

getDescription, getDisplayName, getId, getModGuiClass, getResourceLocation, getSortingPriority, getVersion, init, initAssets, isCompatibleWithModVersion, isDisableable, isRequiredOnClient, isRequiredOnServer, postInit, postPostInit, preInit, prePreInit

Method Detail

startWorld

@ApiInternal
void startWorld(java.io.File worldFile,
                             WorldInfo info,
                             boolean isNewlyCreated)

joinWorld

@ApiInternal
void joinWorld(DataSet playerSet,
                            WorldInfo info,
                            DynamicRegistryInfo regInfo)

quitWorld

@ApiInternal
void quitWorld()

openIngameMenu

@ApiInternal
void openIngameMenu()

scheduleAction

void scheduleAction(java.util.function.Supplier<java.lang.Boolean> action)

Schedules an action to be run next tick. This can be used for things like receiving of IPacket that run asynchronously to avoid a ConcurrentModificationException being thrown. The action's boolean value determines if the action should be rescheduled (run again the next tick). Note: This should NOT be used for actions that run each tick. For that, use WorldTickEvent.

Parameters:

action - The action to be run next tick

getDataManager

IDataManager getDataManager()

Gets the IDataManager of the current game instance. This can be used for accessing locations on disk like the save folder or the game folder itself. Additionally, it can save IPropSettings.

Returns:

The data manager

getSettings

Settings getSettings()

Gets the Settings of the current game instance. These store all of the values that can be edited in the settings gui.

Returns:

The settings

getPlayer

AbstractEntityPlayer getPlayer()

Gets the AbstractEntityPlayer of the current game instance. Note that this is not implemented on the dedicated server.

Returns:

The player

Throws:

java.lang.UnsupportedOperationException - on the dedicated server

getGuiManager

IGuiManager getGuiManager()

Gets the IGuiManager of the current game instance. This can be used to open Guis and fade the screen in and out. Note that this is not implemented on the dedicated server.

Returns:

The gui manager

Throws:

java.lang.UnsupportedOperationException - on the dedicated server

getInteractionManager

IInteractionManager getInteractionManager()

Gets the IInteractionManager of the current game instance. This can be used to access the positions in the world that the player is currently breaking. Note that this is not implemented on the dedicated server.

Returns:

The interaction manager

Throws:

java.lang.UnsupportedOperationException - on the dedicated server

getChatLog

IChatLog getChatLog()

Gets the IChatLog of the current game instance. This can be used to write messages and commands into the in-game chat.

Returns:

The chat log

getWorld

IWorld getWorld()

Gets the IWorld of the current game instance. In the title screen, this value is unassigned.

Returns:

The world

getAssetManager

IAssetManager getAssetManager()

Gets the IAssetManager of the current game instance. This can be used to get graphics, sounds and various other assets. Note that this is not implemented on the dedicated server.

Returns:

The asset manager

Throws:

java.lang.UnsupportedOperationException - on the dedicated server

getGraphics

IGraphics getGraphics()

Gets the IGraphics context of the current game instance. This can be used to draw various shapes and interact with the OpenGL context.

Returns:

The graphics context

getParticleManager

IParticleManager getParticleManager()

Gets the IParticleManager of the current game instance. This can be used to spawn and render particles. Note that this is not implemented on the dedicated server.

Returns:

The particle manager

Throws:

java.lang.UnsupportedOperationException - on the dedicated server

getUniqueId

java.util.UUID getUniqueId()

Gets the UUID of the current game instance. This will be applied to the player as soon as a world starts. Note that the dedicated server does not have a unique id.

Returns:

The game's unique id

Throws:

java.lang.UnsupportedOperationException - on the dedicated server

getTpsAverage

@ApiInternal
int getTpsAverage()

getFpsAverage

@ApiInternal
int getFpsAverage()

getClassLoader

java.net.URLClassLoader getClassLoader()

Gets the URLClassLoader that the game is using to load its own classes and classes from jars out of the mods folder.

Returns:

The class loader

setFullscreen

@ApiInternal
void setFullscreen(boolean fullscreen)

getTotalTicks

int getTotalTicks()

Gets the total amount of ticks the game has been running for. Note that, when closing down the game and opening it back up, this value will be reset.

Returns:

The total ticks

getPlayerDesign

IPlayerDesign getPlayerDesign()

Gets the IPlayerDesign that defines what the player looks like. Note that this is not implemented on the dedicated server.

Returns:

The player design

Throws:

java.lang.UnsupportedOperationException - on the dedicated server

isDedicatedServer

boolean isDedicatedServer()

Gets if the game is currently in dedicated server mode. This will be true when "--server" is appended to the launch arguments.

Returns:

If the instance is a dedicated server.

setUniqueId

@ApiInternal
void setUniqueId(java.util.UUID id)

getInput

org.newdawn.slick.Input getInput()

Gets the Input of the current game instance. This is a slick implemented class that allows for the polling of inputs. Note that, when using Keybind, Keybind.isDown() and Keybind.isPressed() should be used instead. Note that this is not implemented on the dedicated server.

Returns:

The input manager

Throws:

java.lang.UnsupportedOperationException - on the dedicated server

exit

@ApiInternal
void exit()

getToaster

IToaster getToaster()

Gets the IToaster of the current game instance. This is the system that displays Toast objects, which are the little pop-up messages in the top left. Note that this is not implemented on the dedicated server.

Returns:

The toaster

Throws:

java.lang.UnsupportedOperationException - on the dedicated server

getDisplayRatio

@Deprecated
default float getDisplayRatio()

Deprecated. Use IGraphics.getDisplayRatio()

getGuiScale

@Deprecated
default float getGuiScale()

Deprecated. Use IGraphics.getGuiScale()

getWorldScale

@Deprecated
default float getWorldScale()

Deprecated. Use IGraphics.getWorldScale()

getWidthInWorld

@Deprecated
default float getWidthInWorld()

Deprecated. Use IGraphics.getWidthInWorld()

getHeightInWorld

@Deprecated
default float getHeightInWorld()

Deprecated. Use IGraphics.getHeightInWorld()

getWidthInGui

@Deprecated
default float getWidthInGui()

Deprecated. Use IGraphics.getWidthInGui()

getHeightInGui

@Deprecated
default float getHeightInGui()

Deprecated. Use IGraphics.getHeightInGui()

getMouseInGuiX

@Deprecated
default float getMouseInGuiX()

Deprecated. Use IGraphics.getMouseInGuiX()

getMouseInGuiY

@Deprecated
default float getMouseInGuiY()

Deprecated. Use IGraphics.getMouseInGuiY()

isDebug

@Deprecated
default boolean isDebug()

Deprecated. Use IGraphics.isDebug()

isLightDebug

@Deprecated
default boolean isLightDebug()

Deprecated. Use IGraphics.isLightDebug()

isItemInfoDebug

@Deprecated
default boolean isItemInfoDebug()

Deprecated. Use IGraphics.isItemInfoDebug()

isChunkBorderDebug

@Deprecated
default boolean isChunkBorderDebug()

Deprecated. Use IGraphics.isChunkBorderDebug()