Mod (core release API)

java.lang.Object

mindustry.mod.Mod

Direct Known Subclasses:: Plugin

public abstract class Mod extends Object

Constructor Summary

Constructors

Constructor

Description

Mod()
Method Summary

Modifier and Type

Method

Description

arc.files.Fi

getConfig()

arc.files.Fi

getConfigFolder()

void

init()

Called after all plugins have been created and commands have been registered.

void

loadContent()

Called on clientside mods.

void

registerClientCommands(arc.util.CommandHandler handler)

Register any commands to be used on the client side, e.g.

void

registerServerCommands(arc.util.CommandHandler handler)

Register any commands to be used on the server side, e.g.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- Mod
  
  public Mod()
Method Details
- getConfigFolder
  
  public arc.files.Fi getConfigFolder()
  
  Returns:
  
  the folder where configuration files for this mod should go.
- getConfig
  
  public arc.files.Fi getConfig()
  
  Returns:
  
  the config file for this plugin, as the file 'mods/[plugin-name]/config.json'.
- init
  
  public void init()
  
  Called after all plugins have been created and commands have been registered.
- loadContent
  
  public void loadContent()
  
  Called on clientside mods. Load content here.
- registerServerCommands
  
  public void registerServerCommands(arc.util.CommandHandler handler)
  
  Register any commands to be used on the server side, e.g. from the console.
- registerClientCommands
  
  public void registerClientCommands(arc.util.CommandHandler handler)
  
  Register any commands to be used on the client side, e.g. sent from an in-game player.