ModContainer (Forge API)

+
+
All Known Implementing Classes:
+
DummyModContainer, FMLContainer, FMLModContainer, ForgeModContainer, InjectedModContainer, MCPDummyContainer, MinecraftDummyContainer
+
+
+
+
```
public interface ModContainer
```
+
The container that wraps around mods in the system. +
+ 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. +
+

+ +

+ + +
Nested Class Summary
+ + + + + + + + + + +
Nested Classes
Modifier and Type Interface and Description
static class ModContainer.Disableable
+

Nested Classes
Modifier and Type	Interface and Description
`static class`	`ModContainer.Disableable`

+ +

+ + +
Field Summary
+ + + + + + + + + + +
Fields
Modifier and Type Field and Description
static java.util.Map<java.lang.String,java.lang.String> EMPTY_PROPERTIES
+

Fields
Modifier and Type	Field and Description
`static java.util.Map<java.lang.String,java.lang.String>`	`EMPTY_PROPERTIES`

+ +

Method Summary

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Methods
Modifier and Type	Method and Description
`VersionRange`	`acceptableMinecraftVersionRange()`
`void`	`bindMetadata(MetadataCollection mc)` + Attach this mod to it's metadata from the supplied metadata collection +
`ModContainer.Disableable`	`canBeDisabled()`
`java.util.Map<java.lang.String,java.lang.String>`	`getCustomModProperties()`
`java.lang.Class<?>`	`getCustomResourcePackClass()`
`java.util.List<ArtifactVersion>`	`getDependants()` + A list of modids that should be loaded after this one. +
`java.util.List<ArtifactVersion>`	`getDependencies()` + A list of modids that should be loaded prior to this one. +
`java.lang.String`	`getDisplayVersion()`
`java.lang.String`	`getGuiClassName()`
`ModMetadata`	`getMetadata()` + The metadata for this mod +
`java.lang.Object`	`getMod()` + Get the actual mod object +
`java.lang.String`	`getModId()` + The globally unique modid for this mod +
`java.lang.String`	`getName()` + A human readable name +
`java.util.List<java.lang.String>`	`getOwnedPackages()`
`ArtifactVersion`	`getProcessedVersion()`
`java.util.Set<ArtifactVersion>`	`getRequirements()` + A list of the modids that this mod requires loaded prior to loading +
`java.util.Map<java.lang.String,java.lang.String>`	`getSharedModDescriptor()`
`java.security.cert.Certificate`	`getSigningCertificate()`
`java.lang.String`	`getSortingRules()` + A representative string encapsulating the sorting preferences for this + mod +
`java.io.File`	`getSource()` + The location on the file system which this mod came from +
`java.lang.String`	`getVersion()` + A human readable version identifier +
`boolean`	`isImmutable()`
`boolean`	`matches(java.lang.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 +

+ +
- + + +
  Field Detail
  + + + +
  - +
    EMPTY_PROPERTIES
    +
```
static final java.util.Map<java.lang.String,java.lang.String> EMPTY_PROPERTIES
```
    +
  +
+ +
- + + +
  Method Detail
  + + + +
  - +
    getModId
    +
```
java.lang.String getModId()
```
    +
    The globally unique modid for this mod
    +
  + + + +
  - +
    getName
    +
```
java.lang.String getName()
```
    +
    A human readable name
    +
  + + + +
  - +
    getVersion
    +
```
java.lang.String getVersion()
```
    +
    A human readable version identifier
    +
  + + + +
  - +
    getSource
    +
```
java.io.File getSource()
```
    +
    The location on the file system which this mod came from
    +
  + + + +
  - +
    getMetadata
    +
```
ModMetadata getMetadata()
```
    +
    The metadata for this mod
    +
  + + + +
  - +
    bindMetadata
    +
```
void bindMetadata(MetadataCollection mc)
```
    +
    Attach this mod to it's metadata from the supplied metadata collection
    +
  + + + +
  - +
    setEnabledState
    +
```
void setEnabledState(boolean enabled)
```
    +
    Set the enabled/disabled state of this mod
    +
  + + + +
  - +
    getRequirements
    +
```
java.util.Set<ArtifactVersion> getRequirements()
```
    +
    A list of the modids that this mod requires loaded prior to loading
    +
  + + + +
  - +
    getDependencies
    +
```
java.util.List<ArtifactVersion> getDependencies()
```
    +
    A list of modids that should be loaded prior to this one. The special + value * indicates to load after any other mod.
    +
  + + + +
  - +
    getDependants
    +
```
java.util.List<ArtifactVersion> getDependants()
```
    +
    A list of modids that should be loaded after this one. The + special value * indicates to load before any + other mod.
    +
  + + + +
  - +
    getSortingRules
    +
```
java.lang.String getSortingRules()
```
    +
    A representative string encapsulating the sorting preferences for this + mod
    +
  + + + +
  - +
    registerBus
    +
```
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
    +
    Parameters:
    bus -
    controller -
    +
  + + + +
  - +
    matches
    +
```
boolean matches(java.lang.Object mod)
```
    +
    Does this mod match the supplied mod
    +
    Parameters:
    mod -
    +
  + + + +
  - +
    getMod
    +
```
java.lang.Object getMod()
```
    +
    Get the actual mod object
    +
  + + + +
  - +
    getProcessedVersion
    +
```
ArtifactVersion getProcessedVersion()
```
    +
  + + + +
  - +
    isImmutable
    +
```
boolean isImmutable()
```
    +
  + + + +
  - +
    getDisplayVersion
    +
```
java.lang.String getDisplayVersion()
```
    +
  + + + +
  - +
    acceptableMinecraftVersionRange
    +
```
VersionRange acceptableMinecraftVersionRange()
```
    +
  + + + +
  - +
    getSigningCertificate
    +
```
java.security.cert.Certificate getSigningCertificate()
```
    +
  + + + +
  - +
    getCustomModProperties
    +
```
java.util.Map<java.lang.String,java.lang.String> getCustomModProperties()
```
    +
  + + + +
  - +
    getCustomResourcePackClass
    +
```
java.lang.Class<?> getCustomResourcePackClass()
```
    +
  + + + +
  - +
    getSharedModDescriptor
    +
```
java.util.Map<java.lang.String,java.lang.String> getSharedModDescriptor()
```
    +
  + + + +
  - +
    canBeDisabled
    +
```
ModContainer.Disableable canBeDisabled()
```
    +
  + + + +
  - +
    getGuiClassName
    +
```
java.lang.String getGuiClassName()
```
    +
  + + + +
  - +
    getOwnedPackages
    +
```
java.util.List<java.lang.String> getOwnedPackages()
```
    +
  +
+

Interface ModContainer

Nested Class Summary

Field Summary

Method Summary

Field Detail

EMPTY_PROPERTIES

Method Detail

getModId

getName

getVersion

getSource

getMetadata

bindMetadata

setEnabledState

getRequirements

getDependencies

getDependants

getSortingRules

registerBus

matches

getMod

getProcessedVersion

isImmutable

getDisplayVersion

acceptableMinecraftVersionRange

getSigningCertificate

getCustomModProperties

getCustomResourcePackClass

getSharedModDescriptor

canBeDisabled

getGuiClassName

getOwnedPackages