Plan/all/com/djrapitops/plan/addons/placeholderapi/PlanPlaceHolders.html

454 lines
18 KiB
HTML
Raw Normal View History

2019-10-05 10:27:37 +02:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="fi">
<head>
2020-01-24 11:56:15 +01:00
<!-- Generated by javadoc (1.8.0_201) on Fri Jan 24 12:56:06 EET 2020 -->
<title>PlanPlaceHolders (Plan 5.0-SNAPSHOT API)</title>
<meta name="date" content="2020-01-24">
2019-10-05 10:27:37 +02:00
<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) {
2020-01-24 11:56:15 +01:00
parent.document.title="PlanPlaceHolders (Plan 5.0-SNAPSHOT API)";
2019-10-05 10:27:37 +02:00
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":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/addons/placeholderapi/PlaceholderRegistrar.html" title="class in com.djrapitops.plan.addons.placeholderapi"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/djrapitops/plan/addons/placeholderapi/PlanPlaceHolders.html" target="_top">Frames</a></li>
<li><a href="PlanPlaceHolders.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="#field.summary">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><a href="#field.detail">Field</a>&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.addons.placeholderapi</div>
<h2 title="Class PlanPlaceHolders" class="title">Class PlanPlaceHolders</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>me.clip.placeholderapi.PlaceholderHook</li>
<li>
<ul class="inheritance">
<li>me.clip.placeholderapi.expansion.PlaceholderExpansion</li>
<li>
<ul class="inheritance">
<li>com.djrapitops.plan.addons.placeholderapi.PlanPlaceHolders</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">PlanPlaceHolders</span>
extends me.clip.placeholderapi.expansion.PlaceholderExpansion</pre>
<div class="block">Placeholder expansion used to provide data from Plan.
<p>
<b>Current used services for placeholders:</b>
<ul>
<li><a href="../../../../../com/djrapitops/plan/addons/placeholderapi/placeholders/ServerPlaceHolders.html" title="class in com.djrapitops.plan.addons.placeholderapi.placeholders"><code>ServerPlaceHolders</code></a>:
<a href="../../../../../com/djrapitops/plan/delivery/domain/keys/ServerKeys.html#TPS"><code>ServerKeys.TPS</code></a>,<a href="../../../../../com/djrapitops/plan/delivery/domain/keys/ServerKeys.html#NAME"><code>ServerKeys.NAME</code></a>,
<a href="../../../../../com/djrapitops/plan/delivery/domain/keys/ServerKeys.html#SERVER_UUID"><code>ServerKeys.SERVER_UUID</code></a></li>
<li><a href="../../../../../com/djrapitops/plan/addons/placeholderapi/placeholders/OperatorPlaceholders.html" title="class in com.djrapitops.plan.addons.placeholderapi.placeholders"><code>OperatorPlaceholders</code></a>: <a href="../../../../../com/djrapitops/plan/delivery/domain/keys/ServerKeys.html#OPERATORS"><code>ServerKeys.OPERATORS</code></a></li>
<li><a href="../../../../../com/djrapitops/plan/addons/placeholderapi/placeholders/WorldTimePlaceHolder.html" title="class in com.djrapitops.plan.addons.placeholderapi.placeholders"><code>WorldTimePlaceHolder</code></a>: <a href="../../../../../com/djrapitops/plan/delivery/domain/keys/ServerKeys.html#WORLD_TIMES"><code>ServerKeys.WORLD_TIMES</code></a></li>
<li><a href="../../../../../com/djrapitops/plan/addons/placeholderapi/placeholders/SessionPlaceHolder.html" title="class in com.djrapitops.plan.addons.placeholderapi.placeholders"><code>SessionPlaceHolder</code></a>: <a href="../../../../../com/djrapitops/plan/delivery/domain/keys/ServerKeys.html#SESSIONS"><code>ServerKeys.SESSIONS</code></a>,
<a href="../../../../../com/djrapitops/plan/delivery/domain/keys/ServerKeys.html#PLAYERS"><code>ServerKeys.PLAYERS</code></a>,<a href="../../../../../com/djrapitops/plan/delivery/domain/keys/ServerKeys.html#PING"><code>ServerKeys.PING</code></a>,<a href="../../../../../com/djrapitops/plan/delivery/domain/keys/ServerKeys.html#ALL_TIME_PEAK_PLAYERS"><code>ServerKeys.ALL_TIME_PEAK_PLAYERS</code></a>,
<a href="../../../../../com/djrapitops/plan/delivery/domain/keys/ServerKeys.html#RECENT_PEAK_PLAYERS"><code>ServerKeys.RECENT_PEAK_PLAYERS</code></a></li>
</ul></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>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>com.djrapitops.plugin.logging.error.ErrorHandler</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/djrapitops/plan/addons/placeholderapi/PlanPlaceHolders.html#errorHandler">errorHandler</a></span></code>&nbsp;</td>
</tr>
</table>
</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/addons/placeholderapi/PlanPlaceHolders.html#PlanPlaceHolders-com.djrapitops.plan.PlanSystem-com.djrapitops.plugin.logging.error.ErrorHandler-">PlanPlaceHolders</a></span>(<a href="../../../../../com/djrapitops/plan/PlanSystem.html" title="class in com.djrapitops.plan">PlanSystem</a>&nbsp;system,
com.djrapitops.plugin.logging.error.ErrorHandler&nbsp;errorHandler)</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>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/djrapitops/plan/addons/placeholderapi/PlanPlaceHolders.html#canRegister--">canRegister</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/djrapitops/plan/addons/placeholderapi/PlanPlaceHolders.html#getAuthor--">getAuthor</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/djrapitops/plan/addons/placeholderapi/PlanPlaceHolders.html#getIdentifier--">getIdentifier</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/djrapitops/plan/addons/placeholderapi/PlanPlaceHolders.html#getPlugin--">getPlugin</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/djrapitops/plan/addons/placeholderapi/PlanPlaceHolders.html#getVersion--">getVersion</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/djrapitops/plan/addons/placeholderapi/PlanPlaceHolders.html#onPlaceholderRequest-org.bukkit.entity.Player-java.lang.String-">onPlaceholderRequest</a></span>(org.bukkit.entity.Player&nbsp;p,
java.lang.String&nbsp;params)</code>&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/djrapitops/plan/addons/placeholderapi/PlanPlaceHolders.html#persist--">persist</a></span>()</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.me.clip.placeholderapi.expansion.PlaceholderExpansion">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;me.clip.placeholderapi.expansion.PlaceholderExpansion</h3>
<code>configurationContains, get, getConfigSection, getConfigSection, getDescription, getDouble, getInt, getLink, getLong, getName, getPlaceholderAPI, getPlaceholders, getRequiredPlugin, getString, getStringList, isRegistered, register</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.me.clip.placeholderapi.PlaceholderHook">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;me.clip.placeholderapi.PlaceholderHook</h3>
<code>onRequest</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>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="errorHandler">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>errorHandler</h4>
<pre>public final&nbsp;com.djrapitops.plugin.logging.error.ErrorHandler errorHandler</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="PlanPlaceHolders-com.djrapitops.plan.PlanSystem-com.djrapitops.plugin.logging.error.ErrorHandler-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>PlanPlaceHolders</h4>
<pre>public&nbsp;PlanPlaceHolders(<a href="../../../../../com/djrapitops/plan/PlanSystem.html" title="class in com.djrapitops.plan">PlanSystem</a>&nbsp;system,
com.djrapitops.plugin.logging.error.ErrorHandler&nbsp;errorHandler)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="persist--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>persist</h4>
<pre>public&nbsp;boolean&nbsp;persist()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>persist</code>&nbsp;in class&nbsp;<code>me.clip.placeholderapi.expansion.PlaceholderExpansion</code></dd>
</dl>
</li>
</ul>
<a name="canRegister--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>canRegister</h4>
<pre>public&nbsp;boolean&nbsp;canRegister()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>canRegister</code>&nbsp;in class&nbsp;<code>me.clip.placeholderapi.expansion.PlaceholderExpansion</code></dd>
</dl>
</li>
</ul>
<a name="getIdentifier--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getIdentifier</h4>
<pre>public&nbsp;java.lang.String&nbsp;getIdentifier()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>getIdentifier</code>&nbsp;in class&nbsp;<code>me.clip.placeholderapi.expansion.PlaceholderExpansion</code></dd>
</dl>
</li>
</ul>
<a name="getPlugin--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPlugin</h4>
<pre>public&nbsp;java.lang.String&nbsp;getPlugin()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>getPlugin</code>&nbsp;in class&nbsp;<code>me.clip.placeholderapi.expansion.PlaceholderExpansion</code></dd>
</dl>
</li>
</ul>
<a name="getAuthor--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAuthor</h4>
<pre>public&nbsp;java.lang.String&nbsp;getAuthor()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>getAuthor</code>&nbsp;in class&nbsp;<code>me.clip.placeholderapi.expansion.PlaceholderExpansion</code></dd>
</dl>
</li>
</ul>
<a name="getVersion--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getVersion</h4>
<pre>public&nbsp;java.lang.String&nbsp;getVersion()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>getVersion</code>&nbsp;in class&nbsp;<code>me.clip.placeholderapi.expansion.PlaceholderExpansion</code></dd>
</dl>
</li>
</ul>
<a name="onPlaceholderRequest-org.bukkit.entity.Player-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>onPlaceholderRequest</h4>
<pre>public&nbsp;java.lang.String&nbsp;onPlaceholderRequest(org.bukkit.entity.Player&nbsp;p,
java.lang.String&nbsp;params)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>onPlaceholderRequest</code>&nbsp;in class&nbsp;<code>me.clip.placeholderapi.PlaceholderHook</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/addons/placeholderapi/PlaceholderRegistrar.html" title="class in com.djrapitops.plan.addons.placeholderapi"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/djrapitops/plan/addons/placeholderapi/PlanPlaceHolders.html" target="_top">Frames</a></li>
<li><a href="PlanPlaceHolders.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="#field.summary">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><a href="#field.detail">Field</a>&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>