diff options
| author | Foghrye4 <foghrye4@gmail.com> | 2017-06-17 08:12:18 +0300 |
|---|---|---|
| committer | Foghrye4 <foghrye4@gmail.com> | 2017-06-17 08:12:18 +0300 |
| commit | dc3df3edd5843bde0c1335d6a8e460b2c832aa48 (patch) | |
| tree | af13bfeee567f2351e35e1ef176d168fe37c8aac /javadoc/cpw/mods/fml/common/package-summary.html | |
| parent | 1da8dcd58647e34c9af94ceeecaeaf3b0d08c48c (diff) | |
full project files
Diffstat (limited to 'javadoc/cpw/mods/fml/common/package-summary.html')
| -rw-r--r-- | javadoc/cpw/mods/fml/common/package-summary.html | 454 |
1 files changed, 454 insertions, 0 deletions
diff --git a/javadoc/cpw/mods/fml/common/package-summary.html b/javadoc/cpw/mods/fml/common/package-summary.html new file mode 100644 index 0000000..42b7ea4 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/package-summary.html @@ -0,0 +1,454 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (version 1.7.0_65) on Thu Feb 05 20:10:22 EST 2015 --> +<title>cpw.mods.fml.common (Forge API)</title> +<meta name="date" content="2015-02-05"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="cpw.mods.fml.common (Forge API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li class="navBarCell1Rev">Package</li> +<li>Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-all.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../cpw/mods/fml/client/registry/package-summary.html">Prev Package</a></li> +<li><a href="../../../../cpw/mods/fml/common/asm/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?cpw/mods/fml/common/package-summary.html" target="_top">Frames</a></li> +<li><a href="package-summary.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h1 title="Package" class="title">Package cpw.mods.fml.common</h1> +</div> +<div class="contentContainer"> +<ul class="blockList"> +<li class="blockList"> +<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation"> +<caption><span>Interface Summary</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Interface</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../cpw/mods/fml/common/BukkitProxy.html" title="interface in cpw.mods.fml.common">BukkitProxy</a></td> +<td class="colLast"> +<div class="block">A marker interface for retrieving a proxy to a bukkit plugin.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../cpw/mods/fml/common/IASMHook.html" title="interface in cpw.mods.fml.common">IASMHook</a></td> +<td class="colLast"> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../cpw/mods/fml/common/ICrashCallable.html" title="interface in cpw.mods.fml.common">ICrashCallable</a></td> +<td class="colLast"> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../cpw/mods/fml/common/IFMLHandledException.html" title="interface in cpw.mods.fml.common">IFMLHandledException</a></td> +<td class="colLast"> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../cpw/mods/fml/common/IFMLSidedHandler.html" title="interface in cpw.mods.fml.common">IFMLSidedHandler</a></td> +<td class="colLast"> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../cpw/mods/fml/common/IFuelHandler.html" title="interface in cpw.mods.fml.common">IFuelHandler</a></td> +<td class="colLast"> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../cpw/mods/fml/common/ILanguageAdapter.html" title="interface in cpw.mods.fml.common">ILanguageAdapter</a></td> +<td class="colLast"> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../cpw/mods/fml/common/IWorldGenerator.html" title="interface in cpw.mods.fml.common">IWorldGenerator</a></td> +<td class="colLast"> +<div class="block">This is called back during world generation.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../cpw/mods/fml/common/ModContainer.html" title="interface in cpw.mods.fml.common">ModContainer</a></td> +<td class="colLast"> +<div class="block">The container that wraps around mods in the system.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../cpw/mods/fml/common/WorldAccessContainer.html" title="interface in cpw.mods.fml.common">WorldAccessContainer</a></td> +<td class="colLast"> </td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation"> +<caption><span>Class Summary</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Class</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../cpw/mods/fml/common/CertificateHelper.html" title="class in cpw.mods.fml.common">CertificateHelper</a></td> +<td class="colLast"> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../cpw/mods/fml/common/DummyModContainer.html" title="class in cpw.mods.fml.common">DummyModContainer</a></td> +<td class="colLast"> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../cpw/mods/fml/common/FMLCommonHandler.html" title="class in cpw.mods.fml.common">FMLCommonHandler</a></td> +<td class="colLast"> +<div class="block">The main class for non-obfuscated hook handling code + + Anything that doesn't require obfuscated or client/server specific code should + go in this handler + + It also contains a reference to the sided handler instance that is valid + allowing for common code to access specific properties from the obfuscated world + without a direct dependency</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../cpw/mods/fml/common/FMLContainer.html" title="class in cpw.mods.fml.common">FMLContainer</a></td> +<td class="colLast"> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../cpw/mods/fml/common/FMLLog.html" title="class in cpw.mods.fml.common">FMLLog</a></td> +<td class="colLast"> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../cpw/mods/fml/common/FMLModContainer.html" title="class in cpw.mods.fml.common">FMLModContainer</a></td> +<td class="colLast"> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../cpw/mods/fml/common/ILanguageAdapter.JavaAdapter.html" title="class in cpw.mods.fml.common">ILanguageAdapter.JavaAdapter</a></td> +<td class="colLast"> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../cpw/mods/fml/common/ILanguageAdapter.ScalaAdapter.html" title="class in cpw.mods.fml.common">ILanguageAdapter.ScalaAdapter</a></td> +<td class="colLast"> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../cpw/mods/fml/common/InjectedModContainer.html" title="class in cpw.mods.fml.common">InjectedModContainer</a></td> +<td class="colLast"> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../cpw/mods/fml/common/LoadController.html" title="class in cpw.mods.fml.common">LoadController</a></td> +<td class="colLast"> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../cpw/mods/fml/common/Loader.html" title="class in cpw.mods.fml.common">Loader</a></td> +<td class="colLast"> +<div class="block">The loader class performs the actual loading of the mod code from disk.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../cpw/mods/fml/common/MCPDummyContainer.html" title="class in cpw.mods.fml.common">MCPDummyContainer</a></td> +<td class="colLast"> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../cpw/mods/fml/common/MetadataCollection.html" title="class in cpw.mods.fml.common">MetadataCollection</a></td> +<td class="colLast"> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../cpw/mods/fml/common/MetadataCollection.ArtifactVersionAdapter.html" title="class in cpw.mods.fml.common">MetadataCollection.ArtifactVersionAdapter</a></td> +<td class="colLast"> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../cpw/mods/fml/common/MinecraftDummyContainer.html" title="class in cpw.mods.fml.common">MinecraftDummyContainer</a></td> +<td class="colLast"> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../cpw/mods/fml/common/ModAPIManager.html" title="class in cpw.mods.fml.common">ModAPIManager</a></td> +<td class="colLast"> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../cpw/mods/fml/common/ModClassLoader.html" title="class in cpw.mods.fml.common">ModClassLoader</a></td> +<td class="colLast"> +<div class="block">A simple delegating class loader used to load mods into the system</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../cpw/mods/fml/common/ModContainerFactory.html" title="class in cpw.mods.fml.common">ModContainerFactory</a></td> +<td class="colLast"> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../cpw/mods/fml/common/ModMetadata.html" title="class in cpw.mods.fml.common">ModMetadata</a></td> +<td class="colLast"> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../cpw/mods/fml/common/ObfuscationReflectionHelper.html" title="class in cpw.mods.fml.common">ObfuscationReflectionHelper</a></td> +<td class="colLast"> +<div class="block">Some reflection helper code.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../cpw/mods/fml/common/Optional.html" title="class in cpw.mods.fml.common">Optional</a></td> +<td class="colLast"> +<div class="block">Classes annotated with this will have the named interface or method removed from the runtime definition of the class + if the modid specified is missing.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../cpw/mods/fml/common/ProxyInjector.html" title="class in cpw.mods.fml.common">ProxyInjector</a></td> +<td class="colLast"> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../cpw/mods/fml/common/StartupQuery.html" title="class in cpw.mods.fml.common">StartupQuery</a></td> +<td class="colLast"> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../cpw/mods/fml/common/TracingPrintStream.html" title="class in cpw.mods.fml.common">TracingPrintStream</a></td> +<td class="colLast"> +<div class="block">PrintStream which redirects it's output to a given logger.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../cpw/mods/fml/common/ZipperUtil.html" title="class in cpw.mods.fml.common">ZipperUtil</a></td> +<td class="colLast"> +<div class="block">Copied from http://stackoverflow.com/questions/1399126/java-util-zip-recreating-directory-structure + because the code looked very tidy and neat.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation"> +<caption><span>Enum Summary</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Enum</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../cpw/mods/fml/common/LoaderState.html" title="enum in cpw.mods.fml.common">LoaderState</a></td> +<td class="colLast"> +<div class="block">The state enum used to help track state progression for the loader</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../cpw/mods/fml/common/LoaderState.ModState.html" title="enum in cpw.mods.fml.common">LoaderState.ModState</a></td> +<td class="colLast"> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../cpw/mods/fml/common/ModContainer.Disableable.html" title="enum in cpw.mods.fml.common">ModContainer.Disableable</a></td> +<td class="colLast"> </td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Exception Summary table, listing exceptions, and an explanation"> +<caption><span>Exception Summary</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Exception</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../cpw/mods/fml/common/DuplicateModsFoundException.html" title="class in cpw.mods.fml.common">DuplicateModsFoundException</a></td> +<td class="colLast"> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../cpw/mods/fml/common/LoaderException.html" title="class in cpw.mods.fml.common">LoaderException</a></td> +<td class="colLast"> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../cpw/mods/fml/common/MissingModsException.html" title="class in cpw.mods.fml.common">MissingModsException</a></td> +<td class="colLast"> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../cpw/mods/fml/common/StartupQuery.AbortedException.html" title="class in cpw.mods.fml.common">StartupQuery.AbortedException</a></td> +<td class="colLast"> +<div class="block">Exception not being caught by the crash report generation logic.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../cpw/mods/fml/common/WrongMinecraftVersionException.html" title="class in cpw.mods.fml.common">WrongMinecraftVersionException</a></td> +<td class="colLast"> </td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Annotation Types Summary table, listing annotation types, and an explanation"> +<caption><span>Annotation Types Summary</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Annotation Type</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../cpw/mods/fml/common/API.html" title="annotation in cpw.mods.fml.common">API</a></td> +<td class="colLast"> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../cpw/mods/fml/common/BukkitPluginRef.html" title="annotation in cpw.mods.fml.common">BukkitPluginRef</a></td> +<td class="colLast"> +<div class="block">Declare a variable to be populated by a Bukkit Plugin proxy instance if the bukkit coremod + is available.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../cpw/mods/fml/common/Mod.html" title="annotation in cpw.mods.fml.common">Mod</a></td> +<td class="colLast"> +<div class="block">This defines a Mod to FML.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../cpw/mods/fml/common/Mod.CustomProperty.html" title="annotation in cpw.mods.fml.common">Mod.CustomProperty</a></td> +<td class="colLast"> +<div class="block">A custom key => value property pair for use with <a href="../../../../cpw/mods/fml/common/Mod.html#customProperties()"><code>Mod.customProperties()</code></a></div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../cpw/mods/fml/common/Mod.EventHandler.html" title="annotation in cpw.mods.fml.common">Mod.EventHandler</a></td> +<td class="colLast"> +<div class="block">Marks the associated method as handling an FML lifecycle event.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../cpw/mods/fml/common/Mod.Instance.html" title="annotation in cpw.mods.fml.common">Mod.Instance</a></td> +<td class="colLast"> +<div class="block">Populate the annotated field with the mod instance based on the specified ModId.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../cpw/mods/fml/common/Mod.InstanceFactory.html" title="annotation in cpw.mods.fml.common">Mod.InstanceFactory</a></td> +<td class="colLast"> +<div class="block">Mod instance factory method.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../cpw/mods/fml/common/Mod.Metadata.html" title="annotation in cpw.mods.fml.common">Mod.Metadata</a></td> +<td class="colLast"> +<div class="block">Populate the annotated field with the mod's metadata.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../cpw/mods/fml/common/Optional.Interface.html" title="annotation in cpw.mods.fml.common">Optional.Interface</a></td> +<td class="colLast"> +<div class="block">Used to remove optional interfaces</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../cpw/mods/fml/common/Optional.InterfaceList.html" title="annotation in cpw.mods.fml.common">Optional.InterfaceList</a></td> +<td class="colLast"> +<div class="block">Mark a list of interfaces as removable</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../cpw/mods/fml/common/Optional.Method.html" title="annotation in cpw.mods.fml.common">Optional.Method</a></td> +<td class="colLast"> +<div class="block">Used to remove optional methods</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../cpw/mods/fml/common/SaveInspectionHandler.html" title="annotation in cpw.mods.fml.common">SaveInspectionHandler</a></td> +<td class="colLast"> +<div class="block">A method annotated with this on the <a href="../../../../cpw/mods/fml/common/Mod.html" title="annotation in cpw.mods.fml.common"><code>Mod</code></a> will be called whenever a local save is listed in + the save games list.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../cpw/mods/fml/common/SidedProxy.html" title="annotation in cpw.mods.fml.common">SidedProxy</a></td> +<td class="colLast"> +<div class="block">Sided proxies are loaded based on the specific environment they find themselves loaded into.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</div> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li class="navBarCell1Rev">Package</li> +<li>Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-all.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../cpw/mods/fml/client/registry/package-summary.html">Prev Package</a></li> +<li><a href="../../../../cpw/mods/fml/common/asm/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?cpw/mods/fml/common/package-summary.html" target="_top">Frames</a></li> +<li><a href="package-summary.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> |
