diff options
| author | Foghrye4 <foghrye4@gmail.com> | 2017-08-10 18:52:45 +0300 |
|---|---|---|
| committer | Foghrye4 <foghrye4@gmail.com> | 2017-08-10 18:52:45 +0300 |
| commit | 0427ab89f1753a44b30cbc35ce021cbbdc845109 (patch) | |
| tree | abe418ff5ec174e712fe8dedd434548a945b15a3 /javadoc/cpw/mods/fml/common/SidedProxy.html | |
| parent | 877312184c472d9845e5ef1008bc538f4634059f (diff) | |
fix missing source folder
Diffstat (limited to 'javadoc/cpw/mods/fml/common/SidedProxy.html')
| -rw-r--r-- | javadoc/cpw/mods/fml/common/SidedProxy.html | 270 |
1 files changed, 270 insertions, 0 deletions
diff --git a/javadoc/cpw/mods/fml/common/SidedProxy.html b/javadoc/cpw/mods/fml/common/SidedProxy.html new file mode 100644 index 0000000..b382668 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/SidedProxy.html @@ -0,0 +1,270 @@ +<!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:16 EST 2015 --> +<title>SidedProxy (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="SidedProxy (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/common/SaveInspectionHandler.html" title="annotation in cpw.mods.fml.common"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../cpw/mods/fml/common/StartupQuery.html" title="class in cpw.mods.fml.common"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?cpw/mods/fml/common/SidedProxy.html" target="_top">Frames</a></li> +<li><a href="SidedProxy.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>Required | </li> +<li><a href="#annotation_type_optional_element_summary">Optional</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#annotation_type_element_detail">Element</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.common</div> +<h2 title="Annotation Type SidedProxy" class="title">Annotation Type SidedProxy</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>@Retention(value=RUNTIME) +@Target(value=FIELD) +public @interface <span class="strong">SidedProxy</span></pre> +<div class="block">Sided proxies are loaded based on the specific environment they find themselves loaded into. + They are used to ensure that client-specific code (such as GUIs) is only loaded into the game + on the client side. + It is applied to static fields of a class, anywhere in your mod code. FML will scan + and load any classes with this annotation at mod construction time. + + <p> + This example will load a CommonProxy on the server side, and a ClientProxy on the client side. + + <pre><code>public class MySidedProxyHolder { + {@literal @}SidedProxy(modId="MyModId",clientSide="mymod.ClientProxy", serverSide="mymod.CommonProxy") + public static CommonProxy proxy; + } + + public class CommonProxy { + // Common or server stuff here that needs to be overridden on the client + } + + public class ClientProxy extends CommonProxy { + // Override common stuff with client specific stuff here + } + </code> + </pre></div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="annotation_type_optional_element_summary"> +<!-- --> +</a> +<h3>Optional Element Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation"> +<caption><span>Optional Elements</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Optional Element 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/common/SidedProxy.html#clientSide()">clientSide</a></strong></code> +<div class="block">The name of the client side class to load and populate</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/common/SidedProxy.html#modId()">modId</a></strong></code> +<div class="block">The (optional) name of a mod to load this proxy for.</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/common/SidedProxy.html#serverSide()">serverSide</a></strong></code> +<div class="block">The name of the server side class to load and populate</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="annotation_type_element_detail"> +<!-- --> +</a> +<h3>Element Detail</h3> +<a name="clientSide()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>clientSide</h4> +<pre>public abstract java.lang.String clientSide</pre> +<div class="block">The name of the client side class to load and populate</div> +<dl> +<dt>Default:</dt> +<dd>""</dd> +</dl> +</li> +</ul> +<a name="serverSide()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>serverSide</h4> +<pre>public abstract java.lang.String serverSide</pre> +<div class="block">The name of the server side class to load and populate</div> +<dl> +<dt>Default:</dt> +<dd>""</dd> +</dl> +</li> +</ul> +<a name="modId()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>modId</h4> +<pre>public abstract java.lang.String modId</pre> +<div class="block">The (optional) name of a mod to load this proxy for. This will help ensure correct behaviour when loading a combined + scala/java mod package. It is almost never going to be required, unless you ship both Scala and Java <a href="../../../../cpw/mods/fml/common/Mod.html" title="annotation in cpw.mods.fml.common"><code>Mod</code></a> content + in a single jar.</div> +<dl> +<dt>Default:</dt> +<dd>""</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/common/SaveInspectionHandler.html" title="annotation in cpw.mods.fml.common"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../cpw/mods/fml/common/StartupQuery.html" title="class in cpw.mods.fml.common"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?cpw/mods/fml/common/SidedProxy.html" target="_top">Frames</a></li> +<li><a href="SidedProxy.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>Required | </li> +<li><a href="#annotation_type_optional_element_summary">Optional</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#annotation_type_element_detail">Element</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> |
