mirror of
https://github.com/plan-player-analytics/Plan.git
synced 2024-11-01 16:29:31 +01:00
446 lines
16 KiB
HTML
446 lines
16 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_201) on Fri Aug 09 10:21:36 EEST 2019 -->
|
|
<title>StringProvider (Plan 4.9.2 API)</title>
|
|
<meta name="date" content="2019-08-09">
|
|
<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="StringProvider (Plan 4.9.2 API)";
|
|
}
|
|
}
|
|
catch(err) {
|
|
}
|
|
//-->
|
|
</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/extension/annotation/PluginInfo.html" title="annotation in com.djrapitops.plan.extension.annotation"><span class="typeNameLink">Prev Class</span></a></li>
|
|
<li><a href="../../../../../com/djrapitops/plan/extension/annotation/Tab.html" title="annotation in com.djrapitops.plan.extension.annotation"><span class="typeNameLink">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../../../../../index.html?com/djrapitops/plan/extension/annotation/StringProvider.html" target="_top">Frames</a></li>
|
|
<li><a href="StringProvider.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>Field | </li>
|
|
<li><a href="#annotation.type.required.element.summary">Required</a> | </li>
|
|
<li><a href="#annotation.type.optional.element.summary">Optional</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li><a href="#annotation.type.element.detail">Element</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.extension.annotation</div>
|
|
<h2 title="Annotation Type StringProvider" class="title">Annotation Type StringProvider</h2>
|
|
</div>
|
|
<div class="contentContainer">
|
|
<div class="description">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<hr>
|
|
<br>
|
|
<pre>@Retention(value=RUNTIME)
|
|
@Target(value=METHOD)
|
|
public @interface <span class="memberNameLabel">StringProvider</span></pre>
|
|
<div class="block">Method annotation to provide a String value about a Player.
|
|
<p>
|
|
Usage: <code>@StringProvider String method(UUID playerUUID)</code>
|
|
<p>
|
|
The returned value is limited to 100 characters, remainder will be clipped.
|
|
<p>
|
|
If the value is a player name, provide value for playerName=true.
|
|
This will allow linking between pages.</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="summary">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<!-- =========== ANNOTATION TYPE REQUIRED MEMBER SUMMARY =========== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="annotation.type.required.element.summary">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Required Element Summary</h3>
|
|
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Required Element Summary table, listing required elements, and an explanation">
|
|
<caption><span>Required Elements</span><span class="tabEnd"> </span></caption>
|
|
<tr>
|
|
<th class="colFirst" scope="col">Modifier and Type</th>
|
|
<th class="colLast" scope="col">Required Element and Description</th>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>java.lang.String</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/djrapitops/plan/extension/annotation/StringProvider.html#text--">text</a></span></code>
|
|
<div class="block">Text displayed before the value, limited to 50 characters.</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</li>
|
|
</ul>
|
|
<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="annotation.type.optional.element.summary">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Optional Element Summary</h3>
|
|
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation">
|
|
<caption><span>Optional Elements</span><span class="tabEnd"> </span></caption>
|
|
<tr>
|
|
<th class="colFirst" scope="col">Modifier and Type</th>
|
|
<th class="colLast" scope="col">Optional Element and Description</th>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>java.lang.String</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/djrapitops/plan/extension/annotation/StringProvider.html#description--">description</a></span></code>
|
|
<div class="block">Text displayed when hovering over the value, limited to 150 characters.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code><a href="../../../../../com/djrapitops/plan/extension/icon/Color.html" title="enum in com.djrapitops.plan.extension.icon">Color</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/djrapitops/plan/extension/annotation/StringProvider.html#iconColor--">iconColor</a></span></code>
|
|
<div class="block">Color preference of the plugin.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code><a href="../../../../../com/djrapitops/plan/extension/icon/Family.html" title="enum in com.djrapitops.plan.extension.icon">Family</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/djrapitops/plan/extension/annotation/StringProvider.html#iconFamily--">iconFamily</a></span></code>
|
|
<div class="block">Family of Font Awesome icon.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>java.lang.String</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/djrapitops/plan/extension/annotation/StringProvider.html#iconName--">iconName</a></span></code>
|
|
<div class="block">Name of Font Awesome icon.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/djrapitops/plan/extension/annotation/StringProvider.html#playerName--">playerName</a></span></code>
|
|
<div class="block">Determine if this value represents a Player name, for example a mayor of a town.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/djrapitops/plan/extension/annotation/StringProvider.html#priority--">priority</a></span></code>
|
|
<div class="block">Display-priority of the value, highest value is placed top most.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/djrapitops/plan/extension/annotation/StringProvider.html#showInPlayerTable--">showInPlayerTable</a></span></code>
|
|
<div class="block">When the parameter is set to <code>true</code> the value from this Provider is shown on a table alongside players.</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="details">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="annotation.type.element.detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Element Detail</h3>
|
|
<a name="text--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>text</h4>
|
|
<pre>public abstract java.lang.String text</pre>
|
|
<div class="block">Text displayed before the value, limited to 50 characters.
|
|
<p>
|
|
Should inform the user what the value represents, for example
|
|
"Town Name", "Pet Name"</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>String of max 50 characters, remainder will be clipped.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="priority--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>priority</h4>
|
|
<pre>public abstract int priority</pre>
|
|
<div class="block">Display-priority of the value, highest value is placed top most.
|
|
<p>
|
|
Two values with same priority may appear in a random order.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>Priority between 0 and <code>Integer.MAX_VALUE</code>.</dd>
|
|
</dl>
|
|
<dl>
|
|
<dt>Default:</dt>
|
|
<dd>0</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="description--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>description</h4>
|
|
<pre>public abstract java.lang.String description</pre>
|
|
<div class="block">Text displayed when hovering over the value, limited to 150 characters.
|
|
<p>
|
|
Should be used to clarify what the value is if not self evident, for example
|
|
text: "Power", description: "Faction power, affects ability of faction to perform actions. Regenerates"</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>String of max 150 characters, remainder will be clipped.</dd>
|
|
</dl>
|
|
<dl>
|
|
<dt>Default:</dt>
|
|
<dd>""</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="playerName--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>playerName</h4>
|
|
<pre>public abstract boolean playerName</pre>
|
|
<div class="block">Determine if this value represents a Player name, for example a mayor of a town.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd><code>true</code> if the name can be used as a link to another player's page.</dd>
|
|
</dl>
|
|
<dl>
|
|
<dt>Default:</dt>
|
|
<dd>false</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="iconName--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>iconName</h4>
|
|
<pre>public abstract java.lang.String iconName</pre>
|
|
<div class="block">Name of Font Awesome icon.
|
|
<p>
|
|
See https://fontawesome.com/icons (select 'free')) for icons and their <a href="../../../../../com/djrapitops/plan/extension/icon/Family.html" title="enum in com.djrapitops.plan.extension.icon"><code>Family</code></a>.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>Name of the icon, if name is not valid no icon is shown.</dd>
|
|
</dl>
|
|
<dl>
|
|
<dt>Default:</dt>
|
|
<dd>"question"</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="iconFamily--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>iconFamily</h4>
|
|
<pre>public abstract <a href="../../../../../com/djrapitops/plan/extension/icon/Family.html" title="enum in com.djrapitops.plan.extension.icon">Family</a> iconFamily</pre>
|
|
<div class="block">Family of Font Awesome icon.
|
|
<p>
|
|
See https://fontawesome.com/icons (select 'free')) for icons and their <a href="../../../../../com/djrapitops/plan/extension/icon/Family.html" title="enum in com.djrapitops.plan.extension.icon"><code>Family</code></a>.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>Family that matches an icon, if there is no icon for this family no icon is shown.</dd>
|
|
</dl>
|
|
<dl>
|
|
<dt>Default:</dt>
|
|
<dd>com.djrapitops.plan.extension.icon.Family.SOLID</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="iconColor--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>iconColor</h4>
|
|
<pre>public abstract <a href="../../../../../com/djrapitops/plan/extension/icon/Color.html" title="enum in com.djrapitops.plan.extension.icon">Color</a> iconColor</pre>
|
|
<div class="block">Color preference of the plugin.
|
|
<p>
|
|
This color will be set as the default color to use for plugin's elements.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>Preferred color. If none are specified defaults are used.</dd>
|
|
</dl>
|
|
<dl>
|
|
<dt>Default:</dt>
|
|
<dd>com.djrapitops.plan.extension.icon.Color.NONE</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="showInPlayerTable--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>showInPlayerTable</h4>
|
|
<pre>public abstract boolean showInPlayerTable</pre>
|
|
<div class="block">When the parameter is set to <code>true</code> the value from this Provider is shown on a table alongside players.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>false by default.</dd>
|
|
</dl>
|
|
<dl>
|
|
<dt>Default:</dt>
|
|
<dd>false</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/extension/annotation/PluginInfo.html" title="annotation in com.djrapitops.plan.extension.annotation"><span class="typeNameLink">Prev Class</span></a></li>
|
|
<li><a href="../../../../../com/djrapitops/plan/extension/annotation/Tab.html" title="annotation in com.djrapitops.plan.extension.annotation"><span class="typeNameLink">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../../../../../index.html?com/djrapitops/plan/extension/annotation/StringProvider.html" target="_top">Frames</a></li>
|
|
<li><a href="StringProvider.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>Field | </li>
|
|
<li><a href="#annotation.type.required.element.summary">Required</a> | </li>
|
|
<li><a href="#annotation.type.optional.element.summary">Optional</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li><a href="#annotation.type.element.detail">Element</a></li>
|
|
</ul>
|
|
</div>
|
|
<a name="skip.navbar.bottom">
|
|
<!-- -->
|
|
</a></div>
|
|
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|
</body>
|
|
</html>
|