cpw.mods.fml.common.ModContainer Interface Reference

Inheritance diagram for cpw.mods.fml.common.ModContainer:

Public Member Functions
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 (EventBus bus, LoadController controller)
boolean	matches (Object mod)
Object	getMod ()
ArtifactVersion	getProcessedVersion ()
boolean	isImmutable ()
boolean	isNetworkMod ()
String	getDisplayVersion ()
VersionRange	acceptableMinecraftVersionRange ()
Certificate	getSigningCertificate ()

Detailed Description

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.

Author

cpw

Member Function Documentation

VersionRange cpw.mods.fml.common.ModContainer.acceptableMinecraftVersionRange

(

)

Implemented in cpw.mods.fml.common.modloader.ModLoaderModContainer, cpw.mods.fml.common.FMLModContainer, cpw.mods.fml.common.DummyModContainer, and cpw.mods.fml.common.InjectedModContainer.

void cpw.mods.fml.common.ModContainer.bindMetadata

(

MetadataCollection

mc)

Attach this mod to it's metadata from the supplied metadata collection

Implemented in cpw.mods.fml.common.modloader.ModLoaderModContainer, cpw.mods.fml.common.FMLModContainer, cpw.mods.fml.common.InjectedModContainer, and cpw.mods.fml.common.DummyModContainer.

List<ArtifactVersion> cpw.mods.fml.common.ModContainer.getDependants

(

)

A list of modids that should be loaded after this one. The special value * indicates to load before any other mod.

Implemented in cpw.mods.fml.common.modloader.ModLoaderModContainer, cpw.mods.fml.common.FMLModContainer, cpw.mods.fml.common.InjectedModContainer, and cpw.mods.fml.common.DummyModContainer.

List<ArtifactVersion> cpw.mods.fml.common.ModContainer.getDependencies

(

)

A list of modids that should be loaded prior to this one. The special value * indicates to load after any other mod.

Implemented in cpw.mods.fml.common.modloader.ModLoaderModContainer, cpw.mods.fml.common.FMLModContainer, cpw.mods.fml.common.InjectedModContainer, and cpw.mods.fml.common.DummyModContainer.

String cpw.mods.fml.common.ModContainer.getDisplayVersion

(

)

Implemented in cpw.mods.fml.common.modloader.ModLoaderModContainer, cpw.mods.fml.common.FMLModContainer, cpw.mods.fml.common.DummyModContainer, and cpw.mods.fml.common.InjectedModContainer.

ModMetadata cpw.mods.fml.common.ModContainer.getMetadata

(

)

The metadata for this mod

Implemented in cpw.mods.fml.common.modloader.ModLoaderModContainer, cpw.mods.fml.common.FMLModContainer, cpw.mods.fml.common.DummyModContainer, and cpw.mods.fml.common.InjectedModContainer.

Object cpw.mods.fml.common.ModContainer.getMod

(

)

Get the actual mod object

Implemented in cpw.mods.fml.common.modloader.ModLoaderModContainer, cpw.mods.fml.common.FMLModContainer, cpw.mods.fml.common.InjectedModContainer, and cpw.mods.fml.common.DummyModContainer.

String cpw.mods.fml.common.ModContainer.getModId

(

)

The globally unique modid for this mod

Implemented in cpw.mods.fml.common.modloader.ModLoaderModContainer, cpw.mods.fml.common.FMLModContainer, cpw.mods.fml.common.DummyModContainer, and cpw.mods.fml.common.InjectedModContainer.

String cpw.mods.fml.common.ModContainer.getName

(

)

A human readable name

Implemented in cpw.mods.fml.common.modloader.ModLoaderModContainer, cpw.mods.fml.common.FMLModContainer, cpw.mods.fml.common.DummyModContainer, and cpw.mods.fml.common.InjectedModContainer.

ArtifactVersion cpw.mods.fml.common.ModContainer.getProcessedVersion

(

)

