mirror of
https://github.com/plan-player-analytics/Plan.git
synced 2024-11-01 16:29:31 +01:00
449 lines
16 KiB
HTML
449 lines
16 KiB
HTML
<!DOCTYPE HTML>
|
|
<!-- NewPage -->
|
|
<html lang="en">
|
|
<head>
|
|
<!-- Generated by javadoc -->
|
|
<title>CallEvents (api 5.2-SNAPSHOT API)</title>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
|
|
<link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style">
|
|
<script type="text/javascript" src="../../../../script.js"></script>
|
|
<script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script>
|
|
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
|
|
<!--[if IE]>
|
|
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
|
|
<![endif]-->
|
|
<script type="text/javascript" src="../../../../jquery/jquery-3.5.1.js"></script>
|
|
<script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script>
|
|
</head>
|
|
<body>
|
|
<script type="text/javascript"><!--
|
|
try {
|
|
if (location.href.indexOf('is-external=true') == -1) {
|
|
parent.document.title="CallEvents (api 5.2-SNAPSHOT API)";
|
|
}
|
|
}
|
|
catch(err) {
|
|
}
|
|
//-->
|
|
var data = {"i0":9,"i1":9};
|
|
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]};
|
|
var altColor = "altColor";
|
|
var rowColor = "rowColor";
|
|
var tableTab = "tableTab";
|
|
var activeTableTab = "activeTableTab";
|
|
var pathtoroot = "../../../../";
|
|
var useModuleDirectories = true;
|
|
loadScripts(document, 'script');</script>
|
|
<noscript>
|
|
<div>JavaScript is disabled on your browser.</div>
|
|
</noscript>
|
|
<header role="banner">
|
|
<nav role="navigation">
|
|
<div class="fixedNav">
|
|
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
<div class="topNav"><a id="navbar.top">
|
|
<!-- -->
|
|
</a>
|
|
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
|
|
<a id="navbar.top.firstrow">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="navList" title="Navigation">
|
|
<li><a href="../../../../index.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" id="allclasses_navbar_top">
|
|
<li><a href="../../../../allclasses.html">All Classes</a></li>
|
|
</ul>
|
|
<ul class="navListSearch">
|
|
<li><label for="search">SEARCH:</label>
|
|
<input type="text" id="search" value="search" disabled="disabled">
|
|
<input type="reset" id="reset" value="reset" disabled="disabled">
|
|
</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>
|
|
<noscript>
|
|
<div>JavaScript is disabled on your browser.</div>
|
|
</noscript>
|
|
</div>
|
|
<div>
|
|
<ul class="subNavList">
|
|
<li>Summary: </li>
|
|
<li>Nested | </li>
|
|
<li><a href="#enum.constant.summary">Enum Constants</a> | </li>
|
|
<li>Field | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li><a href="#enum.constant.detail">Enum Constants</a> | </li>
|
|
<li>Field | </li>
|
|
<li><a href="#method.detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
<a id="skip.navbar.top">
|
|
<!-- -->
|
|
</a></div>
|
|
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
</div>
|
|
<div class="navPadding"> </div>
|
|
<script type="text/javascript"><!--
|
|
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
|
|
//-->
|
|
</script>
|
|
</nav>
|
|
</header>
|
|
<!-- ======== START OF CLASS DATA ======== -->
|
|
<main role="main">
|
|
<div class="header">
|
|
<div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">com.djrapitops.plan.extension</a></div>
|
|
<h2 title="Enum CallEvents" class="title">Enum CallEvents</h2>
|
|
</div>
|
|
<div class="contentContainer">
|
|
<ul class="inheritance">
|
|
<li>java.lang.Object</li>
|
|
<li>
|
|
<ul class="inheritance">
|
|
<li>java.lang.Enum<<a href="CallEvents.html" title="enum in com.djrapitops.plan.extension">CallEvents</a>></li>
|
|
<li>
|
|
<ul class="inheritance">
|
|
<li>com.djrapitops.plan.extension.CallEvents</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<div class="description">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<dl>
|
|
<dt>All Implemented Interfaces:</dt>
|
|
<dd><code>java.io.Serializable</code>, <code>java.lang.Comparable<<a href="CallEvents.html" title="enum in com.djrapitops.plan.extension">CallEvents</a>></code></dd>
|
|
</dl>
|
|
<hr>
|
|
<pre>public enum <span class="typeNameLabel">CallEvents</span>
|
|
extends java.lang.Enum<<a href="CallEvents.html" title="enum in com.djrapitops.plan.extension">CallEvents</a>></pre>
|
|
<div class="block">Enum representing different events when Plan calls methods of <a href="DataExtension.html" title="interface in com.djrapitops.plan.extension"><code>DataExtension</code></a> automatically.
|
|
<p>
|
|
You can also call the update methods via <a href="Caller.html" title="interface in com.djrapitops.plan.extension"><code>Caller</code></a> manually.</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="summary">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<!-- =========== ENUM CONSTANT SUMMARY =========== -->
|
|
<section role="region">
|
|
<ul class="blockList">
|
|
<li class="blockList"><a id="enum.constant.summary">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Enum Constant Summary</h3>
|
|
<table class="memberSummary">
|
|
<caption><span>Enum Constants</span><span class="tabEnd"> </span></caption>
|
|
<tr>
|
|
<th class="colFirst" scope="col">Enum Constant</th>
|
|
<th class="colLast" scope="col">Description</th>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#MANUAL">MANUAL</a></span></code></th>
|
|
<td class="colLast">
|
|
<div class="block">This event represents a manual call via <a href="Caller.html" title="interface in com.djrapitops.plan.extension"><code>Caller</code></a>.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#PLAYER_JOIN">PLAYER_JOIN</a></span></code></th>
|
|
<td class="colLast">
|
|
<div class="block">This event represents call to player methods on a Player Join event.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#PLAYER_LEAVE">PLAYER_LEAVE</a></span></code></th>
|
|
<td class="colLast">
|
|
<div class="block">This event represents a call to player methods on a Player Leave event.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#SERVER_EXTENSION_REGISTER">SERVER_EXTENSION_REGISTER</a></span></code></th>
|
|
<td class="colLast">
|
|
<div class="block">This event represents a call to server methods when the <a href="DataExtension.html" title="interface in com.djrapitops.plan.extension"><code>DataExtension</code></a> is registered.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#SERVER_PERIODICAL">SERVER_PERIODICAL</a></span></code></th>
|
|
<td class="colLast">
|
|
<div class="block">This event represents a call to server methods via a periodical task.</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<!-- ========== METHOD SUMMARY =========== -->
|
|
<section role="region">
|
|
<ul class="blockList">
|
|
<li class="blockList"><a id="method.summary">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Method Summary</h3>
|
|
<table class="memberSummary">
|
|
<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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
|
|
<tr>
|
|
<th class="colFirst" scope="col">Modifier and Type</th>
|
|
<th class="colSecond" scope="col">Method</th>
|
|
<th class="colLast" scope="col">Description</th>
|
|
</tr>
|
|
<tr id="i0" class="altColor">
|
|
<td class="colFirst"><code>static <a href="CallEvents.html" title="enum in com.djrapitops.plan.extension">CallEvents</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#valueOf(java.lang.String)">valueOf</a></span>​(java.lang.String name)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Returns the enum constant of this type with the specified name.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i1" class="rowColor">
|
|
<td class="colFirst"><code>static <a href="CallEvents.html" title="enum in com.djrapitops.plan.extension">CallEvents</a>[]</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#values()">values</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Returns an array containing the constants of this enum type, in
|
|
the order they are declared.</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Enum">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Methods inherited from class java.lang.Enum</h3>
|
|
<code>clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf</code></li>
|
|
</ul>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Methods inherited from class java.lang.Object</h3>
|
|
<code>getClass, notify, notifyAll, wait, wait, wait</code></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="details">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<!-- ============ ENUM CONSTANT DETAIL =========== -->
|
|
<section role="region">
|
|
<ul class="blockList">
|
|
<li class="blockList"><a id="enum.constant.detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Enum Constant Detail</h3>
|
|
<a id="MANUAL">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>MANUAL</h4>
|
|
<pre>public static final <a href="CallEvents.html" title="enum in com.djrapitops.plan.extension">CallEvents</a> MANUAL</pre>
|
|
<div class="block">This event represents a manual call via <a href="Caller.html" title="interface in com.djrapitops.plan.extension"><code>Caller</code></a>.
|
|
Definition inside <a href="DataExtension.html#callExtensionMethodsOn()"><code>DataExtension.callExtensionMethodsOn()</code></a> is NOT REQUIRED for using Caller methods.</div>
|
|
</li>
|
|
</ul>
|
|
<a id="PLAYER_JOIN">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>PLAYER_JOIN</h4>
|
|
<pre>public static final <a href="CallEvents.html" title="enum in com.djrapitops.plan.extension">CallEvents</a> PLAYER_JOIN</pre>
|
|
<div class="block">This event represents call to player methods on a Player Join event.
|
|
<p>
|
|
The call is made from a listener at the last event priority (Bukkit/Bungee: MONITOR, Sponge: POST).
|
|
Method calls are asynchronous.</div>
|
|
</li>
|
|
</ul>
|
|
<a id="PLAYER_LEAVE">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>PLAYER_LEAVE</h4>
|
|
<pre>public static final <a href="CallEvents.html" title="enum in com.djrapitops.plan.extension">CallEvents</a> PLAYER_LEAVE</pre>
|
|
<div class="block">This event represents a call to player methods on a Player Leave event.
|
|
<p>
|
|
The call is made from a listener at the first event priority (Bukkit/Bungee: LOWEST, Sponge: PRE).
|
|
Method calls are asynchronous.</div>
|
|
</li>
|
|
</ul>
|
|
<a id="SERVER_EXTENSION_REGISTER">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>SERVER_EXTENSION_REGISTER</h4>
|
|
<pre>public static final <a href="CallEvents.html" title="enum in com.djrapitops.plan.extension">CallEvents</a> SERVER_EXTENSION_REGISTER</pre>
|
|
<div class="block">This event represents a call to server methods when the <a href="DataExtension.html" title="interface in com.djrapitops.plan.extension"><code>DataExtension</code></a> is registered.
|
|
<p>
|
|
Server methods include any <a href="Group.html" title="interface in com.djrapitops.plan.extension"><code>Group</code></a> parameter methods.
|
|
<p>
|
|
Method calls are asynchronous.</div>
|
|
</li>
|
|
</ul>
|
|
<a id="SERVER_PERIODICAL">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>SERVER_PERIODICAL</h4>
|
|
<pre>public static final <a href="CallEvents.html" title="enum in com.djrapitops.plan.extension">CallEvents</a> SERVER_PERIODICAL</pre>
|
|
<div class="block">This event represents a call to server methods via a periodical task.
|
|
<p>
|
|
Server methods include any <a href="Group.html" title="interface in com.djrapitops.plan.extension"><code>Group</code></a> parameter methods.
|
|
<p>
|
|
Periodic task with a runs user configured period (Plan config).
|
|
Method calls are asynchronous.</div>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
<section role="region">
|
|
<ul class="blockList">
|
|
<li class="blockList"><a id="method.detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Method Detail</h3>
|
|
<a id="values()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>values</h4>
|
|
<pre class="methodSignature">public static <a href="CallEvents.html" title="enum in com.djrapitops.plan.extension">CallEvents</a>[] values()</pre>
|
|
<div class="block">Returns an array containing the constants of this enum type, in
|
|
the order they are declared. This method may be used to iterate
|
|
over the constants as follows:
|
|
<pre>
|
|
for (CallEvents c : CallEvents.values())
|
|
System.out.println(c);
|
|
</pre></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>an array containing the constants of this enum type, in the order they are declared</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="valueOf(java.lang.String)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>valueOf</h4>
|
|
<pre class="methodSignature">public static <a href="CallEvents.html" title="enum in com.djrapitops.plan.extension">CallEvents</a> valueOf​(java.lang.String name)</pre>
|
|
<div class="block">Returns the enum constant of this type with the specified name.
|
|
The string must match <i>exactly</i> an identifier used to declare an
|
|
enum constant in this type. (Extraneous whitespace characters are
|
|
not permitted.)</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>name</code> - the name of the enum constant to be returned.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the enum constant with the specified name</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code>java.lang.IllegalArgumentException</code> - if this enum type has no constant with the specified name</dd>
|
|
<dd><code>java.lang.NullPointerException</code> - if the argument is null</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</main>
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
<footer role="contentinfo">
|
|
<nav role="navigation">
|
|
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
|
<div class="bottomNav"><a id="navbar.bottom">
|
|
<!-- -->
|
|
</a>
|
|
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
|
|
<a id="navbar.bottom.firstrow">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="navList" title="Navigation">
|
|
<li><a href="../../../../index.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" id="allclasses_navbar_bottom">
|
|
<li><a href="../../../../allclasses.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>
|
|
<noscript>
|
|
<div>JavaScript is disabled on your browser.</div>
|
|
</noscript>
|
|
</div>
|
|
<div>
|
|
<ul class="subNavList">
|
|
<li>Summary: </li>
|
|
<li>Nested | </li>
|
|
<li><a href="#enum.constant.summary">Enum Constants</a> | </li>
|
|
<li>Field | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li><a href="#enum.constant.detail">Enum Constants</a> | </li>
|
|
<li>Field | </li>
|
|
<li><a href="#method.detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
<a id="skip.navbar.bottom">
|
|
<!-- -->
|
|
</a></div>
|
|
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|
</nav>
|
|
</footer>
|
|
</body>
|
|
</html>
|