Upstream/Plan
1
0
Fork 0
mirror of https://github.com/plan-player-analytics/Plan.git synced 2024-11-01 16:29:31 +01:00
Code Issues Projects Releases Wiki Activity
b7a3e38d48
Plan/api/com/djrapitops/plan/component/ComponentService.html

431 lines
32 KiB
HTML
Raw Normal View History

Deploying to gh-pages from @ plan-player-analytics/Plan@f0a5b43f02c0eb48601150a934c4a1bcf4a665ea 🚀
2022-10-22 10:53:12 +02:00
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>ComponentService (api 5.5-SNAPSHOT API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="description" content="declaration: package: com.djrapitops.plan.component, interface: ComponentService">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<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">
<script type="text/javascript" src="../../../../script.js"></script>
Deploying to gh-pages from @ plan-player-analytics/Plan@b659dda92844a234f7b163cb4ef78cd8e45d569f 🚀
2022-12-04 11:54:21 +01:00
<script type="text/javascript" src="../../../../script-dir/jquery-3.5.1.min.js"></script>
Deploying to gh-pages from @ plan-player-analytics/Plan@f0a5b43f02c0eb48601150a934c4a1bcf4a665ea 🚀
2022-10-22 10:53:12 +02:00
<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script>
</head>
<body class="class-declaration-page">
<script type="text/javascript">var evenRowColor = "even-row-color";
var oddRowColor = "odd-row-color";
var tableTab = "table-tab";
var activeTableTab = "active-table-tab";
var pathtoroot = "../../../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<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">
<li><a href="../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">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#class">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div>
<ul class="sub-nav-list">
<li>Summary:&nbsp;</li>
<li><a href="#nested-class-summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method-detail">Method</a></li>
</ul>
</div>
<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">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">com.djrapitops.plan.component</a></div>
<h1 title="Interface ComponentService" class="title">Interface ComponentService</h1>
</div>
<section class="class-description" id="class-description">
<hr>
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">ComponentService</span></div>
<div class="block">A utility api class for dealing with rich and less-rich Minecraft message formats.</div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="#getInstance()"><code>getInstance()</code></a></li>
</ul>
</dd>
</dl>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<li>
<section class="nested-class-summary" id="nested-class-summary">
<h2>Nested Class Summary</h2>
<div class="caption"><span>Nested Classes</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">Interface</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>static class&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="ComponentService.Holder.html" class="type-name-link" title="class in com.djrapitops.plan.component">ComponentService.Holder</a></code></div>
<div class="col-last even-row-color">&nbsp;</div>
</div>
</section>
</li>
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<div id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button><button id="method-summary-table-tab5" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab5', 3)" class="table-tab">Default Methods</button></div>
<div id="method-summary-table.tabpanel" role="tabpanel">
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="Component.html" title="interface in com.djrapitops.plan.component">Component</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#fromAdventureLegacy(java.lang.String)" class="member-name-link">fromAdventureLegacy</a><wbr>(<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>&nbsp;adventureLegacy)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">
<div class="block">Converts the given input into a <a href="Component.html" title="interface in com.djrapitops.plan.component"><code>Component</code></a>.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="Component.html" title="interface in com.djrapitops.plan.component">Component</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#fromAdventureLegacy(java.lang.String,char)" class="member-name-link">fromAdventureLegacy</a><wbr>(<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>&nbsp;adventureLegacy,
char&nbsp;character)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Converts the given input into a <a href="Component.html" title="interface in com.djrapitops.plan.component"><code>Component</code></a>.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="Component.html" title="interface in com.djrapitops.plan.component">Component</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#fromAutoDetermine(java.lang.String)" class="member-name-link">fromAutoDetermine</a><wbr>(<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>&nbsp;unknown)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Converts the given input into a <a href="Component.html" title="interface in com.djrapitops.plan.component"><code>Component</code></a>.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="Component.html" title="interface in com.djrapitops.plan.component">Component</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#fromBungeeLegacy(java.lang.String)" class="member-name-link">fromBungeeLegacy</a><wbr>(<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>&nbsp;bungeeLegacy)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">
<div class="block">Converts the given input into a <a href="Component.html" title="interface in com.djrapitops.plan.component"><code>Component</code></a>.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="Component.html" title="interface in com.djrapitops.plan.component">Component</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#fromBungeeLegacy(java.lang.String,char)" class="member-name-link">fromBungeeLegacy</a><wbr>(<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>&nbsp;bungeeLegacy,
char&nbsp;character)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Converts the given input into a <a href="Component.html" title="interface in com.djrapitops.plan.component"><code>Component</code></a>.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="Component.html" title="interface in com.djrapitops.plan.component">Component</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#fromJson(java.lang.String)" class="member-name-link">fromJson</a><wbr>(<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>&nbsp;json)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Converts the given input into a <a href="Component.html" title="interface in com.djrapitops.plan.component"><code>Component</code></a>.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="Component.html" title="interface in com.djrapitops.plan.component">Component</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#fromLegacy(java.lang.String)" class="member-name-link">fromLegacy</a><wbr>(<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>&nbsp;legacy)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">
<div class="block">Converts the given input into a <a href="Component.html" title="interface in com.djrapitops.plan.component"><code>Component</code></a>.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="Component.html" title="interface in com.djrapitops.plan.component">Component</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#fromLegacy(java.lang.String,char)" class="member-name-link">fromLegacy</a><wbr>(<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>&nbsp;legacy,
char&nbsp;character)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Converts the given input into a <a href="Component.html" title="interface in com.djrapitops.plan.component"><code>Component</code></a>.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="Component.html" title="interface in com.djrapitops.plan.component">Component</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#fromMiniMessage(java.lang.String)" class="member-name-link">fromMiniMessage</a><wbr>(<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>&nbsp;miniMessage)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Converts the given input into a <a href="Component.html" title="interface in com.djrapitops.plan.component"><code>Component</code></a>.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1"><code>static <a href="ComponentService.html" title="interface in com.djrapitops.plan.component">ComponentService</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1"><code><a href="#getInstance()" class="member-name-link">getInstance</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1">
<div class="block">Obtain the instance of ComponentService.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <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 method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#translateLegacy(java.lang.String)" class="member-name-link">translateLegacy</a><wbr>(<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>&nbsp;input)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">
<div class="block">Translates ampersands into section signs for color codes.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><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 method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#translateLegacy(java.lang.String,char,char)" class="member-name-link">translateLegacy</a><wbr>(<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>&nbsp;input,
char&nbsp;inputCharacter,
char&nbsp;outputCharacter)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Translates ampersands into section signs for color codes.</div>
</div>
</div>
</div>
</div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="getInstance()">
<h3>getInstance</h3>
<div class="member-signature"><span class="modifiers">static</span>&nbsp;<span class="return-type"><a href="ComponentService.html" title="interface in com.djrapitops.plan.component">ComponentService</a></span>&nbsp;<span class="element-name">getInstance</span>()</div>
<div class="block">Obtain the instance of ComponentService.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>ComponentService implementation.</dd>
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/NoClassDefFoundError.html" title="class or interface in java.lang" class="external-link">NoClassDefFoundError</a></code> - If Plan is not installed and this class can not be found or if older Plan version is installed.</dd>
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalStateException.html" title="class or interface in java.lang" class="external-link">IllegalStateException</a></code> - If Plan is installed, but not enabled.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="translateLegacy(java.lang.String)">
<h3>translateLegacy</h3>
<div class="member-signature"><span class="modifiers">default</span>&nbsp;<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>&nbsp;<span class="element-name">translateLegacy</span><wbr><span class="parameters">(<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>&nbsp;input)</span></div>
<div class="block">Translates ampersands into section signs for color codes. Defaults to <a href="Component.html#AMPERSAND"><code>Component.AMPERSAND</code></a> to <a href="Component.html#SECTION"><code>Component.SECTION</code></a>.
Example: <code>&amp;ctext</code> to <code>§ctext</code>.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>input</code> - the input color string with color codes using ampersands (<code>&amp;</code>)</dd>
<dt>Returns:</dt>
<dd>the same input string with ampersands (<code>&amp;</code>) for color codes replaced with section signs (<code>§</code>)</dd>
<dt>See Also:</dt>
<dd>
<ul class="see-list-long">
<li><a href="#translateLegacy(java.lang.String,char,char)"><code>translateLegacy(String, char, char)</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="translateLegacy(java.lang.String,char,char)">
<h3>translateLegacy</h3>
<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>&nbsp;<span class="element-name">translateLegacy</span><wbr><span class="parameters">(<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>&nbsp;input,
char&nbsp;inputCharacter,
char&nbsp;outputCharacter)</span></div>
<div class="block">Translates ampersands into section signs for color codes. Example: <code>&amp;ctext</code> to <code>§ctext</code>.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>input</code> - the input color string with color codes using ampersands (<code>&amp;</code>)</dd>
<dd><code>inputCharacter</code> - the input character for translation, usually <code>&amp;</code>.</dd>
<dd><code>outputCharacter</code> - the output character for translation, usually <code>§</code>.</dd>
<dt>Returns:</dt>
<dd>the same input string with input characters for color codes replaced with output characters</dd>
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="#translateLegacy(java.lang.String)"><code>translateLegacy(String)</code></a></li>
<li><a href="Component.html#SECTION"><code>Component.SECTION</code></a></li>
<li><a href="Component.html#AMPERSAND"><code>Component.AMPERSAND</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="fromAutoDetermine(java.lang.String)">
<h3>fromAutoDetermine</h3>
<div class="member-signature"><span class="return-type"><a href="Component.html" title="interface in com.djrapitops.plan.component">Component</a></span>&nbsp;<span class="element-name">fromAutoDetermine</span><wbr><span class="parameters">(<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>&nbsp;unknown)</span></div>
<div class="block">Converts the given input into a <a href="Component.html" title="interface in com.djrapitops.plan.component"><code>Component</code></a>.
Converts an unknown format legacy/minimessage string into a component by attempting to guess the input format.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>unknown</code> - the unknown format input string</dd>
<dt>Returns:</dt>
<dd>a <a href="Component.html" title="interface in com.djrapitops.plan.component"><code>Component</code></a></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="fromLegacy(java.lang.String)">
<h3>fromLegacy</h3>
<div class="member-signature"><span class="modifiers">default</span>&nbsp;<span class="return-type"><a href="Component.html" title="interface in com.djrapitops.plan.component">Component</a></span>&nbsp;<span class="element-name">fromLegacy</span><wbr><span class="parameters">(<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>&nbsp;legacy)</span></div>
<div class="block">Converts the given input into a <a href="Component.html" title="interface in com.djrapitops.plan.component"><code>Component</code></a>.
Input example <code>§ctext</code>.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>legacy</code> - the input legacy</dd>
<dt>Returns:</dt>
<dd>a <a href="Component.html" title="interface in com.djrapitops.plan.component"><code>Component</code></a></dd>
<dt>See Also:</dt>
<dd>
<ul class="see-list-long">
<li><a href="#fromLegacy(java.lang.String,char)"><code>fromLegacy(String, char)</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="fromLegacy(java.lang.String,char)">
<h3>fromLegacy</h3>
<div class="member-signature"><span class="return-type"><a href="Component.html" title="interface in com.djrapitops.plan.component">Component</a></span>&nbsp;<span class="element-name">fromLegacy</span><wbr><span class="parameters">(<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>&nbsp;legacy,
char&nbsp;character)</span></div>
<div class="block">Converts the given input into a <a href="Component.html" title="interface in com.djrapitops.plan.component"><code>Component</code></a>.
Input example <code>§ctext</code>.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>legacy</code> - the input legacy</dd>
<dd><code>character</code> - the character to use as the color prefix, usually <code>§</code>.</dd>
<dt>Returns:</dt>
<dd>a <a href="Component.html" title="interface in com.djrapitops.plan.component"><code>Component</code></a></dd>
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="#fromLegacy(java.lang.String)"><code>fromLegacy(String)</code></a></li>
<li><a href="Component.html#SECTION"><code>Component.SECTION</code></a></li>
<li><a href="Component.html#AMPERSAND"><code>Component.AMPERSAND</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="fromAdventureLegacy(java.lang.String)">
<h3>fromAdventureLegacy</h3>
<div class="member-signature"><span class="modifiers">default</span>&nbsp;<span class="return-type"><a href="Component.html" title="interface in com.djrapitops.plan.component">Component</a></span>&nbsp;<span class="element-name">fromAdventureLegacy</span><wbr><span class="parameters">(<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>&nbsp;adventureLegacy)</span></div>
<div class="block">Converts the given input into a <a href="Component.html" title="interface in com.djrapitops.plan.component"><code>Component</code></a>.
Input example: <code>&amp;#rrggbbtext</code>.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>adventureLegacy</code> - the input adventure legacy</dd>
<dt>Returns:</dt>
<dd>a <a href="Component.html" title="interface in com.djrapitops.plan.component"><code>Component</code></a></dd>
<dt>See Also:</dt>
<dd>
<ul class="see-list-long">
<li><a href="#fromAdventureLegacy(java.lang.String,char)"><code>fromAdventureLegacy(String, char)</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="fromAdventureLegacy(java.lang.String,char)">
<h3>fromAdventureLegacy</h3>
<div class="member-signature"><span class="return-type"><a href="Component.html" title="interface in com.djrapitops.plan.component">Component</a></span>&nbsp;<span class="element-name">fromAdventureLegacy</span><wbr><span class="parameters">(<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>&nbsp;adventureLegacy,
char&nbsp;character)</span></div>
<div class="block">Converts the given input into a <a href="Component.html" title="interface in com.djrapitops.plan.component"><code>Component</code></a>.
Input example: <code>&amp;#rrggbbtext</code>.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>adventureLegacy</code> - the input adventure legacy</dd>
<dd><code>character</code> - the character to use as the color prefix, usually <code>&amp;</code>.</dd>
<dt>Returns:</dt>
<dd>a <a href="Component.html" title="interface in com.djrapitops.plan.component"><code>Component</code></a></dd>
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="#fromAdventureLegacy(java.lang.String)"><code>fromAdventureLegacy(String)</code></a></li>
<li><a href="Component.html#SECTION"><code>Component.SECTION</code></a></li>
<li><a href="Component.html#AMPERSAND"><code>Component.AMPERSAND</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="fromBungeeLegacy(java.lang.String)">
<h3>fromBungeeLegacy</h3>
<div class="member-signature"><span class="modifiers">default</span>&nbsp;<span class="return-type"><a href="Component.html" title="interface in com.djrapitops.plan.component">Component</a></span>&nbsp;<span class="element-name">fromBungeeLegacy</span><wbr><span class="parameters">(<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>&nbsp;bungeeLegacy)</span></div>
<div class="block">Converts the given input into a <a href="Component.html" title="interface in com.djrapitops.plan.component"><code>Component</code></a>.
Input example: <code>§x§r§r§g§g§b§btext</code>.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>bungeeLegacy</code> - the input bungee legacy</dd>
<dt>Returns:</dt>
<dd>a <a href="Component.html" title="interface in com.djrapitops.plan.component"><code>Component</code></a></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="fromBungeeLegacy(java.lang.String,char)">
<h3>fromBungeeLegacy</h3>
<div class="member-signature"><span class="return-type"><a href="Component.html" title="interface in com.djrapitops.plan.component">Component</a></span>&nbsp;<span class="element-name">fromBungeeLegacy</span><wbr><span class="parameters">(<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>&nbsp;bungeeLegacy,
char&nbsp;character)</span></div>
<div class="block">Converts the given input into a <a href="Component.html" title="interface in com.djrapitops.plan.component"><code>Component</code></a>.
Input example: <code>§x§r§r§g§g§b§btext</code>.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>bungeeLegacy</code> - the input bungee legacy</dd>
<dd><code>character</code> - the character to use as the color prefix, usually <code>§</code>.</dd>
<dt>Returns:</dt>
<dd>a <a href="Component.html" title="interface in com.djrapitops.plan.component"><code>Component</code></a></dd>
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="Component.html#SECTION"><code>Component.SECTION</code></a></li>
<li><a href="Component.html#AMPERSAND"><code>Component.AMPERSAND</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="fromMiniMessage(java.lang.String)">
<h3>fromMiniMessage</h3>
<div class="member-signature"><span class="return-type"><a href="Component.html" title="interface in com.djrapitops.plan.component">Component</a></span>&nbsp;<span class="element-name">fromMiniMessage</span><wbr><span class="parameters">(<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>&nbsp;miniMessage)</span></div>
<div class="block">Converts the given input into a <a href="Component.html" title="interface in com.djrapitops.plan.component"><code>Component</code></a>.
Input example: <code>&lt;red&gt;text&lt;/red&gt;</code>.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>miniMessage</code> - the input minimessage</dd>
<dt>Returns:</dt>
<dd>a <a href="Component.html" title="interface in com.djrapitops.plan.component"><code>Component</code></a></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="fromJson(java.lang.String)">
<h3>fromJson</h3>
<div class="member-signature"><span class="return-type"><a href="Component.html" title="interface in com.djrapitops.plan.component">Component</a></span>&nbsp;<span class="element-name">fromJson</span><wbr><span class="parameters">(<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>&nbsp;json)</span></div>
<div class="block">Converts the given input into a <a href="Component.html" title="interface in com.djrapitops.plan.component"><code>Component</code></a>.
Input example: <code>{text:"text",color:"red"}</code> (standard Minecraft json).</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>json</code> - the input json</dd>
<dt>Returns:</dt>
<dd>a <a href="Component.html" title="interface in com.djrapitops.plan.component"><code>Component</code></a></dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
</div>
</div>
</body>
</html>
Reference in New Issue Copy Permalink