public interface ModContainer
The philosophy is that individual mod implementation technologies should not impact the actual loading and management of mod code. This interface provides a mechanism by which we can wrap actual mod code so that the loader and other facilities can treat mods at arms length.
Modifier and Type | Method and Description |
---|---|
VersionRange |
acceptableMinecraftVersionRange() |
void |
bindMetadata(MetadataCollection mc)
Attach this mod to it's metadata from the supplied metadata collection
|
List<ArtifactVersion> |
getDependants()
A list of modids that should be loaded after this one.
|
List<ArtifactVersion> |
getDependencies()
A list of modids that should be loaded prior to this one.
|
String |
getDisplayVersion() |
ModMetadata |
getMetadata()
The metadata for this mod
|
Object |
getMod()
Get the actual mod object
|
String |
getModId()
The globally unique modid for this mod
|
String |
getName()
A human readable name
|
ArtifactVersion |
getProcessedVersion() |
Set<ArtifactVersion> |
getRequirements()
A list of the modids that this mod requires loaded prior to loading
|
Certificate |
getSigningCertificate() |
String |
getSortingRules()
A representative string encapsulating the sorting preferences for this
mod
|
File |
getSource()
The location on the file system which this mod came from
|
String |
getVersion()
A human readable version identifier
|
boolean |
isImmutable() |
boolean |
isNetworkMod() |
boolean |
matches(Object mod)
Does this mod match the supplied mod
|
boolean |
registerBus(com.google.common.eventbus.EventBus bus,
LoadController controller)
Register the event bus for the mod and the controller for error handling
Returns if this bus was successfully registered - disabled mods and other
mods that don't need real events should return false and avoid further
processing
|
void |
setEnabledState(boolean enabled)
Set the enabled/disabled state of this mod
|
String getModId()
String getName()
String getVersion()
File getSource()
ModMetadata getMetadata()
void bindMetadata(MetadataCollection mc)
void setEnabledState(boolean enabled)
Set<ArtifactVersion> getRequirements()
List<ArtifactVersion> getDependencies()
List<ArtifactVersion> getDependants()
String getSortingRules()
boolean registerBus(com.google.common.eventbus.EventBus bus, LoadController controller)
bus
- controller
- boolean matches(Object mod)
mod
- Object getMod()
ArtifactVersion getProcessedVersion()
boolean isImmutable()
boolean isNetworkMod()
String getDisplayVersion()
VersionRange acceptableMinecraftVersionRange()
Certificate getSigningCertificate()