mirror of
https://github.com/AtlasMediaGroup/Scissors-Website.git
synced 2024-07-01 06:31:45 +00:00
668 lines
51 KiB
HTML
668 lines
51 KiB
HTML
<!DOCTYPE HTML>
|
|
<html lang="en">
|
|
<head>
|
|
<!-- Generated by javadoc (17) -->
|
|
<title>ChatColor (Scissors-API 1.17.1-R0.1-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: org.bukkit, enum: ChatColor">
|
|
<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>
|
|
<script type="text/javascript" src="../../script-dir/jquery-3.5.1.min.js"></script>
|
|
<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: </li>
|
|
<li><a href="#nested-class-summary">Nested</a> | </li>
|
|
<li><a href="#enum-constant-summary">Enum Constants</a> | </li>
|
|
<li><a href="#field-summary">Field</a> | </li>
|
|
<li><a href="#method-summary">Method</a></li>
|
|
</ul>
|
|
<ul class="sub-nav-list">
|
|
<li>Detail: </li>
|
|
<li><a href="#enum-constant-detail">Enum Constants</a> | </li>
|
|
<li><a href="#field-detail">Field</a> | </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> <a href="package-summary.html">org.bukkit</a></div>
|
|
<h1 title="Enum Class ChatColor" class="title">Enum Class ChatColor</h1>
|
|
</div>
|
|
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
|
|
<div class="inheritance"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">java.lang.Enum</a><<a href="ChatColor.html" title="enum class in org.bukkit">ChatColor</a>>
|
|
<div class="inheritance">org.bukkit.ChatColor</div>
|
|
</div>
|
|
</div>
|
|
<section class="class-description" id="class-description">
|
|
<dl class="notes">
|
|
<dt>All Implemented Interfaces:</dt>
|
|
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></code>, <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a><<a href="ChatColor.html" title="enum class in org.bukkit">ChatColor</a>></code>, <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/constant/Constable.html" title="class or interface in java.lang.constant" class="external-link">Constable</a></code></dd>
|
|
</dl>
|
|
<hr>
|
|
<div class="type-signature"><span class="modifiers">public enum </span><span class="element-name type-name-label">ChatColor</span>
|
|
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a><<a href="ChatColor.html" title="enum class in org.bukkit">ChatColor</a>></span></div>
|
|
<div class="block">All supported color values for chat</div>
|
|
</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="inherited-list">
|
|
<h2 id="nested-classes-inherited-from-class-java.lang.Enum">Nested classes/interfaces inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a></h2>
|
|
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">Enum.EnumDesc</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">E</a> extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">E</a>>></code></div>
|
|
</section>
|
|
</li>
|
|
<!-- =========== ENUM CONSTANT SUMMARY =========== -->
|
|
<li>
|
|
<section class="constants-summary" id="enum-constant-summary">
|
|
<h2>Enum Constant Summary</h2>
|
|
<div class="caption"><span>Enum Constants</span></div>
|
|
<div class="summary-table two-column-summary">
|
|
<div class="table-header col-first">Enum Constant</div>
|
|
<div class="table-header col-last">Description</div>
|
|
<div class="col-first even-row-color"><code><a href="#AQUA" class="member-name-link">AQUA</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Represents aqua</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code><a href="#BLACK" class="member-name-link">BLACK</a></code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">Represents black</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code><a href="#BLUE" class="member-name-link">BLUE</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Represents blue</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code><a href="#BOLD" class="member-name-link">BOLD</a></code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">Makes the text bold.</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code><a href="#DARK_AQUA" class="member-name-link">DARK_AQUA</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Represents dark blue (aqua)</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code><a href="#DARK_BLUE" class="member-name-link">DARK_BLUE</a></code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">Represents dark blue</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code><a href="#DARK_GRAY" class="member-name-link">DARK_GRAY</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Represents dark gray</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code><a href="#DARK_GREEN" class="member-name-link">DARK_GREEN</a></code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">Represents dark green</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code><a href="#DARK_PURPLE" class="member-name-link">DARK_PURPLE</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Represents dark purple</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code><a href="#DARK_RED" class="member-name-link">DARK_RED</a></code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">Represents dark red</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code><a href="#GOLD" class="member-name-link">GOLD</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Represents gold</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code><a href="#GRAY" class="member-name-link">GRAY</a></code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">Represents gray</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code><a href="#GREEN" class="member-name-link">GREEN</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Represents green</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code><a href="#ITALIC" class="member-name-link">ITALIC</a></code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">Makes the text italic.</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code><a href="#LIGHT_PURPLE" class="member-name-link">LIGHT_PURPLE</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Represents light purple</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code><a href="#MAGIC" class="member-name-link">MAGIC</a></code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">Represents magical characters that change around randomly</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code><a href="#RED" class="member-name-link">RED</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Represents red</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code><a href="#RESET" class="member-name-link">RESET</a></code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">Resets all previous chat colors or formats.</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code><a href="#STRIKETHROUGH" class="member-name-link">STRIKETHROUGH</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Makes a line appear through the text.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code><a href="#UNDERLINE" class="member-name-link">UNDERLINE</a></code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">Makes the text appear underlined.</div>
|
|
</div>
|
|
<div class="col-first even-row-color"><code><a href="#WHITE" class="member-name-link">WHITE</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Represents white</div>
|
|
</div>
|
|
<div class="col-first odd-row-color"><code><a href="#YELLOW" class="member-name-link">YELLOW</a></code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">Represents yellow</div>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<!-- =========== FIELD SUMMARY =========== -->
|
|
<li>
|
|
<section class="field-summary" id="field-summary">
|
|
<h2>Field Summary</h2>
|
|
<div class="caption"><span>Fields</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">Field</div>
|
|
<div class="table-header col-last">Description</div>
|
|
<div class="col-first even-row-color"><code>static final char</code></div>
|
|
<div class="col-second even-row-color"><code><a href="#COLOR_CHAR" class="member-name-link">COLOR_CHAR</a></code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">The special character which prefixes all chat colour codes.</div>
|
|
</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-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete 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-tab4"><code><a href="https://javadoc.io/doc/net.md-5/bungeecord-chat/1.16-R0.4/net/md_5/bungee/api/ChatColor.html" title="class or interface in net.md_5.bungee.api" class="external-link">ChatColor</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#asBungee()" class="member-name-link">asBungee</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="ChatColor.html" title="enum class in org.bukkit">ChatColor</a></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getByChar(char)" class="member-name-link">getByChar</a><wbr>(char code)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
|
<div class="block">Gets the color represented by the specified color code</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="ChatColor.html" title="enum class in org.bukkit">ChatColor</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getByChar(java.lang.String)" class="member-name-link">getByChar</a><wbr>(<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <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)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
|
<div class="block">Gets the color represented by the specified color code</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>char</code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getChar()" class="member-name-link">getChar</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Gets the char value associated with this color</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <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-tab1 method-summary-table-tab4"><code><a href="#getLastColors(java.lang.String)" class="member-name-link">getLastColors</a><wbr>(<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <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> input)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
|
<div class="block">Gets the ChatColors used at the end of the given input string.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isColor()" class="member-name-link">isColor</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Checks if this code is a color code as opposed to a format code.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isFormat()" class="member-name-link">isFormat</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Checks if this code is a format code as opposed to a color code.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <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-tab1 method-summary-table-tab4"><code><a href="#stripColor(java.lang.String)" class="member-name-link">stripColor</a><wbr>(<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <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> input)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
|
<div class="block">Strips the given message of all color codes</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <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-tab4"><code><a href="#toString()" class="member-name-link">toString</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <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-tab1 method-summary-table-tab4"><code><a href="#translateAlternateColorCodes(char,java.lang.String)" class="member-name-link">translateAlternateColorCodes</a><wbr>(char altColorChar,
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <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> textToTranslate)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
|
<div class="block">Translates a string using an alternate color code character into a
|
|
string that uses the internal ChatColor.COLOR_CODE color code
|
|
character.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="ChatColor.html" title="enum class in org.bukkit">ChatColor</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#valueOf(java.lang.String)" class="member-name-link">valueOf</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> name)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
|
<div class="block">Returns the enum constant of this class with the specified name.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="ChatColor.html" title="enum class in org.bukkit">ChatColor</a>[]</code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#values()" class="member-name-link">values</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
|
<div class="block">Returns an array containing the constants of this enum class, in
|
|
the order they are declared.</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="inherited-list">
|
|
<h3 id="methods-inherited-from-class-java.lang.Enum">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a></h3>
|
|
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#compareTo(E)" title="class or interface in java.lang" class="external-link">compareTo</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#describeConstable()" title="class or interface in java.lang" class="external-link">describeConstable</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#getDeclaringClass()" title="class or interface in java.lang" class="external-link">getDeclaringClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#name()" title="class or interface in java.lang" class="external-link">name</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#ordinal()" title="class or interface in java.lang" class="external-link">ordinal</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#valueOf(java.lang.Class,java.lang.String)" title="class or interface in java.lang" class="external-link">valueOf</a></code></div>
|
|
<div class="inherited-list">
|
|
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
|
|
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="details">
|
|
<ul class="details-list">
|
|
<!-- ============ ENUM CONSTANT DETAIL =========== -->
|
|
<li>
|
|
<section class="constant-details" id="enum-constant-detail">
|
|
<h2>Enum Constant Details</h2>
|
|
<ul class="member-list">
|
|
<li>
|
|
<section class="detail" id="BLACK">
|
|
<h3>BLACK</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="ChatColor.html" title="enum class in org.bukkit">ChatColor</a></span> <span class="element-name">BLACK</span></div>
|
|
<div class="block">Represents black</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="DARK_BLUE">
|
|
<h3>DARK_BLUE</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="ChatColor.html" title="enum class in org.bukkit">ChatColor</a></span> <span class="element-name">DARK_BLUE</span></div>
|
|
<div class="block">Represents dark blue</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="DARK_GREEN">
|
|
<h3>DARK_GREEN</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="ChatColor.html" title="enum class in org.bukkit">ChatColor</a></span> <span class="element-name">DARK_GREEN</span></div>
|
|
<div class="block">Represents dark green</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="DARK_AQUA">
|
|
<h3>DARK_AQUA</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="ChatColor.html" title="enum class in org.bukkit">ChatColor</a></span> <span class="element-name">DARK_AQUA</span></div>
|
|
<div class="block">Represents dark blue (aqua)</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="DARK_RED">
|
|
<h3>DARK_RED</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="ChatColor.html" title="enum class in org.bukkit">ChatColor</a></span> <span class="element-name">DARK_RED</span></div>
|
|
<div class="block">Represents dark red</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="DARK_PURPLE">
|
|
<h3>DARK_PURPLE</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="ChatColor.html" title="enum class in org.bukkit">ChatColor</a></span> <span class="element-name">DARK_PURPLE</span></div>
|
|
<div class="block">Represents dark purple</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="GOLD">
|
|
<h3>GOLD</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="ChatColor.html" title="enum class in org.bukkit">ChatColor</a></span> <span class="element-name">GOLD</span></div>
|
|
<div class="block">Represents gold</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="GRAY">
|
|
<h3>GRAY</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="ChatColor.html" title="enum class in org.bukkit">ChatColor</a></span> <span class="element-name">GRAY</span></div>
|
|
<div class="block">Represents gray</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="DARK_GRAY">
|
|
<h3>DARK_GRAY</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="ChatColor.html" title="enum class in org.bukkit">ChatColor</a></span> <span class="element-name">DARK_GRAY</span></div>
|
|
<div class="block">Represents dark gray</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="BLUE">
|
|
<h3>BLUE</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="ChatColor.html" title="enum class in org.bukkit">ChatColor</a></span> <span class="element-name">BLUE</span></div>
|
|
<div class="block">Represents blue</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="GREEN">
|
|
<h3>GREEN</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="ChatColor.html" title="enum class in org.bukkit">ChatColor</a></span> <span class="element-name">GREEN</span></div>
|
|
<div class="block">Represents green</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="AQUA">
|
|
<h3>AQUA</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="ChatColor.html" title="enum class in org.bukkit">ChatColor</a></span> <span class="element-name">AQUA</span></div>
|
|
<div class="block">Represents aqua</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="RED">
|
|
<h3>RED</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="ChatColor.html" title="enum class in org.bukkit">ChatColor</a></span> <span class="element-name">RED</span></div>
|
|
<div class="block">Represents red</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="LIGHT_PURPLE">
|
|
<h3>LIGHT_PURPLE</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="ChatColor.html" title="enum class in org.bukkit">ChatColor</a></span> <span class="element-name">LIGHT_PURPLE</span></div>
|
|
<div class="block">Represents light purple</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="YELLOW">
|
|
<h3>YELLOW</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="ChatColor.html" title="enum class in org.bukkit">ChatColor</a></span> <span class="element-name">YELLOW</span></div>
|
|
<div class="block">Represents yellow</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="WHITE">
|
|
<h3>WHITE</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="ChatColor.html" title="enum class in org.bukkit">ChatColor</a></span> <span class="element-name">WHITE</span></div>
|
|
<div class="block">Represents white</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="MAGIC">
|
|
<h3>MAGIC</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="ChatColor.html" title="enum class in org.bukkit">ChatColor</a></span> <span class="element-name">MAGIC</span></div>
|
|
<div class="block">Represents magical characters that change around randomly</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="BOLD">
|
|
<h3>BOLD</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="ChatColor.html" title="enum class in org.bukkit">ChatColor</a></span> <span class="element-name">BOLD</span></div>
|
|
<div class="block">Makes the text bold.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="STRIKETHROUGH">
|
|
<h3>STRIKETHROUGH</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="ChatColor.html" title="enum class in org.bukkit">ChatColor</a></span> <span class="element-name">STRIKETHROUGH</span></div>
|
|
<div class="block">Makes a line appear through the text.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="UNDERLINE">
|
|
<h3>UNDERLINE</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="ChatColor.html" title="enum class in org.bukkit">ChatColor</a></span> <span class="element-name">UNDERLINE</span></div>
|
|
<div class="block">Makes the text appear underlined.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="ITALIC">
|
|
<h3>ITALIC</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="ChatColor.html" title="enum class in org.bukkit">ChatColor</a></span> <span class="element-name">ITALIC</span></div>
|
|
<div class="block">Makes the text italic.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="RESET">
|
|
<h3>RESET</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="ChatColor.html" title="enum class in org.bukkit">ChatColor</a></span> <span class="element-name">RESET</span></div>
|
|
<div class="block">Resets all previous chat colors or formats.</div>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
<!-- ============ FIELD DETAIL =========== -->
|
|
<li>
|
|
<section class="field-details" id="field-detail">
|
|
<h2>Field Details</h2>
|
|
<ul class="member-list">
|
|
<li>
|
|
<section class="detail" id="COLOR_CHAR">
|
|
<h3>COLOR_CHAR</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">char</span> <span class="element-name">COLOR_CHAR</span></div>
|
|
<div class="block">The special character which prefixes all chat colour codes. Use this if
|
|
you need to dynamically convert colour codes from your custom format.</div>
|
|
<dl class="notes">
|
|
<dt>See Also:</dt>
|
|
<dd>
|
|
<ul class="see-list">
|
|
<li><a href="../../constant-values.html#org.bukkit.ChatColor.COLOR_CHAR">Constant Field Values</a></li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
<li>
|
|
<section class="method-details" id="method-detail">
|
|
<h2>Method Details</h2>
|
|
<ul class="member-list">
|
|
<li>
|
|
<section class="detail" id="values()">
|
|
<h3>values</h3>
|
|
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="ChatColor.html" title="enum class in org.bukkit">ChatColor</a>[]</span> <span class="element-name">values</span>()</div>
|
|
<div class="block">Returns an array containing the constants of this enum class, in
|
|
the order they are declared.</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>an array containing the constants of this enum class, in the order they are declared</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="valueOf(java.lang.String)">
|
|
<h3>valueOf</h3>
|
|
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="ChatColor.html" title="enum class in org.bukkit">ChatColor</a></span> <span class="element-name">valueOf</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> name)</span></div>
|
|
<div class="block">Returns the enum constant of this class with the specified name.
|
|
The string must match <i>exactly</i> an identifier used to declare an
|
|
enum constant in this class. (Extraneous whitespace characters are
|
|
not permitted.)</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>name</code> - the name of the enum constant to be returned.</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>the enum constant with the specified name</dd>
|
|
<dt>Throws:</dt>
|
|
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if this enum class has no constant with the specified name</dd>
|
|
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/NullPointerException.html" title="class or interface in java.lang" class="external-link">NullPointerException</a></code> - if the argument is null</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="asBungee()">
|
|
<h3>asBungee</h3>
|
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
|
</span><span class="modifiers">public</span> <span class="return-type"><a href="https://javadoc.io/doc/net.md-5/bungeecord-chat/1.16-R0.4/net/md_5/bungee/api/ChatColor.html" title="class or interface in net.md_5.bungee.api" class="external-link">ChatColor</a></span> <span class="element-name">asBungee</span>()</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getChar()">
|
|
<h3>getChar</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">char</span> <span class="element-name">getChar</span>()</div>
|
|
<div class="block">Gets the char value associated with this color</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>A char value of this color code</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="toString()">
|
|
<h3>toString</h3>
|
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
|
</span><span class="modifiers">public</span> <span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <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">toString</span>()</div>
|
|
<dl class="notes">
|
|
<dt>Overrides:</dt>
|
|
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#toString()" title="class or interface in java.lang" class="external-link">toString</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a><<a href="ChatColor.html" title="enum class in org.bukkit">ChatColor</a>></code></dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="isFormat()">
|
|
<h3>isFormat</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isFormat</span>()</div>
|
|
<div class="block">Checks if this code is a format code as opposed to a color code.</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>whether this ChatColor is a format code</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="isColor()">
|
|
<h3>isColor</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isColor</span>()</div>
|
|
<div class="block">Checks if this code is a color code as opposed to a format code.</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>whether this ChatColor is a color code</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getByChar(char)">
|
|
<h3>getByChar</h3>
|
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a>
|
|
</span><span class="modifiers">public static</span> <span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="ChatColor.html" title="enum class in org.bukkit">ChatColor</a></span> <span class="element-name">getByChar</span><wbr><span class="parameters">(char code)</span></div>
|
|
<div class="block">Gets the color represented by the specified color code</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>code</code> - Code to check</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>Associative <a href="ChatColor.html" title="enum class in org.bukkit"><code>ChatColor</code></a> with the given code,
|
|
or null if it doesn't exist</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getByChar(java.lang.String)">
|
|
<h3>getByChar</h3>
|
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a>
|
|
</span><span class="modifiers">public static</span> <span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="ChatColor.html" title="enum class in org.bukkit">ChatColor</a></span> <span class="element-name">getByChar</span><wbr><span class="parameters">(<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <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)</span></div>
|
|
<div class="block">Gets the color represented by the specified color code</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>code</code> - Code to check</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>Associative <a href="ChatColor.html" title="enum class in org.bukkit"><code>ChatColor</code></a> with the given code,
|
|
or null if it doesn't exist</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="stripColor(java.lang.String)">
|
|
<h3>stripColor</h3>
|
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/Contract.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Contract</a>("!null -> !null; null -> null")
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a>
|
|
</span><span class="modifiers">public static</span> <span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <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">stripColor</span><wbr><span class="parameters">(<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a>
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <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> input)</span></div>
|
|
<div class="block">Strips the given message of all color codes</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>input</code> - String to strip of color</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>A copy of the input string, without any coloring</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="translateAlternateColorCodes(char,java.lang.String)">
|
|
<h3>translateAlternateColorCodes</h3>
|
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
|
</span><span class="modifiers">public static</span> <span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <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">translateAlternateColorCodes</span><wbr><span class="parameters">(char altColorChar,
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <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> textToTranslate)</span></div>
|
|
<div class="block">Translates a string using an alternate color code character into a
|
|
string that uses the internal ChatColor.COLOR_CODE color code
|
|
character. The alternate color code character will only be replaced if
|
|
it is immediately followed by 0-9, A-F, a-f, K-O, k-o, R or r.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>altColorChar</code> - The alternate color code character to replace. Ex: &</dd>
|
|
<dd><code>textToTranslate</code> - Text containing the alternate color code character.</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>Text containing the ChatColor.COLOR_CODE color code character.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getLastColors(java.lang.String)">
|
|
<h3>getLastColors</h3>
|
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
|
</span><span class="modifiers">public static</span> <span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <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">getLastColors</span><wbr><span class="parameters">(<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <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> input)</span></div>
|
|
<div class="block">Gets the ChatColors used at the end of the given input string.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>input</code> - Input string to retrieve the colors from.</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>Any remaining ChatColors to pass onto the next line.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
</main>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|