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/BukkitPluginRef.html | |
| parent | 1da8dcd58647e34c9af94ceeecaeaf3b0d08c48c (diff) | |
full project files
Diffstat (limited to 'javadoc/cpw/mods/fml/common/BukkitPluginRef.html')
| -rw-r--r-- | javadoc/cpw/mods/fml/common/BukkitPluginRef.html | 210 |
1 files changed, 210 insertions, 0 deletions
diff --git a/javadoc/cpw/mods/fml/common/BukkitPluginRef.html b/javadoc/cpw/mods/fml/common/BukkitPluginRef.html new file mode 100644 index 0000000..beeec51 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/BukkitPluginRef.html @@ -0,0 +1,210 @@ +<!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>BukkitPluginRef (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="BukkitPluginRef (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/API.html" title="annotation in cpw.mods.fml.common"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../cpw/mods/fml/common/BukkitProxy.html" title="interface 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/BukkitPluginRef.html" target="_top">Frames</a></li> +<li><a href="BukkitPluginRef.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="#annotation_type_required_element_summary">Required</a> | </li> +<li>Optional</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 BukkitPluginRef" class="title">Annotation Type BukkitPluginRef</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">BukkitPluginRef</span></pre> +<div class="block">Declare a variable to be populated by a Bukkit Plugin proxy instance if the bukkit coremod + is available. It can only be applied to field typed as <a href="../../../../cpw/mods/fml/common/BukkitProxy.html" title="interface in cpw.mods.fml.common"><code>BukkitProxy</code></a> + Generally it should be used in conjunction with <a href="../../../../cpw/mods/fml/common/Mod.html#bukkitPlugin()"><code>Mod.bukkitPlugin()</code></a> specifying the + plugin to load.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== ANNOTATION TYPE REQUIRED MEMBER SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="annotation_type_required_element_summary"> +<!-- --> +</a> +<h3>Required Element Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Required Element Summary table, listing required elements, and an explanation"> +<caption><span>Required Elements</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Required 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/BukkitPluginRef.html#value()">value</a></strong></code> +<div class="block">A reference (possibly version specific) to a Bukkit Plugin by name, using the name@versionbound + specification.</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="value()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>value</h4> +<pre>public abstract java.lang.String value</pre> +<div class="block">A reference (possibly version specific) to a Bukkit Plugin by name, using the name@versionbound + specification. If this is a bukkit enabled environment the field annotated by this + will be populated with a <a href="../../../../cpw/mods/fml/common/BukkitProxy.html" title="interface in cpw.mods.fml.common"><code>BukkitProxy</code></a> instance if possible. This proxy will be gotten by + reflectively calling the "getModProxy" method on the bukkit plugin instance.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The name of the plugin which we will inject into this field</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/API.html" title="annotation in cpw.mods.fml.common"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../cpw/mods/fml/common/BukkitProxy.html" title="interface 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/BukkitPluginRef.html" target="_top">Frames</a></li> +<li><a href="BukkitPluginRef.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="#annotation_type_required_element_summary">Required</a> | </li> +<li>Optional</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> |
