2021-03-10 09:12:21 +01:00
<!DOCTYPE HTML>
< html lang = "en" >
2019-08-05 11:13:19 +02:00
< head >
2022-06-10 15:30:56 +02:00
<!-- Generated by javadoc (17) -->
2022-06-18 11:05:58 +02:00
< title > StringProvider (api 5.5-SNAPSHOT API)< / title >
2021-07-24 13:27:37 +02:00
< meta name = "viewport" content = "width=device-width, initial-scale=1" >
2021-03-10 09:12:21 +01:00
< meta http-equiv = "Content-Type" content = "text/html; charset=utf-8" >
2021-07-24 13:27:37 +02:00
< meta name = "description" content = "declaration: package: com.djrapitops.plan.extension.annotation, annotation type: StringProvider" >
< meta name = "generator" content = "javadoc/ClassWriterImpl" >
2019-08-05 11:13:19 +02:00
< link rel = "stylesheet" type = "text/css" href = "../../../../../stylesheet.css" title = "Style" >
2021-07-24 13:27:37 +02:00
< link rel = "stylesheet" type = "text/css" href = "../../../../../script-dir/jquery-ui.min.css" title = "Style" >
< link rel = "stylesheet" type = "text/css" href = "../../../../../jquery-ui.overrides.css" title = "Style" >
2019-08-05 11:13:19 +02:00
< script type = "text/javascript" src = "../../../../../script.js" > < / script >
2022-12-08 18:30:29 +01:00
< script type = "text/javascript" src = "../../../../../script-dir/jquery-3.6.0.min.js" > < / script >
2021-07-24 13:27:37 +02:00
< script type = "text/javascript" src = "../../../../../script-dir/jquery-ui.min.js" > < / script >
2019-08-05 11:13:19 +02:00
< / head >
2021-07-24 13:27:37 +02:00
< body class = "class-declaration-page" >
< script type = "text/javascript" > v a r p a t h t o r o o t = " . . / . . / . . / . . / . . / " ;
2021-03-10 09:12:21 +01:00
loadScripts(document, 'script');< / script >
2019-08-05 11:13:19 +02:00
< noscript >
< div > JavaScript is disabled on your browser.< / div >
< / noscript >
2021-07-24 13:27:37 +02:00
< div class = "flex-box" >
< header role = "banner" class = "flex-header" >
2021-03-10 09:12:21 +01:00
< nav role = "navigation" >
2019-08-05 11:13:19 +02:00
<!-- ========= START OF TOP NAVBAR ======= -->
2022-06-10 15:30:56 +02:00
< div class = "top-nav" id = "navbar-top" >
< div class = "skip-nav" > < a href = "#skip-navbar-top" title = "Skip navigation links" > Skip navigation links< / a > < / div >
< ul id = "navbar-top-firstrow" class = "nav-list" title = "Navigation" >
2021-03-10 09:12:21 +01:00
< li > < a href = "../../../../../index.html" > Overview< / a > < / li >
2019-08-05 11:13:19 +02:00
< li > < a href = "package-summary.html" > Package< / a > < / li >
2021-07-24 13:27:37 +02:00
< li class = "nav-bar-cell1-rev" > Class< / li >
2019-08-05 11:13:19 +02:00
< 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 >
2022-06-10 15:30:56 +02:00
< li > < a href = "../../../../../help-doc.html#class" > Help< / a > < / li >
2019-08-05 11:13:19 +02:00
< / ul >
< / div >
2021-07-24 13:27:37 +02:00
< div class = "sub-nav" >
2019-08-05 11:13:19 +02:00
< div >
2021-07-24 13:27:37 +02:00
< ul class = "sub-nav-list" >
2019-08-05 11:13:19 +02:00
< li > Summary: < / li >
< li > Field | < / li >
2022-06-10 15:30:56 +02:00
< li > < a href = "#annotation-interface-optional-element-summary" > Optional< / a > | < / li >
< li > < a href = "#annotation-interface-required-element-summary" > Required< / a > < / li >
2019-08-05 11:13:19 +02:00
< / ul >
2021-07-24 13:27:37 +02:00
< ul class = "sub-nav-list" >
2019-08-05 11:13:19 +02:00
< li > Detail: < / li >
< li > Field | < / li >
2022-06-10 15:30:56 +02:00
< li > < a href = "#annotation-interface-element-detail" > Element< / a > < / li >
2019-08-05 11:13:19 +02:00
< / ul >
< / div >
2022-06-10 15:30:56 +02:00
< div class = "nav-list-search" > < label for = "search-input" > SEARCH:< / label >
< input type = "text" id = "search-input" value = "search" disabled = "disabled" >
< input type = "reset" id = "reset-button" value = "reset" disabled = "disabled" >
2021-07-24 13:27:37 +02:00
< / div >
2021-03-10 09:12:21 +01:00
< / div >
2021-07-24 13:27:37 +02:00
<!-- ========= END OF TOP NAVBAR ========= -->
2022-06-10 15:30:56 +02:00
< span class = "skip-nav" id = "skip-navbar-top" > < / span > < / nav >
2021-03-10 09:12:21 +01:00
< / header >
2021-07-24 13:27:37 +02:00
< div class = "flex-content" >
2021-03-10 09:12:21 +01:00
< main role = "main" >
2021-07-24 13:27:37 +02:00
<!-- ======== START OF CLASS DATA ======== -->
2019-08-05 11:13:19 +02:00
< div class = "header" >
2021-07-24 13:27:37 +02:00
< div class = "sub-title" > < span class = "package-label-in-type" > Package< / span > < a href = "package-summary.html" > com.djrapitops.plan.extension.annotation< / a > < / div >
< h1 title = "Annotation Interface StringProvider" class = "title" > Annotation Interface StringProvider< / h1 >
2019-08-05 11:13:19 +02:00
< / div >
2022-06-10 15:30:56 +02:00
< section class = "class-description" id = "class-description" >
2019-08-05 11:13:19 +02:00
< hr >
2022-06-10 15:30:56 +02:00
< div class = "type-signature" > < span class = "annotations" > < a href = "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 > (< a href = "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 > )
< a href = "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 > (< a href = "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 > )
2021-07-24 13:27:37 +02:00
< / span > < span class = "modifiers" > public @interface < / span > < span class = "element-name type-name-label" > StringProvider< / span > < / div >
2019-10-05 10:27:37 +02:00
< div class = "block" > Method annotation to provide a String value.
2019-08-05 11:13:19 +02:00
< 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 >
2021-07-24 13:27:37 +02:00
< / section >
< section class = "summary" >
< ul class = "summary-list" >
<!-- =========== ANNOTATION INTERFACE REQUIRED MEMBER SUMMARY =========== -->
< li >
2022-06-10 15:30:56 +02:00
< section class = "member-summary" id = "annotation-interface-required-element-summary" >
2021-07-24 13:27:37 +02:00
< h2 > Required Element Summary< / h2 >
< div class = "caption" > < span > Required Elements< / span > < / div >
< div class = "summary-table three-column-summary" >
< div class = "table-header col-first" > Modifier and Type< / div >
< div class = "table-header col-second" > Required Element< / div >
< div class = "table-header col-last" > Description< / div >
2022-06-10 15:30:56 +02:00
< div class = "col-first even-row-color" > < code > < a href = "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 >
< div class = "col-second even-row-color" > < code > < a href = "#text()" class = "member-name-link" > text< / a > < / code > < / div >
2021-07-24 13:27:37 +02:00
< div class = "col-last even-row-color" >
2019-08-05 11:13:19 +02:00
< div class = "block" > Text displayed before the value, limited to 50 characters.< / div >
2021-07-24 13:27:37 +02:00
< / div >
< / div >
2021-03-10 09:12:21 +01:00
< / section >
2021-07-24 13:27:37 +02:00
< / li >
<!-- =========== ANNOTATION INTERFACE OPTIONAL MEMBER SUMMARY =========== -->
< li >
2022-06-10 15:30:56 +02:00
< section class = "member-summary" id = "annotation-interface-optional-element-summary" >
2021-07-24 13:27:37 +02:00
< h2 > Optional Element Summary< / h2 >
< div class = "caption" > < span > Optional Elements< / span > < / div >
< div class = "summary-table three-column-summary" >
< div class = "table-header col-first" > Modifier and Type< / div >
< div class = "table-header col-second" > Optional Element< / div >
< div class = "table-header col-last" > Description< / div >
2022-06-10 15:30:56 +02:00
< div class = "col-first even-row-color" > < code > < a href = "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 >
< div class = "col-second even-row-color" > < code > < a href = "#description()" class = "member-name-link" > description< / a > < / code > < / div >
2021-07-24 13:27:37 +02:00
< div class = "col-last even-row-color" >
2019-08-05 11:13:19 +02:00
< div class = "block" > Text displayed when hovering over the value, limited to 150 characters.< / div >
2021-07-24 13:27:37 +02:00
< / div >
< div class = "col-first odd-row-color" > < code > < a href = "../icon/Color.html" title = "enum class in com.djrapitops.plan.extension.icon" > Color< / a > < / code > < / div >
2022-06-10 15:30:56 +02:00
< div class = "col-second odd-row-color" > < code > < a href = "#iconColor()" class = "member-name-link" > iconColor< / a > < / code > < / div >
2021-07-24 13:27:37 +02:00
< div class = "col-last odd-row-color" >
2019-08-05 11:13:19 +02:00
< div class = "block" > Color preference of the plugin.< / div >
2021-07-24 13:27:37 +02:00
< / div >
< div class = "col-first even-row-color" > < code > < a href = "../icon/Family.html" title = "enum class in com.djrapitops.plan.extension.icon" > Family< / a > < / code > < / div >
2022-06-10 15:30:56 +02:00
< div class = "col-second even-row-color" > < code > < a href = "#iconFamily()" class = "member-name-link" > iconFamily< / a > < / code > < / div >
2021-07-24 13:27:37 +02:00
< div class = "col-last even-row-color" >
2019-08-05 11:13:19 +02:00
< div class = "block" > Family of Font Awesome icon.< / div >
2021-07-24 13:27:37 +02:00
< / div >
2022-06-10 15:30:56 +02:00
< div class = "col-first odd-row-color" > < code > < a href = "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 >
< div class = "col-second odd-row-color" > < code > < a href = "#iconName()" class = "member-name-link" > iconName< / a > < / code > < / div >
2021-07-24 13:27:37 +02:00
< div class = "col-last odd-row-color" >
2019-08-05 11:13:19 +02:00
< div class = "block" > Name of Font Awesome icon.< / div >
2021-07-24 13:27:37 +02:00
< / div >
< div class = "col-first even-row-color" > < code > boolean< / code > < / div >
2022-06-10 15:30:56 +02:00
< div class = "col-second even-row-color" > < code > < a href = "#playerName()" class = "member-name-link" > playerName< / a > < / code > < / div >
2021-07-24 13:27:37 +02:00
< div class = "col-last even-row-color" >
2019-08-05 11:13:19 +02:00
< div class = "block" > Determine if this value represents a Player name, for example a mayor of a town.< / div >
2021-07-24 13:27:37 +02:00
< / div >
< div class = "col-first odd-row-color" > < code > int< / code > < / div >
2022-06-10 15:30:56 +02:00
< div class = "col-second odd-row-color" > < code > < a href = "#priority()" class = "member-name-link" > priority< / a > < / code > < / div >
2021-07-24 13:27:37 +02:00
< div class = "col-last odd-row-color" >
2019-08-05 11:13:19 +02:00
< div class = "block" > Display-priority of the value, highest value is placed top most.< / div >
2021-07-24 13:27:37 +02:00
< / div >
< div class = "col-first even-row-color" > < code > boolean< / code > < / div >
2022-06-10 15:30:56 +02:00
< div class = "col-second even-row-color" > < code > < a href = "#showInPlayerTable()" class = "member-name-link" > showInPlayerTable< / a > < / code > < / div >
2021-07-24 13:27:37 +02:00
< div class = "col-last even-row-color" >
2019-08-05 11:13:19 +02:00
< 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 >
2021-07-24 13:27:37 +02:00
< / div >
< / div >
2021-03-10 09:12:21 +01:00
< / section >
2019-08-05 11:13:19 +02:00
< / li >
< / ul >
2021-07-24 13:27:37 +02:00
< / section >
2022-06-10 15:30:56 +02:00
< section class = "details" id = "annotation-interface-element-detail" >
2021-07-24 13:27:37 +02:00
< ul class = "details-list" >
<!-- ============ ANNOTATION INTERFACE MEMBER DETAIL =========== -->
< li >
< section class = "member-details" >
< h2 > Element Details< / h2 >
< ul class = "member-list" >
< li >
< section class = "detail" id = "text()" >
< h3 > text< / h3 >
2022-06-10 15:30:56 +02:00
< div class = "member-signature" > < span class = "return-type" > < a href = "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 > < span class = "element-name" > text< / span > < / div >
2019-08-05 11:13:19 +02:00
< 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 >
2021-07-24 13:27:37 +02:00
< dl class = "notes" >
< dt > Returns:< / dt >
2019-08-05 11:13:19 +02:00
< dd > String of max 50 characters, remainder will be clipped.< / dd >
< / dl >
2021-07-24 13:27:37 +02:00
< / section >
2019-08-05 11:13:19 +02:00
< / li >
< / ul >
2021-03-10 09:12:21 +01:00
< / section >
2021-07-24 13:27:37 +02:00
< / li >
<!-- ============ ANNOTATION INTERFACE MEMBER DETAIL =========== -->
< li >
< section class = "member-details" >
< ul class = "member-list" >
< li >
< section class = "detail" id = "priority()" >
< h3 > priority< / h3 >
< div class = "member-signature" > < span class = "return-type" > int< / span > < span class = "element-name" > priority< / span > < / div >
2019-08-05 11:13:19 +02:00
< 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 >
2021-07-24 13:27:37 +02:00
< dl class = "notes" >
< dt > Returns:< / dt >
2019-08-05 11:13:19 +02:00
< dd > Priority between 0 and < code > Integer.MAX_VALUE< / code > .< / dd >
< / dl >
2021-07-24 13:27:37 +02:00
< dl class = "notes" >
2019-08-05 11:13:19 +02:00
< dt > Default:< / dt >
< dd > 0< / dd >
< / dl >
2021-03-10 09:12:21 +01:00
< / section >
2021-07-24 13:27:37 +02:00
< / li >
< li >
< section class = "detail" id = "description()" >
< h3 > description< / h3 >
2022-06-10 15:30:56 +02:00
< div class = "member-signature" > < span class = "return-type" > < a href = "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 > < span class = "element-name" > description< / span > < / div >
2019-08-05 11:13:19 +02:00
< 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 >
2021-07-24 13:27:37 +02:00
< dl class = "notes" >
< dt > Returns:< / dt >
2019-08-05 11:13:19 +02:00
< dd > String of max 150 characters, remainder will be clipped.< / dd >
< / dl >
2021-07-24 13:27:37 +02:00
< dl class = "notes" >
2019-08-05 11:13:19 +02:00
< dt > Default:< / dt >
< dd > ""< / dd >
< / dl >
2021-03-10 09:12:21 +01:00
< / section >
2021-07-24 13:27:37 +02:00
< / li >
< li >
< section class = "detail" id = "playerName()" >
< h3 > playerName< / h3 >
< div class = "member-signature" > < span class = "return-type" > boolean< / span > < span class = "element-name" > playerName< / span > < / div >
2019-08-05 11:13:19 +02:00
< div class = "block" > Determine if this value represents a Player name, for example a mayor of a town.< / div >
2021-07-24 13:27:37 +02:00
< dl class = "notes" >
< dt > Returns:< / dt >
2019-08-05 11:13:19 +02:00
< dd > < code > true< / code > if the name can be used as a link to another player's page.< / dd >
< / dl >
2021-07-24 13:27:37 +02:00
< dl class = "notes" >
2019-08-05 11:13:19 +02:00
< dt > Default:< / dt >
< dd > false< / dd >
< / dl >
2021-03-10 09:12:21 +01:00
< / section >
2021-07-24 13:27:37 +02:00
< / li >
< li >
< section class = "detail" id = "iconName()" >
< h3 > iconName< / h3 >
2022-06-10 15:30:56 +02:00
< div class = "member-signature" > < span class = "return-type" > < a href = "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 > < span class = "element-name" > iconName< / span > < / div >
2019-08-05 11:13:19 +02:00
< div class = "block" > Name of Font Awesome icon.
< p >
2021-07-24 13:27:37 +02:00
See https://fontawesome.com/icons (select 'free')) for icons and their < a href = "../icon/Family.html" title = "enum class in com.djrapitops.plan.extension.icon" > < code > Family< / code > < / a > .< / div >
< dl class = "notes" >
< dt > Returns:< / dt >
2019-08-05 11:13:19 +02:00
< dd > Name of the icon, if name is not valid no icon is shown.< / dd >
< / dl >
2021-07-24 13:27:37 +02:00
< dl class = "notes" >
2019-08-05 11:13:19 +02:00
< dt > Default:< / dt >
< dd > "question"< / dd >
< / dl >
2021-03-10 09:12:21 +01:00
< / section >
2021-07-24 13:27:37 +02:00
< / li >
< li >
< section class = "detail" id = "iconFamily()" >
< h3 > iconFamily< / h3 >
< div class = "member-signature" > < span class = "return-type" > < a href = "../icon/Family.html" title = "enum class in com.djrapitops.plan.extension.icon" > Family< / a > < / span > < span class = "element-name" > iconFamily< / span > < / div >
2019-08-05 11:13:19 +02:00
< div class = "block" > Family of Font Awesome icon.
< p >
2021-07-24 13:27:37 +02:00
See https://fontawesome.com/icons (select 'free')) for icons and their < a href = "../icon/Family.html" title = "enum class in com.djrapitops.plan.extension.icon" > < code > Family< / code > < / a > .< / div >
< dl class = "notes" >
< dt > Returns:< / dt >
2019-08-05 11:13:19 +02:00
< dd > Family that matches an icon, if there is no icon for this family no icon is shown.< / dd >
< / dl >
2021-07-24 13:27:37 +02:00
< dl class = "notes" >
2019-08-05 11:13:19 +02:00
< dt > Default:< / dt >
2021-07-24 13:27:37 +02:00
< dd > SOLID< / dd >
2019-08-05 11:13:19 +02:00
< / dl >
2021-03-10 09:12:21 +01:00
< / section >
2021-07-24 13:27:37 +02:00
< / li >
< li >
< section class = "detail" id = "iconColor()" >
< h3 > iconColor< / h3 >
< div class = "member-signature" > < span class = "return-type" > < a href = "../icon/Color.html" title = "enum class in com.djrapitops.plan.extension.icon" > Color< / a > < / span > < span class = "element-name" > iconColor< / span > < / div >
2019-08-05 11:13:19 +02:00
< 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 >
2021-07-24 13:27:37 +02:00
< dl class = "notes" >
< dt > Returns:< / dt >
2019-08-05 11:13:19 +02:00
< dd > Preferred color. If none are specified defaults are used.< / dd >
< / dl >
2021-07-24 13:27:37 +02:00
< dl class = "notes" >
2019-08-05 11:13:19 +02:00
< dt > Default:< / dt >
2021-07-24 13:27:37 +02:00
< dd > NONE< / dd >
2019-08-05 11:13:19 +02:00
< / dl >
2021-03-10 09:12:21 +01:00
< / section >
2021-07-24 13:27:37 +02:00
< / li >
< li >
< section class = "detail" id = "showInPlayerTable()" >
< h3 > showInPlayerTable< / h3 >
< div class = "member-signature" > < span class = "return-type" > boolean< / span > < span class = "element-name" > showInPlayerTable< / span > < / div >
2019-08-05 11:13:19 +02:00
< 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 >
2021-07-24 13:27:37 +02:00
< dl class = "notes" >
< dt > Returns:< / dt >
2019-08-05 11:13:19 +02:00
< dd > false by default.< / dd >
< / dl >
2021-07-24 13:27:37 +02:00
< dl class = "notes" >
2019-08-05 11:13:19 +02:00
< dt > Default:< / dt >
< dd > false< / dd >
< / dl >
2021-07-24 13:27:37 +02:00
< / section >
2019-08-05 11:13:19 +02:00
< / li >
< / ul >
2021-03-10 09:12:21 +01:00
< / section >
2019-08-05 11:13:19 +02:00
< / li >
< / ul >
2021-07-24 13:27:37 +02:00
< / section >
2019-08-05 11:13:19 +02:00
<!-- ========= END OF CLASS DATA ========= -->
2021-07-24 13:27:37 +02:00
< / main >
2019-08-05 11:13:19 +02:00
< / div >
< / div >
< / body >
< / html >
