mirror of
https://github.com/dmulloy2/ProtocolLib.git
synced 2024-11-25 03:55:34 +01:00
405 lines
14 KiB
HTML
405 lines
14 KiB
HTML
<!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_07) on Thu Jan 10 00:56:14 CET 2013 -->
|
|
<title>ProtocolLibrary</title>
|
|
<meta name="date" content="2013-01-10">
|
|
<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="ProtocolLibrary";
|
|
}
|
|
//-->
|
|
</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="class-use/ProtocolLibrary.html">Use</a></li>
|
|
<li><a href="package-tree.html">Tree</a></li>
|
|
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
|
|
<li><a href="../../../index-files/index-1.html">Index</a></li>
|
|
<li><a href="../../../help-doc.html">Help</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="subNav">
|
|
<ul class="navList">
|
|
<li><a href="../../../com/comphenix/protocol/PacketStream.html" title="interface in com.comphenix.protocol"><span class="strong">Prev Class</span></a></li>
|
|
<li><a href="../../../com/comphenix/protocol/ProtocolManager.html" title="interface in com.comphenix.protocol"><span class="strong">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../../../index.html?com/comphenix/protocol/ProtocolLibrary.html" target="_top">Frames</a></li>
|
|
<li><a href="ProtocolLibrary.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>Nested | </li>
|
|
<li>Field | </li>
|
|
<li><a href="#constructor_summary">Constr</a> | </li>
|
|
<li><a href="#method_summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li><a href="#constructor_detail">Constr</a> | </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">com.comphenix.protocol</div>
|
|
<h2 title="Class ProtocolLibrary" class="title">Class ProtocolLibrary</h2>
|
|
</div>
|
|
<div class="contentContainer">
|
|
<ul class="inheritance">
|
|
<li>java.lang.Object</li>
|
|
<li>
|
|
<ul class="inheritance">
|
|
<li>org.bukkit.plugin.PluginBase</li>
|
|
<li>
|
|
<ul class="inheritance">
|
|
<li>org.bukkit.plugin.java.JavaPlugin</li>
|
|
<li>
|
|
<ul class="inheritance">
|
|
<li>com.comphenix.protocol.ProtocolLibrary</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<div class="description">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<dl>
|
|
<dt>All Implemented Interfaces:</dt>
|
|
<dd>org.bukkit.command.CommandExecutor, org.bukkit.command.TabCompleter, org.bukkit.command.TabExecutor, org.bukkit.plugin.Plugin</dd>
|
|
</dl>
|
|
<hr>
|
|
<br>
|
|
<pre>public class <span class="strong">ProtocolLibrary</span>
|
|
extends org.bukkit.plugin.java.JavaPlugin</pre>
|
|
<div class="block">The main entry point for ProtocolLib.</div>
|
|
<dl><dt><span class="strong">Author:</span></dt>
|
|
<dd>Kristian</dd></dl>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="summary">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="constructor_summary">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Constructor Summary</h3>
|
|
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
|
|
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
|
|
<tr>
|
|
<th class="colOne" scope="col">Constructor and Description</th>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colOne"><code><strong><a href="../../../com/comphenix/protocol/ProtocolLibrary.html#ProtocolLibrary()">ProtocolLibrary</a></strong>()</code> </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>static <a href="../../../com/comphenix/protocol/error/ErrorReporter.html" title="interface in com.comphenix.protocol.error">ErrorReporter</a></code></td>
|
|
<td class="colLast"><code><strong><a href="../../../com/comphenix/protocol/ProtocolLibrary.html#getErrorReporter()">getErrorReporter</a></strong>()</code>
|
|
<div class="block">Retrieve the current error reporter.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static <a href="../../../com/comphenix/protocol/ProtocolManager.html" title="interface in com.comphenix.protocol">ProtocolManager</a></code></td>
|
|
<td class="colLast"><code><strong><a href="../../../com/comphenix/protocol/ProtocolLibrary.html#getProtocolManager()">getProtocolManager</a></strong>()</code>
|
|
<div class="block">Retrieves the packet protocol manager.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code><a href="../../../com/comphenix/protocol/metrics/Statistics.html" title="class in com.comphenix.protocol.metrics">Statistics</a></code></td>
|
|
<td class="colLast"><code><strong><a href="../../../com/comphenix/protocol/ProtocolLibrary.html#getStatistics()">getStatistics</a></strong>()</code>
|
|
<div class="block">Retrieve the metrics instance used to measure users of this library.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../com/comphenix/protocol/ProtocolLibrary.html#onDisable()">onDisable</a></strong>()</code> </td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../com/comphenix/protocol/ProtocolLibrary.html#onEnable()">onEnable</a></strong>()</code> </td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../com/comphenix/protocol/ProtocolLibrary.html#onLoad()">onLoad</a></strong>()</code> </td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../com/comphenix/protocol/ProtocolLibrary.html#reloadConfig()">reloadConfig</a></strong>()</code> </td>
|
|
</tr>
|
|
</table>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="methods_inherited_from_class_org.bukkit.plugin.java.JavaPlugin">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Methods inherited from class org.bukkit.plugin.java.JavaPlugin</h3>
|
|
<code>getClassLoader, getCommand, getConfig, getDatabase, getDatabaseClasses, getDataFolder, getDefaultWorldGenerator, getDescription, getFile, getLogger, getPluginLoader, getResource, getServer, initialize, installDDL, isEnabled, isInitialized, isNaggable, onCommand, onTabComplete, removeDDL, saveConfig, saveDefaultConfig, saveResource, setEnabled, setNaggable, toString</code></li>
|
|
</ul>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="methods_inherited_from_class_org.bukkit.plugin.PluginBase">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Methods inherited from class org.bukkit.plugin.PluginBase</h3>
|
|
<code>equals, getName, hashCode</code></li>
|
|
</ul>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Methods inherited from class java.lang.Object</h3>
|
|
<code>clone, finalize, getClass, notify, notifyAll, wait, wait, wait</code></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="details">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="constructor_detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Constructor Detail</h3>
|
|
<a name="ProtocolLibrary()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>ProtocolLibrary</h4>
|
|
<pre>public ProtocolLibrary()</pre>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="method_detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Method Detail</h3>
|
|
<a name="onLoad()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>onLoad</h4>
|
|
<pre>public void onLoad()</pre>
|
|
<dl>
|
|
<dt><strong>Specified by:</strong></dt>
|
|
<dd><code>onLoad</code> in interface <code>org.bukkit.plugin.Plugin</code></dd>
|
|
<dt><strong>Overrides:</strong></dt>
|
|
<dd><code>onLoad</code> in class <code>org.bukkit.plugin.java.JavaPlugin</code></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="reloadConfig()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>reloadConfig</h4>
|
|
<pre>public void reloadConfig()</pre>
|
|
<dl>
|
|
<dt><strong>Specified by:</strong></dt>
|
|
<dd><code>reloadConfig</code> in interface <code>org.bukkit.plugin.Plugin</code></dd>
|
|
<dt><strong>Overrides:</strong></dt>
|
|
<dd><code>reloadConfig</code> in class <code>org.bukkit.plugin.java.JavaPlugin</code></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="onEnable()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>onEnable</h4>
|
|
<pre>public void onEnable()</pre>
|
|
<dl>
|
|
<dt><strong>Specified by:</strong></dt>
|
|
<dd><code>onEnable</code> in interface <code>org.bukkit.plugin.Plugin</code></dd>
|
|
<dt><strong>Overrides:</strong></dt>
|
|
<dd><code>onEnable</code> in class <code>org.bukkit.plugin.java.JavaPlugin</code></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="onDisable()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>onDisable</h4>
|
|
<pre>public void onDisable()</pre>
|
|
<dl>
|
|
<dt><strong>Specified by:</strong></dt>
|
|
<dd><code>onDisable</code> in interface <code>org.bukkit.plugin.Plugin</code></dd>
|
|
<dt><strong>Overrides:</strong></dt>
|
|
<dd><code>onDisable</code> in class <code>org.bukkit.plugin.java.JavaPlugin</code></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getErrorReporter()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getErrorReporter</h4>
|
|
<pre>public static <a href="../../../com/comphenix/protocol/error/ErrorReporter.html" title="interface in com.comphenix.protocol.error">ErrorReporter</a> getErrorReporter()</pre>
|
|
<div class="block">Retrieve the current error reporter.</div>
|
|
<dl><dt><span class="strong">Returns:</span></dt><dd>Current error reporter.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getProtocolManager()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getProtocolManager</h4>
|
|
<pre>public static <a href="../../../com/comphenix/protocol/ProtocolManager.html" title="interface in com.comphenix.protocol">ProtocolManager</a> getProtocolManager()</pre>
|
|
<div class="block">Retrieves the packet protocol manager.</div>
|
|
<dl><dt><span class="strong">Returns:</span></dt><dd>Packet protocol manager, or NULL if it has been disabled.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getStatistics()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>getStatistics</h4>
|
|
<pre>public <a href="../../../com/comphenix/protocol/metrics/Statistics.html" title="class in com.comphenix.protocol.metrics">Statistics</a> getStatistics()</pre>
|
|
<div class="block">Retrieve the metrics instance used to measure users of this library.
|
|
<p>
|
|
Note that this method may return NULL when the server is reloading or shutting down. It is also
|
|
NULL if metrics has been disabled.</div>
|
|
<dl><dt><span class="strong">Returns:</span></dt><dd>Metrics instance container.</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="class-use/ProtocolLibrary.html">Use</a></li>
|
|
<li><a href="package-tree.html">Tree</a></li>
|
|
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
|
|
<li><a href="../../../index-files/index-1.html">Index</a></li>
|
|
<li><a href="../../../help-doc.html">Help</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="subNav">
|
|
<ul class="navList">
|
|
<li><a href="../../../com/comphenix/protocol/PacketStream.html" title="interface in com.comphenix.protocol"><span class="strong">Prev Class</span></a></li>
|
|
<li><a href="../../../com/comphenix/protocol/ProtocolManager.html" title="interface in com.comphenix.protocol"><span class="strong">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../../../index.html?com/comphenix/protocol/ProtocolLibrary.html" target="_top">Frames</a></li>
|
|
<li><a href="ProtocolLibrary.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>Nested | </li>
|
|
<li>Field | </li>
|
|
<li><a href="#constructor_summary">Constr</a> | </li>
|
|
<li><a href="#method_summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li><a href="#constructor_detail">Constr</a> | </li>
|
|
<li><a href="#method_detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
<a name="skip-navbar_bottom">
|
|
<!-- -->
|
|
</a></div>
|
|
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|
</body>
|
|
</html>
|