net.acomputerdog.BlazeLoader.mod
Interface BLMod

All Superinterfaces:
com.mumfrey.liteloader.modconfig.Exposable, com.mumfrey.liteloader.api.Listener, com.mumfrey.liteloader.LiteMod
All Known Subinterfaces:
BlockEventHandler, ClientEventHandler, GenericEventHandler, InventoryEventHandler, NetworkEventHandler, OverrideEventHandler, PlayerEventHandler, ProfilerEventHandler, TickEventHandler, WorldEventHandler

public interface BLMod
extends com.mumfrey.liteloader.LiteMod

Base class of mods. Mods should extend this class. Methods have default implementations, but can be overridden. event... methods can be overridden to respond to game events. Event methods that reference Minecraft classes have "No-args" versions that can be used for mods that wish to avoid being specific to particular Minecraft versions. If a normal event method is overridden, it's no-args version will NOT be triggered.


Method Summary
 java.lang.String getModDescription()
          Gets a user-friendly description of the mod.
 java.lang.String getModId()
          Returns ID used to identify this mod internally, even among different versions of the same mod.
 java.lang.String getName()
           
 BLMod getNewerVersion(BLMod otherMod)
          Compares two mods of the same type to determine which is newer.
 java.lang.String getVersion()
           
 boolean isCompatibleWithEnvironment()
          Returns true if this mod is compatible with the installed version of BlazeLoader.
 
Methods inherited from interface com.mumfrey.liteloader.LiteMod
init, upgradeSettings
 

Method Detail

getModId

java.lang.String getModId()
Returns ID used to identify this mod internally, even among different versions of the same mod. Mods should override. --This should never be changed after the mod has been released!--

Returns:
Returns the id of the mod.

getName

java.lang.String getName()
Specified by:
getName in interface com.mumfrey.liteloader.api.Listener

getNewerVersion

BLMod getNewerVersion(BLMod otherMod)
Compares two mods of the same type to determine which is newer. Mods should override this and implement their own comparison logic.

Parameters:
otherMod - The mod to compare
Returns:
Return the newer mod

getVersion

java.lang.String getVersion()
Specified by:
getVersion in interface com.mumfrey.liteloader.LiteMod

isCompatibleWithEnvironment

boolean isCompatibleWithEnvironment()
Returns true if this mod is compatible with the installed version of BlazeLoader. This should be checked using Version.class. -Called before mod is loaded! Do not depend on Mod.load()!-

Returns:
Returns true if the mod is compatible with the installed version of BlazeLoader.

getModDescription

java.lang.String getModDescription()
Gets a user-friendly description of the mod.

Returns:
Return a String representing a user-friendly description of the mod.