de.ellpeck.rockbottom.api.mod

Interface IMod

All Known Subinterfaces:

IGameInstance

public interface IMod

This is the class that describes a mod main class
To make a mod, make any non-final class with a default constructor extend it. The mod loader will then find it inside of the compiled mod jar and add it to the list of mods

Method Summary

Modifier and Type	Method and Description
default java.lang.String	getDescription()
java.lang.String	getDisplayName()
java.lang.String	getId()
default java.lang.Class<? extends Gui>	getModGuiClass() If desired, returns a class for a Gui that is opened from a button that is displayed in the mods menu on the title screen of the game automatically Gui class must have one-argument constructor taking a Gui parent
java.lang.String	getResourceLocation() Returns the location in the jar file that mod-related IAssets are stored (images, sounds, language files etc.) The location must contain a file named "assets.info" containg a mapping of all the asset names to their locations in the jar file For instance, RockBottom uses the resource location "/assets/rockbottom", meaning the "assets.info" file has to be at "/assets/rockbottom/assets.info".
default int	getSortingPriority() Returns the priority with which this mod will be sorted in the list of mods Higher values mean that it will be closer to the start of the list RockBottom has a priority of Integer.MAX_VALUE to always be loaded first
java.lang.String	getVersion()
default void	init(IGameInstance game, IAssetManager assetManager, IApiHandler apiHandler, IEventHandler eventHandler) Override this method to do any actions that should happen during the initialization of the base game
default boolean	isDisableable()
default void	postInit(IGameInstance game, IAssetManager assetManager, IApiHandler apiHandler, IEventHandler eventHandler) Override this method to do any actions that should happen after the initialization of the base game
default void	preInit(IGameInstance game, IApiHandler apiHandler, IEventHandler eventHandler) Override this method to do any actions that should happen before the initialization of the base game

Method Detail

getDisplayName

java.lang.String getDisplayName()

Returns:

The display name of the mod

getId

java.lang.String getId()

Returns:

The mod's unique string id. Needs to be all lowercase and cannot contain spaces

getVersion

java.lang.String getVersion()

Returns:

The current version of the mod

getResourceLocation

java.lang.String getResourceLocation()

Returns the location in the jar file that mod-related IAssets are stored (images, sounds, language files etc.)
The location must contain a file named "assets.info" containg a mapping of all the asset names to their locations in the jar file

For instance, RockBottom uses the resource location "/assets/rockbottom", meaning the "assets.info" file has to be at "/assets/rockbottom/assets.info". For the game to then load a png resource at "/assets/rockbottom/example/test.png" with the resource name "test", the assets.info file must contain the following line: "tex.text=/example/test.png"

Returns:

The location

getDescription

default java.lang.String getDescription()

Returns:

The mod's description to be displayed in the mod info Gui on the title screen

getSortingPriority

default int getSortingPriority()

Returns the priority with which this mod will be sorted in the list of mods
Higher values mean that it will be closer to the start of the list
RockBottom has a priority of Integer.MAX_VALUE to always be loaded first

Returns:

The priority

getModGuiClass

default java.lang.Class<? extends Gui> getModGuiClass()

If desired, returns a class for a Gui that is opened from a button that is displayed in the mods menu on the title screen of the game automatically
Gui class must have one-argument constructor taking a Gui parent

Returns:

The gui class

isDisableable

default boolean isDisableable()

Returns:

If this mod can be disabled from being loaded next time the game starts in the mods menu on the title screen

preInit

default void preInit(IGameInstance game,
                     IApiHandler apiHandler,
                     IEventHandler eventHandler)

Override this method to do any actions that should happen before the initialization of the base game

Parameters:

game - The current game instance

apiHandler - The API handler

eventHandler - The event handler

init

default void init(IGameInstance game,
                  IAssetManager assetManager,
                  IApiHandler apiHandler,
                  IEventHandler eventHandler)

Override this method to do any actions that should happen during the initialization of the base game

Parameters:

game - The current game instance

assetManager - The asset manager

apiHandler - The API handler

eventHandler - The event handler

postInit

default void postInit(IGameInstance game,
                      IAssetManager assetManager,
                      IApiHandler apiHandler,
                      IEventHandler eventHandler)

Override this method to do any actions that should happen after the initialization of the base game

Parameters:

game - The current game instance

assetManager - The asset manager

apiHandler - The API handler

eventHandler - The event handler