Upstream/Plan
1
0
Fork 0
mirror of https://github.com/plan-player-analytics/Plan.git synced 2024-11-01 08:20:39 +01:00
Code Issues Projects Releases Wiki Activity
48c4b75b5c
Plan/all/com/djrapitops/plan/PlanVelocity.html
Rsl1122 48c4b75b5c Updated javadocs
2020-10-11 18:01:29 +03:00

480 lines
19 KiB
HTML
Raw Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="fi">
<head>
<!-- Generated by javadoc -->
<title>PlanVelocity (Plan 5.1-SNAPSHOT API)</title>
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="PlanVelocity (Plan 5.1-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<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="../../../com/djrapitops/plan/PlanSystem.html" title="class in com.djrapitops.plan"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../com/djrapitops/plan/PlanVelocityComponent.html" title="interface in com.djrapitops.plan"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?com/djrapitops/plan/PlanVelocity.html" target="_top">Frames</a></li>
<li><a href="PlanVelocity.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#fields.inherited.from.class.com.djrapitops.plugin.VelocityPlugin">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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.djrapitops.plan</div>
<h2 title="Class PlanVelocity" class="title">Class PlanVelocity</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>com.djrapitops.plugin.VelocityPlugin</li>
<li>
<ul class="inheritance">
<li>com.djrapitops.plan.PlanVelocity</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../com/djrapitops/plan/PlanPlugin.html" title="interface in com.djrapitops.plan">PlanPlugin</a>, com.djrapitops.plugin.APFPlugin, com.djrapitops.plugin.IPlugin</dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">PlanVelocity</span>
extends com.djrapitops.plugin.VelocityPlugin
implements <a href="../../../com/djrapitops/plan/PlanPlugin.html" title="interface in com.djrapitops.plan">PlanPlugin</a></pre>
<div class="block">Velocity Main class.
<p>
Based on the PlanBungee class</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.com.djrapitops.plugin.VelocityPlugin">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;com.djrapitops.plugin.VelocityPlugin</h3>
<code>debugLogger, errorHandler, logger, proxy, reloading, runnableFactory, timings</code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../com/djrapitops/plan/PlanVelocity.html#PlanVelocity-com.velocitypowered.api.proxy.ProxyServer-org.slf4j.Logger-java.nio.file.Path-">PlanVelocity</a></span>(com.velocitypowered.api.proxy.ProxyServer&nbsp;proxy,
org.slf4j.Logger&nbsp;slf4jLogger,
java.nio.file.Path&nbsp;dataFolderPath)</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>com.djrapitops.plugin.command.ColorScheme</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/djrapitops/plan/PlanVelocity.html#getColorScheme--">getColorScheme</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.io.InputStream</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/djrapitops/plan/PlanVelocity.html#getResource-java.lang.String-">getResource</a></span>(java.lang.String&nbsp;resource)</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../com/djrapitops/plan/PlanSystem.html" title="class in com.djrapitops.plan">PlanSystem</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/djrapitops/plan/PlanVelocity.html#getSystem--">getSystem</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/djrapitops/plan/PlanVelocity.html#isReloading--">isReloading</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/djrapitops/plan/PlanVelocity.html#onDisable--">onDisable</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/djrapitops/plan/PlanVelocity.html#onEnable--">onEnable</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/djrapitops/plan/PlanVelocity.html#onProxyShutdown-com.velocitypowered.api.event.proxy.ProxyShutdownEvent-">onProxyShutdown</a></span>(com.velocitypowered.api.event.proxy.ProxyShutdownEvent&nbsp;event)</code>&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/djrapitops/plan/PlanVelocity.html#onProxyStart-com.velocitypowered.api.event.proxy.ProxyInitializeEvent-">onProxyStart</a></span>(com.velocitypowered.api.event.proxy.ProxyInitializeEvent&nbsp;event)</code>&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/djrapitops/plan/PlanVelocity.html#onReload--">onReload</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/djrapitops/plan/PlanVelocity.html#registerCommand-com.djrapitops.plan.commands.use.Subcommand-">registerCommand</a></span>(<a href="../../../com/djrapitops/plan/commands/use/Subcommand.html" title="class in com.djrapitops.plan.commands.use">Subcommand</a>&nbsp;command)</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.com.djrapitops.plugin.VelocityPlugin">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;com.djrapitops.plugin.VelocityPlugin</h3>
<code>getDataFolder, getDebugLogger, getErrorHandler, getLogger, getPluginLogger, getProxy, getRunnableFactory, getTimings, getVersion, registerCommand, registerListener, reloadPlugin, setDebugLoggers, setErrorHandlers, setReloading</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.com.djrapitops.plan.PlanPlugin">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;com.djrapitops.plan.<a href="../../../com/djrapitops/plan/PlanPlugin.html" title="interface in com.djrapitops.plan">PlanPlugin</a></h3>
<code><a href="../../../com/djrapitops/plan/PlanPlugin.html#getDataFolder--">getDataFolder</a>, <a href="../../../com/djrapitops/plan/PlanPlugin.html#isSystemEnabled--">isSystemEnabled</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.com.djrapitops.plugin.IPlugin">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;com.djrapitops.plugin.IPlugin</h3>
<code>getDebugLogger, getErrorHandler, getPluginLogger, getRunnableFactory, getTimings, getVersion, registerCommand, reloadPlugin, setDebugLoggers, setErrorHandlers</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="PlanVelocity-com.velocitypowered.api.proxy.ProxyServer-org.slf4j.Logger-java.nio.file.Path-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>PlanVelocity</h4>
<pre>@Inject
public&nbsp;PlanVelocity(com.velocitypowered.api.proxy.ProxyServer&nbsp;proxy,
org.slf4j.Logger&nbsp;slf4jLogger,
java.nio.file.Path&nbsp;dataFolderPath)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="onProxyStart-com.velocitypowered.api.event.proxy.ProxyInitializeEvent-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onProxyStart</h4>
<pre>public&nbsp;void&nbsp;onProxyStart(com.velocitypowered.api.event.proxy.ProxyInitializeEvent&nbsp;event)</pre>
</li>
</ul>
<a name="onProxyShutdown-com.velocitypowered.api.event.proxy.ProxyShutdownEvent-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onProxyShutdown</h4>
<pre>public&nbsp;void&nbsp;onProxyShutdown(com.velocitypowered.api.event.proxy.ProxyShutdownEvent&nbsp;event)</pre>
</li>
</ul>
<a name="onEnable--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onEnable</h4>
<pre>public&nbsp;void&nbsp;onEnable()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>onEnable</code>&nbsp;in interface&nbsp;<code>com.djrapitops.plugin.IPlugin</code></dd>
</dl>
</li>
</ul>
<a name="onDisable--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onDisable</h4>
<pre>public&nbsp;void&nbsp;onDisable()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>onDisable</code>&nbsp;in interface&nbsp;<code>com.djrapitops.plugin.IPlugin</code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>onDisable</code>&nbsp;in class&nbsp;<code>com.djrapitops.plugin.VelocityPlugin</code></dd>
</dl>
</li>
</ul>
<a name="onReload--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onReload</h4>
<pre>public&nbsp;void&nbsp;onReload()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>onReload</code>&nbsp;in interface&nbsp;<code>com.djrapitops.plugin.IPlugin</code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>onReload</code>&nbsp;in class&nbsp;<code>com.djrapitops.plugin.VelocityPlugin</code></dd>
</dl>
</li>
</ul>
<a name="registerCommand-com.djrapitops.plan.commands.use.Subcommand-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>registerCommand</h4>
<pre>public&nbsp;void&nbsp;registerCommand(<a href="../../../com/djrapitops/plan/commands/use/Subcommand.html" title="class in com.djrapitops.plan.commands.use">Subcommand</a>&nbsp;command)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../com/djrapitops/plan/PlanPlugin.html#registerCommand-com.djrapitops.plan.commands.use.Subcommand-">registerCommand</a></code>&nbsp;in interface&nbsp;<code><a href="../../../com/djrapitops/plan/PlanPlugin.html" title="interface in com.djrapitops.plan">PlanPlugin</a></code></dd>
</dl>
</li>
</ul>
<a name="getResource-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getResource</h4>
<pre>public&nbsp;java.io.InputStream&nbsp;getResource(java.lang.String&nbsp;resource)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../com/djrapitops/plan/PlanPlugin.html#getResource-java.lang.String-">getResource</a></code>&nbsp;in interface&nbsp;<code><a href="../../../com/djrapitops/plan/PlanPlugin.html" title="interface in com.djrapitops.plan">PlanPlugin</a></code></dd>
</dl>
</li>
</ul>
<a name="getColorScheme--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getColorScheme</h4>
<pre>public&nbsp;com.djrapitops.plugin.command.ColorScheme&nbsp;getColorScheme()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../com/djrapitops/plan/PlanPlugin.html#getColorScheme--">getColorScheme</a></code>&nbsp;in interface&nbsp;<code><a href="../../../com/djrapitops/plan/PlanPlugin.html" title="interface in com.djrapitops.plan">PlanPlugin</a></code></dd>
</dl>
</li>
</ul>
<a name="getSystem--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSystem</h4>
<pre>public&nbsp;<a href="../../../com/djrapitops/plan/PlanSystem.html" title="class in com.djrapitops.plan">PlanSystem</a>&nbsp;getSystem()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../com/djrapitops/plan/PlanPlugin.html#getSystem--">getSystem</a></code>&nbsp;in interface&nbsp;<code><a href="../../../com/djrapitops/plan/PlanPlugin.html" title="interface in com.djrapitops.plan">PlanPlugin</a></code></dd>
</dl>
</li>
</ul>
<a name="isReloading--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>isReloading</h4>
<pre>public&nbsp;boolean&nbsp;isReloading()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../com/djrapitops/plan/PlanPlugin.html#isReloading--">isReloading</a></code>&nbsp;in interface&nbsp;<code><a href="../../../com/djrapitops/plan/PlanPlugin.html" title="interface in com.djrapitops.plan">PlanPlugin</a></code></dd>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>isReloading</code>&nbsp;in interface&nbsp;<code>com.djrapitops.plugin.IPlugin</code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>isReloading</code>&nbsp;in class&nbsp;<code>com.djrapitops.plugin.VelocityPlugin</code></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>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<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="../../../com/djrapitops/plan/PlanSystem.html" title="class in com.djrapitops.plan"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../com/djrapitops/plan/PlanVelocityComponent.html" title="interface in com.djrapitops.plan"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?com/djrapitops/plan/PlanVelocity.html" target="_top">Frames</a></li>
<li><a href="PlanVelocity.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#fields.inherited.from.class.com.djrapitops.plugin.VelocityPlugin">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink