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/relauncher/IFMLLoadingPlugin.html | |
| parent | 1da8dcd58647e34c9af94ceeecaeaf3b0d08c48c (diff) | |
full project files
Diffstat (limited to 'javadoc/cpw/mods/fml/relauncher/IFMLLoadingPlugin.html')
| -rw-r--r-- | javadoc/cpw/mods/fml/relauncher/IFMLLoadingPlugin.html | 346 |
1 files changed, 346 insertions, 0 deletions
diff --git a/javadoc/cpw/mods/fml/relauncher/IFMLLoadingPlugin.html b/javadoc/cpw/mods/fml/relauncher/IFMLLoadingPlugin.html new file mode 100644 index 0000000..e889f61 --- /dev/null +++ b/javadoc/cpw/mods/fml/relauncher/IFMLLoadingPlugin.html @@ -0,0 +1,346 @@ +<!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:15 EST 2015 --> +<title>IFMLLoadingPlugin (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="IFMLLoadingPlugin (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><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">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/relauncher/IFMLCallHook.html" title="interface in cpw.mods.fml.relauncher"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../cpw/mods/fml/relauncher/IFMLLoadingPlugin.DependsOn.html" title="annotation in cpw.mods.fml.relauncher"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?cpw/mods/fml/relauncher/IFMLLoadingPlugin.html" target="_top">Frames</a></li> +<li><a href="IFMLLoadingPlugin.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> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li><a href="#nested_class_summary">Nested</a> | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">cpw.mods.fml.relauncher</div> +<h2 title="Interface IFMLLoadingPlugin" class="title">Interface IFMLLoadingPlugin</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../../cpw/mods/fml/relauncher/FMLCorePlugin.html" title="class in cpw.mods.fml.relauncher">FMLCorePlugin</a>, <a href="../../../../net/minecraftforge/classloading/FMLForgePlugin.html" title="class in net.minecraftforge.classloading">FMLForgePlugin</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">IFMLLoadingPlugin</span></pre> +<div class="block">The base plugin that provides class name meta information to FML to + enhance the classloading lifecycle for mods in FML</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="nested_class_summary"> +<!-- --> +</a> +<h3>Nested Class Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> +<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Interface and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static interface </code></td> +<td class="colLast"><code><strong><a href="../../../../cpw/mods/fml/relauncher/IFMLLoadingPlugin.DependsOn.html" title="annotation in cpw.mods.fml.relauncher">IFMLLoadingPlugin.DependsOn</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static interface </code></td> +<td class="colLast"><code><strong><a href="../../../../cpw/mods/fml/relauncher/IFMLLoadingPlugin.MCVersion.html" title="annotation in cpw.mods.fml.relauncher">IFMLLoadingPlugin.MCVersion</a></strong></code> +<div class="block">Use this to target a specific minecraft version for your coremod.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static interface </code></td> +<td class="colLast"><code><strong><a href="../../../../cpw/mods/fml/relauncher/IFMLLoadingPlugin.Name.html" title="annotation in cpw.mods.fml.relauncher">IFMLLoadingPlugin.Name</a></strong></code> +<div class="block">Name this coremod something other than the "short class name"</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static interface </code></td> +<td class="colLast"><code><strong><a href="../../../../cpw/mods/fml/relauncher/IFMLLoadingPlugin.SortingIndex.html" title="annotation in cpw.mods.fml.relauncher">IFMLLoadingPlugin.SortingIndex</a></strong></code> +<div class="block">A simple sorting index, interleaved with other tweakers from other sources, as well as FML</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static interface </code></td> +<td class="colLast"><code><strong><a href="../../../../cpw/mods/fml/relauncher/IFMLLoadingPlugin.TransformerExclusions.html" title="annotation in cpw.mods.fml.relauncher">IFMLLoadingPlugin.TransformerExclusions</a></strong></code> +<div class="block">Annotate your load plugin with a list of package prefixes that will *not* be + processed by the ASM transformation stack.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../cpw/mods/fml/relauncher/IFMLLoadingPlugin.html#getAccessTransformerClass()">getAccessTransformerClass</a></strong>()</code> +<div class="block">Return an optional access transformer class for this coremod.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.String[]</code></td> +<td class="colLast"><code><strong><a href="../../../../cpw/mods/fml/relauncher/IFMLLoadingPlugin.html#getASMTransformerClass()">getASMTransformerClass</a></strong>()</code> +<div class="block">Return a list of classes that implements the IClassTransformer interface</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../cpw/mods/fml/relauncher/IFMLLoadingPlugin.html#getModContainerClass()">getModContainerClass</a></strong>()</code> +<div class="block">Return a class name that implements "ModContainer" for injection into the mod list + The "getName" function should return a name that other mods can, if need be, + depend on.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../cpw/mods/fml/relauncher/IFMLLoadingPlugin.html#getSetupClass()">getSetupClass</a></strong>()</code> +<div class="block">Return the class name of an implementor of "IFMLCallHook", that will be run, in the + main thread, to perform any additional setup this coremod may require.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../cpw/mods/fml/relauncher/IFMLLoadingPlugin.html#injectData(java.util.Map)">injectData</a></strong>(java.util.Map<java.lang.String,java.lang.Object> data)</code> +<div class="block">Inject coremod data into this coremod + This data includes: + "mcLocation" : the location of the minecraft directory, + "coremodList" : the list of coremods + "coremodLocation" : the file this coremod loaded from,</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getASMTransformerClass()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getASMTransformerClass</h4> +<pre>java.lang.String[] getASMTransformerClass()</pre> +<div class="block">Return a list of classes that implements the IClassTransformer interface</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>a list of classes that implements the IClassTransformer interface</dd></dl> +</li> +</ul> +<a name="getModContainerClass()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getModContainerClass</h4> +<pre>java.lang.String getModContainerClass()</pre> +<div class="block">Return a class name that implements "ModContainer" for injection into the mod list + The "getName" function should return a name that other mods can, if need be, + depend on. + Trivially, this modcontainer will be loaded before all regular mod containers, + which means it will be forced to be "immutable" - not susceptible to normal + sorting behaviour. + All other mod behaviours are available however- this container can receive and handle + normal loading events</div> +</li> +</ul> +<a name="getSetupClass()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSetupClass</h4> +<pre>java.lang.String getSetupClass()</pre> +<div class="block">Return the class name of an implementor of "IFMLCallHook", that will be run, in the + main thread, to perform any additional setup this coremod may require. It will be + run <strong>prior</strong> to Minecraft starting, so it CANNOT operate on minecraft + itself. The game will deliberately crash if this code is detected to trigger a + minecraft class loading (TODO: implement crash ;) )</div> +</li> +</ul> +<a name="injectData(java.util.Map)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>injectData</h4> +<pre>void injectData(java.util.Map<java.lang.String,java.lang.Object> data)</pre> +<div class="block">Inject coremod data into this coremod + This data includes: + "mcLocation" : the location of the minecraft directory, + "coremodList" : the list of coremods + "coremodLocation" : the file this coremod loaded from,</div> +</li> +</ul> +<a name="getAccessTransformerClass()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getAccessTransformerClass</h4> +<pre>java.lang.String getAccessTransformerClass()</pre> +<div class="block">Return an optional access transformer class for this coremod. It will be injected post-deobf + so ensure your ATs conform to the new srgnames scheme.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the name of an access transformer class or null if none is provided</dd></dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= 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><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">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/relauncher/IFMLCallHook.html" title="interface in cpw.mods.fml.relauncher"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../cpw/mods/fml/relauncher/IFMLLoadingPlugin.DependsOn.html" title="annotation in cpw.mods.fml.relauncher"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?cpw/mods/fml/relauncher/IFMLLoadingPlugin.html" target="_top">Frames</a></li> +<li><a href="IFMLLoadingPlugin.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> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li><a href="#nested_class_summary">Nested</a> | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> |