<divclass="type-signature"><spanclass="annotations"><ahref="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/annotation/Retention.html"title="class or interface in java.lang.annotation"class="external-link">@Retention</a>(<ahref="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/annotation/RetentionPolicy.html#RUNTIME"title="class or interface in java.lang.annotation"class="external-link">RUNTIME</a>)
<ahref="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/annotation/Target.html"title="class or interface in java.lang.annotation"class="external-link">@Target</a>(<ahref="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/annotation/ElementType.html#METHOD"title="class or interface in java.lang.annotation"class="external-link">METHOD</a>)
<divclass="block">Method annotation to provide a Minecraft text <ahref="../../component/Component.html"title="interface in com.djrapitops.plan.component"><code>Component</code></a> value.
<divclass="col-first even-row-color"><code><ahref="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html"title="class or interface in java.lang"class="external-link">String</a></code></div>
<divclass="col-first even-row-color"><code><ahref="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html"title="class or interface in java.lang"class="external-link">String</a></code></div>
<divclass="block">Family of Font Awesome icon.</div>
</div>
<divclass="col-first even-row-color"><code><ahref="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html"title="class or interface in java.lang"class="external-link">String</a></code></div>
<!-- ============ ANNOTATION INTERFACE MEMBER DETAIL =========== -->
<li>
<sectionclass="member-details">
<h2>Element Details</h2>
<ulclass="member-list">
<li>
<sectionclass="detail"id="text()">
<h3>text</h3>
<divclass="member-signature"><spanclass="return-type"><ahref="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html"title="class or interface in java.lang"class="external-link">String</a></span> <spanclass="element-name">text</span></div>
<divclass="block">Text displayed before the value, limited to 50 characters.
<p>
Should inform the user what the value represents, for example
"Owned Chickens", "Claimed Blocks"</div>
<dlclass="notes">
<dt>Returns:</dt>
<dd>String of max 50 characters, remainder will be clipped.</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
<!-- ============ ANNOTATION INTERFACE MEMBER DETAIL =========== -->
<divclass="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>
<dlclass="notes">
<dt>Returns:</dt>
<dd>Priority between 0 and <code>Integer.MAX_VALUE</code>.</dd>
</dl>
<dlclass="notes">
<dt>Default:</dt>
<dd>0</dd>
</dl>
</section>
</li>
<li>
<sectionclass="detail"id="description()">
<h3>description</h3>
<divclass="member-signature"><spanclass="return-type"><ahref="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html"title="class or interface in java.lang"class="external-link">String</a></span> <spanclass="element-name">description</span></div>
<divclass="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: "Fished", description: "How long the player has fished for"</div>
<dlclass="notes">
<dt>Returns:</dt>
<dd>String of max 150 characters, remainder will be clipped.</dd>
</dl>
<dlclass="notes">
<dt>Default:</dt>
<dd>""</dd>
</dl>
</section>
</li>
<li>
<sectionclass="detail"id="format()">
<h3>format</h3>
<divclass="member-signature"><spanclass="return-type"><ahref="../FormatType.html"title="enum class in com.djrapitops.plan.extension">FormatType</a></span> <spanclass="element-name">format</span></div>
<divclass="block">Apply special formatting to the value before presentation.</div>
<dlclass="notes">
<dt>Returns:</dt>
<dd><ahref="../FormatType.html"title="enum class in com.djrapitops.plan.extension"><code>FormatType</code></a> that best represents the long value.</dd>
<dt>See Also:</dt>
<dd>
<ulclass="see-list">
<li><ahref="../FormatType.html"title="enum class in com.djrapitops.plan.extension"><code>for available formatters.</code></a></li>
</ul>
</dd>
</dl>
<dlclass="notes">
<dt>Default:</dt>
<dd>NONE</dd>
</dl>
</section>
</li>
<li>
<sectionclass="detail"id="iconName()">
<h3>iconName</h3>
<divclass="member-signature"><spanclass="return-type"><ahref="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html"title="class or interface in java.lang"class="external-link">String</a></span> <spanclass="element-name">iconName</span></div>
<divclass="block">Name of Font Awesome icon.
<p>
See https://fontawesome.com/icons (select 'free')) for icons and their <ahref="../icon/Family.html"title="enum class in com.djrapitops.plan.extension.icon"><code>Family</code></a>.</div>
<dlclass="notes">
<dt>Returns:</dt>
<dd>Name of the icon, if name is not valid no icon is shown.</dd>
</dl>
<dlclass="notes">
<dt>Default:</dt>
<dd>"question"</dd>
</dl>
</section>
</li>
<li>
<sectionclass="detail"id="iconFamily()">
<h3>iconFamily</h3>
<divclass="member-signature"><spanclass="return-type"><ahref="../icon/Family.html"title="enum class in com.djrapitops.plan.extension.icon">Family</a></span> <spanclass="element-name">iconFamily</span></div>
<divclass="block">Family of Font Awesome icon.
<p>
See https://fontawesome.com/icons (select 'free')) for icons and their <ahref="../icon/Family.html"title="enum class in com.djrapitops.plan.extension.icon"><code>Family</code></a>.</div>
<dlclass="notes">
<dt>Returns:</dt>
<dd>Family that matches an icon, if there is no icon for this family no icon is shown.</dd>
</dl>
<dlclass="notes">
<dt>Default:</dt>
<dd>SOLID</dd>
</dl>
</section>
</li>
<li>
<sectionclass="detail"id="iconColor()">
<h3>iconColor</h3>
<divclass="member-signature"><spanclass="return-type"><ahref="../icon/Color.html"title="enum class in com.djrapitops.plan.extension.icon">Color</a></span> <spanclass="element-name">iconColor</span></div>
<divclass="block">Color preference of the plugin.
<p>
This color will be set as the default color to use for plugin's elements.</div>
<dlclass="notes">
<dt>Returns:</dt>
<dd>Preferred color. If none are specified defaults are used.</dd>