Implemented in cpw.mods.fml.common.modloader.ModLoaderModContainer, cpw.mods.fml.common.FMLModContainer, cpw.mods.fml.common.DummyModContainer, and cpw.mods.fml.common.InjectedModContainer.

Set<ArtifactVersion> cpw.mods.fml.common.ModContainer.getRequirements

(

)

A list of the modids that this mod requires loaded prior to loading

Implemented in cpw.mods.fml.common.modloader.ModLoaderModContainer, cpw.mods.fml.common.FMLModContainer, cpw.mods.fml.common.InjectedModContainer, and cpw.mods.fml.common.DummyModContainer.

Certificate cpw.mods.fml.common.ModContainer.getSigningCertificate

(

)

Implemented in cpw.mods.fml.common.modloader.ModLoaderModContainer, cpw.mods.fml.common.FMLModContainer, cpw.mods.fml.common.DummyModContainer, cpw.mods.fml.common.InjectedModContainer, and cpw.mods.fml.common.FMLDummyContainer.

String cpw.mods.fml.common.ModContainer.getSortingRules

(

)

A representative string encapsulating the sorting preferences for this mod

Implemented in cpw.mods.fml.common.modloader.ModLoaderModContainer, cpw.mods.fml.common.FMLModContainer, cpw.mods.fml.common.DummyModContainer, and cpw.mods.fml.common.InjectedModContainer.

File cpw.mods.fml.common.ModContainer.getSource

(

)

The location on the file system which this mod came from

Implemented in cpw.mods.fml.common.modloader.ModLoaderModContainer, cpw.mods.fml.common.FMLModContainer, cpw.mods.fml.common.DummyModContainer, and cpw.mods.fml.common.InjectedModContainer.

String cpw.mods.fml.common.ModContainer.getVersion

(

)

A human readable version identifier

Implemented in cpw.mods.fml.common.modloader.ModLoaderModContainer, cpw.mods.fml.common.FMLModContainer, cpw.mods.fml.common.DummyModContainer, and cpw.mods.fml.common.InjectedModContainer.

boolean cpw.mods.fml.common.ModContainer.isImmutable

(

)

Implemented in cpw.mods.fml.common.modloader.ModLoaderModContainer, cpw.mods.fml.common.FMLModContainer, cpw.mods.fml.common.DummyModContainer, and cpw.mods.fml.common.InjectedModContainer.

boolean cpw.mods.fml.common.ModContainer.isNetworkMod

(

)

Implemented in cpw.mods.fml.common.modloader.ModLoaderModContainer, cpw.mods.fml.common.FMLModContainer, cpw.mods.fml.common.DummyModContainer, and cpw.mods.fml.common.InjectedModContainer.

boolean cpw.mods.fml.common.ModContainer.matches

(

Object

mod)

Does this mod match the supplied mod

Parameters

mod

Implemented in cpw.mods.fml.common.modloader.ModLoaderModContainer, cpw.mods.fml.common.FMLModContainer, cpw.mods.fml.common.DummyModContainer, and cpw.mods.fml.common.InjectedModContainer.

boolean cpw.mods.fml.common.ModContainer.registerBus	(	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

Implemented in cpw.mods.fml.common.modloader.ModLoaderModContainer, cpw.mods.fml.common.FMLModContainer, cpw.mods.fml.common.DummyModContainer, cpw.mods.fml.common.InjectedModContainer, cpw.mods.fml.common.FMLDummyContainer, and cpw.mods.fml.common.MCPDummyContainer.

void cpw.mods.fml.common.ModContainer.setEnabledState

(

boolean

enabled)

Set the enabled/disabled state of this mod

Implemented in cpw.mods.fml.common.modloader.ModLoaderModContainer, cpw.mods.fml.common.FMLModContainer, cpw.mods.fml.common.DummyModContainer, and cpw.mods.fml.common.InjectedModContainer.

---

The documentation for this interface was generated from the following file:

• C:/Users/LazDude/Downloads/MinecraftModding/YATS/forge/mcp/src/minecraft/cpw/mods/fml/common/ModContainer.java