FMLModContainer (Forge API)

java.lang.Object
+
- cpw.mods.fml.common.FMLModContainer
+

All Implemented Interfaces:: ModContainer

+
+

public class FMLModContainer
+extends java.lang.Object
+implements ModContainer

+ +

+ + +
Nested Class Summary
+
- + + +
  Nested classes/interfaces inherited from interface cpw.mods.fml.common.ModContainer
  +ModContainer.Disableable
+

+ +

+ + +
Field Summary
+
- + + +
  Fields inherited from interface cpw.mods.fml.common.ModContainer
  +EMPTY_PROPERTIES
+

+ +

+ + +

Constructor Summary

+ + + + + + + + +

Constructors
Constructor and Description
`FMLModContainer(java.lang.String className, + ModCandidate container, + java.util.Map<java.lang.String,java.lang.Object> modDescriptor)`

+ +

+ + +

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()`
`void`	`constructMod(FMLConstructionEvent event)`
`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 +
`void`	`handleModStateEvent(FMLEvent event)`
`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 +
`java.util.Properties`	`searchForVersionProperties()`
`void`	`setEnabledState(boolean enabled)` + Set the enabled/disabled state of this mod +
`java.lang.String`	`toString()`

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

+ +
- + + +
  Constructor Detail
  + + + +
  - +
    FMLModContainer
    +
```
public FMLModContainer(java.lang.String className,
+               ModCandidate container,
+               java.util.Map<java.lang.String,java.lang.Object> modDescriptor)
```
    +
  +
+ +
- + + +
  Method Detail
  + + + +
  - +
    getModId
    +
```
public java.lang.String getModId()
```
    +
    Description copied from interface: ModContainer
    +
    The globally unique modid for this mod
    +
    +
    Specified by:
    +
    getModId in interface ModContainer
    +
    +
  + + + +
  - +
    getName
    +
```
public java.lang.String getName()
```
    +
    Description copied from interface: ModContainer
    +
    A human readable name
    +
    +
    Specified by:
    +
    getName in interface ModContainer
    +
    +
  + + + +
  - +
    getVersion
    +
```
public java.lang.String getVersion()
```
    +
    Description copied from interface: ModContainer
    +
    A human readable version identifier
    +
    +
    Specified by:
    +
    getVersion in interface ModContainer
    +
    +
  + + + +
  - +
    getSource
    +
```
public java.io.File getSource()
```
    +
    Description copied from interface: ModContainer
    +
    The location on the file system which this mod came from
    +
    +
    Specified by:
    +
    getSource in interface ModContainer
    +
    +
  + + + +
  - +
    getMetadata
    +
```
public ModMetadata getMetadata()
```
    +
    Description copied from interface: ModContainer
    +
    The metadata for this mod
    +
    +
    Specified by:
    +
    getMetadata in interface ModContainer
    +
    +
  + + + +
  - +
    bindMetadata
    +
```
public void bindMetadata(MetadataCollection mc)
```
    +
    Description copied from interface: ModContainer
    +
    Attach this mod to it's metadata from the supplied metadata collection
    +
    +
    Specified by:
    +
    bindMetadata in interface ModContainer
    +
    +
  + + + +
  - +
    searchForVersionProperties
    +
```
public java.util.Properties searchForVersionProperties()
```
    +
  + + + +
  - +
    setEnabledState
    +
```
public void setEnabledState(boolean enabled)
```
    +
    Description copied from interface: ModContainer
    +
    Set the enabled/disabled state of this mod
    +
    +
    Specified by:
    +
    setEnabledState in interface ModContainer
    +
    +
  + + + +
  - +
    getRequirements
    +
```
public java.util.Set<ArtifactVersion> getRequirements()
```
    +
    Description copied from interface: ModContainer
    +
    A list of the modids that this mod requires loaded prior to loading
    +
    +
    Specified by:
    +
    getRequirements in interface ModContainer
    +
    +
  + + + +
  - +
    getDependencies
    +
```
public java.util.List<ArtifactVersion> getDependencies()
```
    +
    Description copied from interface: ModContainer
    +
    A list of modids that should be loaded prior to this one. The special + value * indicates to load after any other mod.
    +
    +
    Specified by:
    +
    getDependencies in interface ModContainer
    +
    +
  + + + +
  - +
    getDependants
    +
```
public java.util.List<ArtifactVersion> getDependants()
```
    +
    Description copied from interface: ModContainer
    +
    A list of modids that should be loaded after this one. The + special value * indicates to load before any + other mod.
    +
    +
    Specified by:
    +
    getDependants in interface ModContainer
    +
    +
  + + + +
  - +
    getSortingRules
    +
```
public java.lang.String getSortingRules()
```
    +
    Description copied from interface: ModContainer
    +
    A representative string encapsulating the sorting preferences for this + mod
    +
    +
    Specified by:
    +
    getSortingRules in interface ModContainer
    +
    +
  + + + +
  - +
    matches
    +
```
public boolean matches(java.lang.Object mod)
```
    +
    Description copied from interface: ModContainer
    +
    Does this mod match the supplied mod
    +
    +
    Specified by:
    +
    matches in interface ModContainer
    +
    +
  + + + +
  - +
    getMod
    +
```
public java.lang.Object getMod()
```
    +
    Description copied from interface: ModContainer
    +
    Get the actual mod object
    +
    +
    Specified by:
    +
    getMod in interface ModContainer
    +
    +
  + + + +
  - +
    registerBus
    +
```
public boolean registerBus(com.google.common.eventbus.EventBus bus,
+                  LoadController controller)
```
    +
    Description copied from interface: ModContainer
    +
    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
    +
    +
    Specified by:
    +
    registerBus in interface ModContainer
    +
    +
  + + + +
  - +
    constructMod
    +
```
public void constructMod(FMLConstructionEvent event)
```
    +
  + + + +
  - +
    handleModStateEvent
    +
```
public void handleModStateEvent(FMLEvent event)
```
    +
  + + + +
  - +
    getProcessedVersion
    +
```
public ArtifactVersion getProcessedVersion()
```
    +
    +
    Specified by:
    +
    getProcessedVersion in interface ModContainer
    +
    +
  + + + +
  - +
    isImmutable
    +
```
public boolean isImmutable()
```
    +
    +
    Specified by:
    +
    isImmutable in interface ModContainer
    +
    +
  + + + +
  - +
    getDisplayVersion
    +
```
public java.lang.String getDisplayVersion()
```
    +
    +
    Specified by:
    +
    getDisplayVersion in interface ModContainer
    +
    +
  + + + +
  - +
    acceptableMinecraftVersionRange
    +
```
public VersionRange acceptableMinecraftVersionRange()
```
    +
    +
    Specified by:
    +
    acceptableMinecraftVersionRange in interface ModContainer
    +
    +
  + + + +
  - +
    getSigningCertificate
    +
```
public java.security.cert.Certificate getSigningCertificate()
```
    +
    +
    Specified by:
    +
    getSigningCertificate in interface ModContainer
    +
    +
  + + + +
  - +
    toString
    +
```
public java.lang.String toString()
```
    +
    +
    Overrides:
    +
    toString in class java.lang.Object
    +
    +
  + + + +
  - +
    getCustomModProperties
    +
```
public java.util.Map<java.lang.String,java.lang.String> getCustomModProperties()
```
    +
    +
    Specified by:
    +
    getCustomModProperties in interface ModContainer
    +
    +
  + + + +
  - +
    getCustomResourcePackClass
    +
```
public java.lang.Class<?> getCustomResourcePackClass()
```
    +
    +
    Specified by:
    +
    getCustomResourcePackClass in interface ModContainer
    +
    +
  + + + +
  - +
    getSharedModDescriptor
    +
```
public java.util.Map<java.lang.String,java.lang.String> getSharedModDescriptor()
```
    +
    +
    Specified by:
    +
    getSharedModDescriptor in interface ModContainer
    +
    +
  + + + +
  - +
    canBeDisabled
    +
```
public ModContainer.Disableable canBeDisabled()
```
    +
    +
    Specified by:
    +
    canBeDisabled in interface ModContainer
    +
    +
  + + + +
  - +
    getGuiClassName
    +
```
public java.lang.String getGuiClassName()
```
    +
    +
    Specified by:
    +
    getGuiClassName in interface ModContainer
    +
    +
  + + + +
  - +
    getOwnedPackages
    +
```
public java.util.List<java.lang.String> getOwnedPackages()
```
    +
    +
    Specified by:
    +
    getOwnedPackages in interface ModContainer
    +
    +
  +
+

Class FMLModContainer

Nested Class Summary

Nested classes/interfaces inherited from interface cpw.mods.fml.common.ModContainer

Field Summary

Fields inherited from interface cpw.mods.fml.common.ModContainer

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FMLModContainer

Method Detail

getModId

getName

getVersion

getSource

getMetadata

bindMetadata

searchForVersionProperties

setEnabledState

getRequirements

getDependencies

getDependants

getSortingRules

matches

getMod

registerBus

constructMod

handleModStateEvent

getProcessedVersion

isImmutable

getDisplayVersion

acceptableMinecraftVersionRange

getSigningCertificate

toString

getCustomModProperties

getCustomResourcePackClass

getSharedModDescriptor

canBeDisabled

getGuiClassName

getOwnedPackages