mirror of
https://github.com/plan-player-analytics/Plan.git
synced 2024-12-29 20:48:01 +01:00
626 lines
27 KiB
HTML
626 lines
27 KiB
HTML
|
<!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 (1.8.0_112) on Sun May 14 15:04:21 EEST 2017 -->
|
||
|
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||
|
|
<title>Plan (Plan 3.1.1 API)</title>
|
||
|
|
<meta name="date" content="2017-05-14">
|
||
|
|
<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="Plan (Plan 3.1.1 API)";
|
||
|
|
}
|
||
|
|
}
|
||
|
|
catch(err) {
|
||
|
|
}
|
||
|
|
//-->
|
||
|
|
var methods = {"i0":10,"i1":42,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":9,"i9":9,"i10":10,"i11":10,"i12":10,"i13":10,"i14":9};
|
||
|
|
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated 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="class-use/Plan.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-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="../../../../../main/java/com/djrapitops/plan/Phrase.html" title="enum in main.java.com.djrapitops.plan"><span class="typeNameLink">Prev Class</span></a></li>
|
||
|
|
<li><a href="../../../../../main/java/com/djrapitops/plan/Settings.html" title="enum in main.java.com.djrapitops.plan"><span class="typeNameLink">Next Class</span></a></li>
|
||
|
|
</ul>
|
||
|
|
<ul class="navList">
|
||
|
|
<li><a href="../../../../../index.html?main/java/com/djrapitops/plan/Plan.html" target="_top">Frames</a></li>
|
||
|
|
<li><a href="Plan.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">main.java.com.djrapitops.plan</div>
|
||
|
|
<h2 title="Class Plan" class="title">Class Plan</h2>
|
||
|
|
</div>
|
||
|
|
<div class="contentContainer">
|
||
|
|
<ul class="inheritance">
|
||
|
|
<li><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></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>main.java.com.djrapitops.plan.Plan</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="typeNameLabel">Plan</span>
|
||
|
|
extends org.bukkit.plugin.java.JavaPlugin</pre>
|
||
|
|
<div class="block">Javaplugin class that contains methods for starting the plugin, logging to
|
||
|
|
the Bukkit console and various get methods.</div>
|
||
|
|
<dl>
|
||
|
|
<dt><span class="simpleTagLabel">Since:</span></dt>
|
||
|
|
<dd>1.0.0</dd>
|
||
|
|
<dt><span class="simpleTagLabel">Author:</span></dt>
|
||
|
|
<dd>Rsl1122</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="memberSummary" 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><span class="memberNameLink"><a href="../../../../../main/java/com/djrapitops/plan/Plan.html#Plan--">Plan</a></span>()</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="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"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd"> </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><a href="../../../../../main/java/com/djrapitops/plan/data/cache/AnalysisCacheHandler.html" title="class in main.java.com.djrapitops.plan.data.cache">AnalysisCacheHandler</a></code></td>
|
||
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../main/java/com/djrapitops/plan/Plan.html#getAnalysisCache--">getAnalysisCache</a></span>()</code>
|
||
|
|
<div class="block">Used to access AnalysisCache.</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr id="i1" class="rowColor">
|
||
|
|
<td class="colFirst"><code><a href="../../../../../main/java/com/djrapitops/plan/api/API.html" title="class in main.java.com.djrapitops.plan.api">API</a></code></td>
|
||
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../main/java/com/djrapitops/plan/Plan.html#getAPI--">getAPI</a></span>()</code>
|
||
|
|
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
|
||
|
|
<div class="block"><span class="deprecationComment">Use Plan.getAPI() (static method) instead.</span></div>
|
||
|
|
</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr id="i2" class="altColor">
|
||
|
|
<td class="colFirst"><code>int</code></td>
|
||
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../main/java/com/djrapitops/plan/Plan.html#getBootAnalysisTaskID--">getBootAnalysisTaskID</a></span>()</code>
|
||
|
|
<div class="block">Used to get the ID of the BootAnalysisTask, so that it can be disabled.</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr id="i3" class="rowColor">
|
||
|
|
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/HashSet.html?is-external=true" title="class or interface in java.util">HashSet</a><<a href="../../../../../main/java/com/djrapitops/plan/database/Database.html" title="class in main.java.com.djrapitops.plan.database">Database</a>></code></td>
|
||
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../main/java/com/djrapitops/plan/Plan.html#getDatabases--">getDatabases</a></span>()</code>
|
||
|
|
<div class="block">Used to get all possible database objects.</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr id="i4" class="altColor">
|
||
|
|
<td class="colFirst"><code><a href="../../../../../main/java/com/djrapitops/plan/database/Database.html" title="class in main.java.com.djrapitops.plan.database">Database</a></code></td>
|
||
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../main/java/com/djrapitops/plan/Plan.html#getDB--">getDB</a></span>()</code>
|
||
|
|
<div class="block">Used to access active Database.</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr id="i5" class="rowColor">
|
||
|
|
<td class="colFirst"><code><a href="../../../../../main/java/com/djrapitops/plan/data/cache/DataCacheHandler.html" title="class in main.java.com.djrapitops.plan.data.cache">DataCacheHandler</a></code></td>
|
||
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../main/java/com/djrapitops/plan/Plan.html#getHandler--">getHandler</a></span>()</code>
|
||
|
|
<div class="block">Used to access Cache.</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr id="i6" class="altColor">
|
||
|
|
<td class="colFirst"><code><a href="../../../../../main/java/com/djrapitops/plan/data/additional/HookHandler.html" title="class in main.java.com.djrapitops.plan.data.additional">HookHandler</a></code></td>
|
||
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../main/java/com/djrapitops/plan/Plan.html#getHookHandler--">getHookHandler</a></span>()</code>
|
||
|
|
<div class="block">Used to access HookHandler.</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr id="i7" class="rowColor">
|
||
|
|
<td class="colFirst"><code><a href="../../../../../main/java/com/djrapitops/plan/data/cache/InspectCacheHandler.html" title="class in main.java.com.djrapitops.plan.data.cache">InspectCacheHandler</a></code></td>
|
||
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../main/java/com/djrapitops/plan/Plan.html#getInspectCache--">getInspectCache</a></span>()</code>
|
||
|
|
<div class="block">Used to access InspectCache.</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr id="i8" class="altColor">
|
||
|
|
<td class="colFirst"><code>static <a href="../../../../../main/java/com/djrapitops/plan/Plan.html" title="class in main.java.com.djrapitops.plan">Plan</a></code></td>
|
||
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../main/java/com/djrapitops/plan/Plan.html#getInstance--">getInstance</a></span>()</code>
|
||
|
|
<div class="block">Used to get the current instance of Plan.</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr id="i9" class="rowColor">
|
||
|
|
<td class="colFirst"><code>static <a href="../../../../../main/java/com/djrapitops/plan/api/API.html" title="class in main.java.com.djrapitops.plan.api">API</a></code></td>
|
||
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../main/java/com/djrapitops/plan/Plan.html#getPlanAPI--">getPlanAPI</a></span>()</code>
|
||
|
|
<div class="block">Used to get the PlanAPI.</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr id="i10" class="altColor">
|
||
|
|
<td class="colFirst"><code><a href="../../../../../main/java/com/djrapitops/plan/ui/webserver/WebSocketServer.html" title="class in main.java.com.djrapitops.plan.ui.webserver">WebSocketServer</a></code></td>
|
||
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../main/java/com/djrapitops/plan/Plan.html#getUiServer--">getUiServer</a></span>()</code>
|
||
|
|
<div class="block">Used to access Webserver.</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr id="i11" class="rowColor">
|
||
|
|
<td class="colFirst"><code>boolean</code></td>
|
||
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../main/java/com/djrapitops/plan/Plan.html#initDatabase--">initDatabase</a></span>()</code>
|
||
|
|
<div class="block">Initializes the database according to settings in the config.</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr id="i12" class="altColor">
|
||
|
|
<td class="colFirst"><code>void</code></td>
|
||
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../main/java/com/djrapitops/plan/Plan.html#onDisable--">onDisable</a></span>()</code>
|
||
|
|
<div class="block">Disables the plugin.</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr id="i13" class="rowColor">
|
||
|
|
<td class="colFirst"><code>void</code></td>
|
||
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../main/java/com/djrapitops/plan/Plan.html#onEnable--">onEnable</a></span>()</code>
|
||
|
|
<div class="block">OnEnable method.</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr id="i14" class="altColor">
|
||
|
|
<td class="colFirst"><code>static void</code></td>
|
||
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../main/java/com/djrapitops/plan/Plan.html#setInstance-main.java.com.djrapitops.plan.Plan-">setInstance</a></span>(<a href="../../../../../main/java/com/djrapitops/plan/Plan.html" title="class in main.java.com.djrapitops.plan">Plan</a> plan)</code>
|
||
|
|
<div class="block">Used to set the current instance of Plan.</div>
|
||
|
|
</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, getPlugin, getPluginLoader, getProvidingPlugin, getResource, getServer, getTextResource, installDDL, isEnabled, isNaggable, onCommand, onLoad, onTabComplete, reloadConfig, 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.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
|
||
|
|
<code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></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="Plan--">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockListLast">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>Plan</h4>
|
||
|
|
<pre>public Plan()</pre>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<!-- ============ METHOD DETAIL ========== -->
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList"><a name="method.detail">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<h3>Method Detail</h3>
|
||
|
|
<a name="onEnable--">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>onEnable</h4>
|
||
|
|
<pre>public void onEnable()</pre>
|
||
|
|
<div class="block">OnEnable method.
|
||
|
|
|
||
|
|
Creates the config file. Checks for new version. Initializes Database.
|
||
|
|
Hooks to Supported plugins. Initializes DataCaches. Registers Listeners.
|
||
|
|
Registers Command /plan and initializes API. Enables Webserver and
|
||
|
|
analysis tasks if enabled in config. Warns about possible mistakes made
|
||
|
|
in config.</div>
|
||
|
|
<dl>
|
||
|
|
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
||
|
|
<dd><code>onEnable</code> in interface <code>org.bukkit.plugin.Plugin</code></dd>
|
||
|
|
<dt><span class="overrideSpecifyLabel">Overrides:</span></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>
|
||
|
|
<div class="block">Disables the plugin.
|
||
|
|
|
||
|
|
Stops the webserver, cancels all tasks and saves cache to the database.</div>
|
||
|
|
<dl>
|
||
|
|
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
||
|
|
<dd><code>onDisable</code> in interface <code>org.bukkit.plugin.Plugin</code></dd>
|
||
|
|
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
|
||
|
|
<dd><code>onDisable</code> in class <code>org.bukkit.plugin.java.JavaPlugin</code></dd>
|
||
|
|
</dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="initDatabase--">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>initDatabase</h4>
|
||
|
|
<pre>public boolean initDatabase()</pre>
|
||
|
|
<div class="block">Initializes the database according to settings in the config.
|
||
|
|
|
||
|
|
If database connection can not be established plugin is disabled.</div>
|
||
|
|
<dl>
|
||
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
||
|
|
<dd>true if init was successful, false if not.</dd>
|
||
|
|
</dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="getAnalysisCache--">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>getAnalysisCache</h4>
|
||
|
|
<pre>public <a href="../../../../../main/java/com/djrapitops/plan/data/cache/AnalysisCacheHandler.html" title="class in main.java.com.djrapitops.plan.data.cache">AnalysisCacheHandler</a> getAnalysisCache()</pre>
|
||
|
|
<div class="block">Used to access AnalysisCache.</div>
|
||
|
|
<dl>
|
||
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
||
|
|
<dd>Current instance of the AnalysisCacheHandler</dd>
|
||
|
|
</dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="getInspectCache--">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>getInspectCache</h4>
|
||
|
|
<pre>public <a href="../../../../../main/java/com/djrapitops/plan/data/cache/InspectCacheHandler.html" title="class in main.java.com.djrapitops.plan.data.cache">InspectCacheHandler</a> getInspectCache()</pre>
|
||
|
|
<div class="block">Used to access InspectCache.</div>
|
||
|
|
<dl>
|
||
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
||
|
|
<dd>Current instance of the InspectCacheHandler</dd>
|
||
|
|
</dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="getHandler--">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>getHandler</h4>
|
||
|
|
<pre>public <a href="../../../../../main/java/com/djrapitops/plan/data/cache/DataCacheHandler.html" title="class in main.java.com.djrapitops.plan.data.cache">DataCacheHandler</a> getHandler()</pre>
|
||
|
|
<div class="block">Used to access Cache.</div>
|
||
|
|
<dl>
|
||
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
||
|
|
<dd>Current instance of the DataCacheHandler</dd>
|
||
|
|
</dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="getDB--">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>getDB</h4>
|
||
|
|
<pre>public <a href="../../../../../main/java/com/djrapitops/plan/database/Database.html" title="class in main.java.com.djrapitops.plan.database">Database</a> getDB()</pre>
|
||
|
|
<div class="block">Used to access active Database.</div>
|
||
|
|
<dl>
|
||
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
||
|
|
<dd>the Current Database</dd>
|
||
|
|
</dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="getUiServer--">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>getUiServer</h4>
|
||
|
|
<pre>public <a href="../../../../../main/java/com/djrapitops/plan/ui/webserver/WebSocketServer.html" title="class in main.java.com.djrapitops.plan.ui.webserver">WebSocketServer</a> getUiServer()</pre>
|
||
|
|
<div class="block">Used to access Webserver.</div>
|
||
|
|
<dl>
|
||
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
||
|
|
<dd>the Webserver</dd>
|
||
|
|
</dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="getHookHandler--">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>getHookHandler</h4>
|
||
|
|
<pre>public <a href="../../../../../main/java/com/djrapitops/plan/data/additional/HookHandler.html" title="class in main.java.com.djrapitops.plan.data.additional">HookHandler</a> getHookHandler()</pre>
|
||
|
|
<div class="block">Used to access HookHandler.</div>
|
||
|
|
<dl>
|
||
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
||
|
|
<dd>HookHandler that manages Hooks to other plugins.</dd>
|
||
|
|
</dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="getDatabases--">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>getDatabases</h4>
|
||
|
|
<pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/util/HashSet.html?is-external=true" title="class or interface in java.util">HashSet</a><<a href="../../../../../main/java/com/djrapitops/plan/database/Database.html" title="class in main.java.com.djrapitops.plan.database">Database</a>> getDatabases()</pre>
|
||
|
|
<div class="block">Used to get all possible database objects.
|
||
|
|
|
||
|
|
#init() might need to be called in order for the object to function.</div>
|
||
|
|
<dl>
|
||
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
||
|
|
<dd>Set containing the SqLite and MySQL objects.</dd>
|
||
|
|
</dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="getBootAnalysisTaskID--">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>getBootAnalysisTaskID</h4>
|
||
|
|
<pre>public int getBootAnalysisTaskID()</pre>
|
||
|
|
<div class="block">Used to get the ID of the BootAnalysisTask, so that it can be disabled.</div>
|
||
|
|
<dl>
|
||
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
||
|
|
<dd>ID of the bootAnalysisTask</dd>
|
||
|
|
</dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="getAPI--">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>getAPI</h4>
|
||
|
|
<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
|
||
|
|
public <a href="../../../../../main/java/com/djrapitops/plan/api/API.html" title="class in main.java.com.djrapitops.plan.api">API</a> getAPI()</pre>
|
||
|
|
<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">Use Plan.getAPI() (static method) instead.</span></div>
|
||
|
|
<div class="block">Old method for getting the API.</div>
|
||
|
|
<dl>
|
||
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
||
|
|
<dd>the Plan API.</dd>
|
||
|
|
</dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="getInstance--">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>getInstance</h4>
|
||
|
|
<pre>public static <a href="../../../../../main/java/com/djrapitops/plan/Plan.html" title="class in main.java.com.djrapitops.plan">Plan</a> getInstance()</pre>
|
||
|
|
<div class="block">Used to get the current instance of Plan.
|
||
|
|
|
||
|
|
Instance is set on the first line of onEnable method.</div>
|
||
|
|
<dl>
|
||
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
||
|
|
<dd>current instance of Plan, Singleton.</dd>
|
||
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
||
|
|
<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - If onEnable method has not been called and
|
||
|
|
the instance is null.</dd>
|
||
|
|
</dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="setInstance-main.java.com.djrapitops.plan.Plan-">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>setInstance</h4>
|
||
|
|
<pre>public static void setInstance(<a href="../../../../../main/java/com/djrapitops/plan/Plan.html" title="class in main.java.com.djrapitops.plan">Plan</a> plan)</pre>
|
||
|
|
<div class="block">Used to set the current instance of Plan.</div>
|
||
|
|
<dl>
|
||
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
||
|
|
<dd><code>plan</code> - The newly enabled Plan instance.</dd>
|
||
|
|
</dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="getPlanAPI--">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockListLast">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>getPlanAPI</h4>
|
||
|
|
<pre>public static <a href="../../../../../main/java/com/djrapitops/plan/api/API.html" title="class in main.java.com.djrapitops.plan.api">API</a> getPlanAPI()
|
||
|
|
throws <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></pre>
|
||
|
|
<div class="block">Used to get the PlanAPI. @see API</div>
|
||
|
|
<dl>
|
||
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
||
|
|
<dd>API of the current instance of Plan.</dd>
|
||
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
||
|
|
<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - If onEnable method has not been called on
|
||
|
|
Plan and the instance is null.</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="class-use/Plan.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-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="../../../../../main/java/com/djrapitops/plan/Phrase.html" title="enum in main.java.com.djrapitops.plan"><span class="typeNameLink">Prev Class</span></a></li>
|
||
|
|
<li><a href="../../../../../main/java/com/djrapitops/plan/Settings.html" title="enum in main.java.com.djrapitops.plan"><span class="typeNameLink">Next Class</span></a></li>
|
||
|
|
</ul>
|
||
|
|
<ul class="navList">
|
||
|
|
<li><a href="../../../../../index.html?main/java/com/djrapitops/plan/Plan.html" target="_top">Frames</a></li>
|
||
|
|
<li><a href="Plan.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 ======= -->
|
||
|
|
<p class="legalCopy"><small>Copyright © 2017. All rights reserved.</small></p>
|
||
|
|
</body>
|
||
|
|
</html>
|