mirror of
https://github.com/Minestom/Minestom.git
synced 2025-01-08 09:27:58 +01:00
353 lines
17 KiB
HTML
353 lines
17 KiB
HTML
<!DOCTYPE HTML>
|
|
<!-- NewPage -->
|
|
<html lang="en">
|
|
<head>
|
|
<!-- Generated by javadoc -->
|
|
<title>RichMessage (Minestom 1.0 API)</title>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
<meta name="description" content="declaration: package: net.minestom.server.chat, class: RichMessage">
|
|
<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.css" title="Style">
|
|
<script type="text/javascript" src="../../../../script.js"></script>
|
|
<script type="text/javascript" src="../../../../script-dir/jszip/dist/jszip.min.js"></script>
|
|
<script type="text/javascript" src="../../../../script-dir/jszip-utils/dist/jszip-utils.min.js"></script>
|
|
<!--[if IE]>
|
|
<script type="text/javascript" src="../../../../script-dir/jszip-utils/dist/jszip-utils-ie.min.js"></script>
|
|
<![endif]-->
|
|
<script type="text/javascript" src="../../../../script-dir/jquery-3.4.1.js"></script>
|
|
<script type="text/javascript" src="../../../../script-dir/jquery-ui.js"></script>
|
|
</head>
|
|
<body class="class-declaration">
|
|
<script type="text/javascript">var data = {"i0":10,"i1":10,"i2":9,"i3":10,"i4":10,"i5":10};
|
|
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
|
|
var altColor = "altColor";
|
|
var rowColor = "rowColor";
|
|
var tableTab = "tableTab";
|
|
var activeTableTab = "activeTableTab";
|
|
var pathtoroot = "../../../../";
|
|
loadScripts(document, 'script');</script>
|
|
<noscript>
|
|
<div>JavaScript is disabled on your browser.</div>
|
|
</noscript>
|
|
<div class="flexBox">
|
|
<header role="banner" class="flexHeader">
|
|
<nav role="navigation">
|
|
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
<div class="topNav"><a id="navbar.top">
|
|
<!-- -->
|
|
</a>
|
|
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
|
|
<a id="navbar.top.firstrow">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="navList" title="Navigation">
|
|
<li><a href="../../../../index.html">Overview</a></li>
|
|
<li><a href="package-summary.html">Package</a></li>
|
|
<li class="navBarCell1Rev">Class</li>
|
|
<li><a href="package-tree.html">Tree</a></li>
|
|
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
|
|
<li><a href="../../../../index-all.html">Index</a></li>
|
|
<li><a href="../../../../help-doc.html">Help</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="subNav">
|
|
<div>
|
|
<ul class="subNavList">
|
|
<li>Summary: </li>
|
|
<li><a href="#nested.class.summary">Nested</a> | </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </li>
|
|
<li><a href="#method.detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="navListSearch"><label for="search">SEARCH:</label>
|
|
<input type="text" id="search" value="search" disabled="disabled">
|
|
<input type="reset" id="reset" value="reset" disabled="disabled">
|
|
</div>
|
|
</div>
|
|
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
<div class="skipNav"><a id="skip.navbar.top">
|
|
<!-- -->
|
|
</a></div>
|
|
</nav>
|
|
</header>
|
|
<div class="flexContent">
|
|
<main role="main">
|
|
<!-- ======== START OF CLASS DATA ======== -->
|
|
<div class="header">
|
|
<div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">net.minestom.server.chat</a></div>
|
|
<h1 title="Class RichMessage" class="title">Class RichMessage</h1>
|
|
</div>
|
|
<div class="contentContainer">
|
|
<div class="inheritance" title="Inheritance Tree">java.lang.Object
|
|
<div class="inheritance"><a href="JsonMessage.html" title="class in net.minestom.server.chat">net.minestom.server.chat.JsonMessage</a>
|
|
<div class="inheritance">net.minestom.server.chat.RichMessage</div>
|
|
</div>
|
|
</div>
|
|
<section class="description">
|
|
<hr>
|
|
<pre>public class <span class="typeNameLabel">RichMessage</span>
|
|
extends <a href="JsonMessage.html" title="class in net.minestom.server.chat">JsonMessage</a></pre>
|
|
<div class="block">Represents multiple <a href="ColoredText.html" title="class in net.minestom.server.chat"><code>ColoredText</code></a> batched together with the possibility to add
|
|
click and hover events.
|
|
<p>
|
|
Used when the message can contain both colored text and event (otherwise, use <a href="ColoredText.html" title="class in net.minestom.server.chat"><code>ColoredText</code></a>).
|
|
<p>
|
|
You will need to call the static method to initialize the message <a href="#of(net.minestom.server.chat.ColoredText)"><code>of(ColoredText)</code></a>,
|
|
events can be assigned with <a href="#setClickEvent(net.minestom.server.chat.ChatClickEvent)"><code>setClickEvent(ChatClickEvent)</code></a> and <a href="#setHoverEvent(net.minestom.server.chat.ChatHoverEvent)"><code>setHoverEvent(ChatHoverEvent)</code></a>
|
|
and new text element can also be appended <a href="#append(net.minestom.server.chat.ColoredText)"><code>append(ColoredText)</code></a>.</div>
|
|
</section>
|
|
<section class="summary">
|
|
<ul class="blockList">
|
|
<!-- ======== NESTED CLASS SUMMARY ======== -->
|
|
<li class="blockList">
|
|
<section class="nestedClassSummary"><a id="nested.class.summary">
|
|
<!-- -->
|
|
</a>
|
|
<h2>Nested Class Summary</h2>
|
|
<div class="inheritedList">
|
|
<h2>Nested classes/interfaces inherited from class net.minestom.server.chat.<a href="JsonMessage.html" title="class in net.minestom.server.chat">JsonMessage</a></h2>
|
|
<a id="nested.classes.inherited.from.class.net.minestom.server.chat.JsonMessage">
|
|
<!-- -->
|
|
</a><code><a href="JsonMessage.RawJsonMessage.html" title="class in net.minestom.server.chat">JsonMessage.RawJsonMessage</a></code></div>
|
|
</section>
|
|
</li>
|
|
<!-- ========== METHOD SUMMARY =========== -->
|
|
<li class="blockList">
|
|
<section class="methodSummary"><a id="method.summary">
|
|
<!-- -->
|
|
</a>
|
|
<h2>Method Summary</h2>
|
|
<div class="memberSummary">
|
|
<div role="tablist" aria-orientation="horizontal"><button role="tab" aria-selected="true" aria-controls="memberSummary_tabpanel" tabindex="0" onkeydown="switchTab(event)" id="t0" class="activeTableTab">All Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t1" class="tableTab" onclick="show(1);">Static Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t2" class="tableTab" onclick="show(2);">Instance Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t4" class="tableTab" onclick="show(8);">Concrete Methods</button></div>
|
|
<div id="memberSummary_tabpanel" role="tabpanel">
|
|
<table aria-labelledby="t0">
|
|
<thead>
|
|
<tr>
|
|
<th class="colFirst" scope="col">Modifier and Type</th>
|
|
<th class="colSecond" scope="col">Method</th>
|
|
<th class="colLast" scope="col">Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr class="altColor" id="i0">
|
|
<td class="colFirst"><code><a href="RichMessage.html" title="class in net.minestom.server.chat">RichMessage</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#append(net.minestom.server.chat.ColoredText)">append</a></span>​(<a href="ColoredText.html" title="class in net.minestom.server.chat">ColoredText</a> coloredText)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Adds a new rich component to the message.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor" id="i1">
|
|
<td class="colFirst"><code>com.google.gson.JsonObject</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getJsonObject()">getJsonObject</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Gets the json representation of this message.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor" id="i2">
|
|
<td class="colFirst"><code>static <a href="RichMessage.html" title="class in net.minestom.server.chat">RichMessage</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#of(net.minestom.server.chat.ColoredText)">of</a></span>​(<a href="ColoredText.html" title="class in net.minestom.server.chat">ColoredText</a> coloredText)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Creates a <a href="RichMessage.html" title="class in net.minestom.server.chat"><code>RichMessage</code></a> by adding the first rich component.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor" id="i3">
|
|
<td class="colFirst"><code><a href="RichMessage.html" title="class in net.minestom.server.chat">RichMessage</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setClickEvent(net.minestom.server.chat.ChatClickEvent)">setClickEvent</a></span>​(<a href="ChatClickEvent.html" title="class in net.minestom.server.chat">ChatClickEvent</a> clickEvent)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Sets the click event of the current rich component.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor" id="i4">
|
|
<td class="colFirst"><code><a href="RichMessage.html" title="class in net.minestom.server.chat">RichMessage</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setHoverEvent(net.minestom.server.chat.ChatHoverEvent)">setHoverEvent</a></span>​(<a href="ChatHoverEvent.html" title="class in net.minestom.server.chat">ChatHoverEvent</a> hoverEvent)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Sets the hover event of the current rich component.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor" id="i5">
|
|
<td class="colFirst"><code><a href="RichMessage.html" title="class in net.minestom.server.chat">RichMessage</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setInsertion(java.lang.String)">setInsertion</a></span>​(java.lang.String insertion)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Sets the insertion string of the current rich component.</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="inheritedList">
|
|
<h3>Methods inherited from class net.minestom.server.chat.<a href="JsonMessage.html" title="class in net.minestom.server.chat">JsonMessage</a></h3>
|
|
<a id="methods.inherited.from.class.net.minestom.server.chat.JsonMessage">
|
|
<!-- -->
|
|
</a><code><a href="JsonMessage.html#refreshUpdate()">refreshUpdate</a>, <a href="JsonMessage.html#toString()">toString</a></code></div>
|
|
<div class="inheritedList">
|
|
<h3>Methods inherited from class java.lang.Object</h3>
|
|
<a id="methods.inherited.from.class.java.lang.Object">
|
|
<!-- -->
|
|
</a><code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></div>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="details">
|
|
<ul class="blockList">
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
<li class="blockList">
|
|
<section class="methodDetails"><a id="method.detail">
|
|
<!-- -->
|
|
</a>
|
|
<h2>Method Details</h2>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<section class="detail">
|
|
<h3><a id="of(net.minestom.server.chat.ColoredText)">of</a></h3>
|
|
<div class="memberSignature"><span class="modifiers">public static</span> <span class="returnType"><a href="RichMessage.html" title="class in net.minestom.server.chat">RichMessage</a></span> <span class="memberName">of</span>​(<span class="arguments">@NotNull
|
|
<a href="ColoredText.html" title="class in net.minestom.server.chat">ColoredText</a> coloredText)</span></div>
|
|
<div class="block">Creates a <a href="RichMessage.html" title="class in net.minestom.server.chat"><code>RichMessage</code></a> by adding the first rich component.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>coloredText</code> - the text composing the first rich component</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the created rich message object</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li class="blockList">
|
|
<section class="detail">
|
|
<h3><a id="append(net.minestom.server.chat.ColoredText)">append</a></h3>
|
|
<div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="RichMessage.html" title="class in net.minestom.server.chat">RichMessage</a></span> <span class="memberName">append</span>​(<span class="arguments">@NotNull
|
|
<a href="ColoredText.html" title="class in net.minestom.server.chat">ColoredText</a> coloredText)</span></div>
|
|
<div class="block">Adds a new rich component to the message.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>coloredText</code> - the text composing the rich component</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the rich message</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li class="blockList">
|
|
<section class="detail">
|
|
<h3><a id="setClickEvent(net.minestom.server.chat.ChatClickEvent)">setClickEvent</a></h3>
|
|
<div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="RichMessage.html" title="class in net.minestom.server.chat">RichMessage</a></span> <span class="memberName">setClickEvent</span>​(<span class="arguments">@Nullable
|
|
<a href="ChatClickEvent.html" title="class in net.minestom.server.chat">ChatClickEvent</a> clickEvent)</span></div>
|
|
<div class="block">Sets the click event of the current rich component.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>clickEvent</code> - the click event to set</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the rich message</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li class="blockList">
|
|
<section class="detail">
|
|
<h3><a id="setHoverEvent(net.minestom.server.chat.ChatHoverEvent)">setHoverEvent</a></h3>
|
|
<div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="RichMessage.html" title="class in net.minestom.server.chat">RichMessage</a></span> <span class="memberName">setHoverEvent</span>​(<span class="arguments">@Nullable
|
|
<a href="ChatHoverEvent.html" title="class in net.minestom.server.chat">ChatHoverEvent</a> hoverEvent)</span></div>
|
|
<div class="block">Sets the hover event of the current rich component.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>hoverEvent</code> - the hover event to set</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the rich message</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li class="blockList">
|
|
<section class="detail">
|
|
<h3><a id="setInsertion(java.lang.String)">setInsertion</a></h3>
|
|
<div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="RichMessage.html" title="class in net.minestom.server.chat">RichMessage</a></span> <span class="memberName">setInsertion</span>​(<span class="arguments">@Nullable
|
|
java.lang.String insertion)</span></div>
|
|
<div class="block">Sets the insertion string of the current rich component.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>insertion</code> - the string to insert in the chat box</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the rich message</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li class="blockList">
|
|
<section class="detail">
|
|
<h3><a id="getJsonObject()">getJsonObject</a></h3>
|
|
<div class="memberSignature"><span class="annotations">@NotNull
|
|
</span><span class="modifiers">public</span> <span class="returnType">com.google.gson.JsonObject</span> <span class="memberName">getJsonObject</span>()</div>
|
|
<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="JsonMessage.html#getJsonObject()">JsonMessage</a></code></span></div>
|
|
<div class="block">Gets the json representation of this message.
|
|
<p>
|
|
Sent directly to the client.</div>
|
|
<dl>
|
|
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
<dd><code><a href="JsonMessage.html#getJsonObject()">getJsonObject</a></code> in class <code><a href="JsonMessage.html" title="class in net.minestom.server.chat">JsonMessage</a></code></dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the json representation of the message</dd>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="JsonMessage.html#toString()"><code>JsonMessage.toString()</code></a></dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</div>
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
</main>
|
|
<footer role="contentinfo">
|
|
<nav role="navigation">
|
|
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
|
<div class="bottomNav"><a id="navbar.bottom">
|
|
<!-- -->
|
|
</a>
|
|
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
|
|
<a id="navbar.bottom.firstrow">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="navList" title="Navigation">
|
|
<li><a href="../../../../index.html">Overview</a></li>
|
|
<li><a href="package-summary.html">Package</a></li>
|
|
<li class="navBarCell1Rev">Class</li>
|
|
<li><a href="package-tree.html">Tree</a></li>
|
|
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
|
|
<li><a href="../../../../index-all.html">Index</a></li>
|
|
<li><a href="../../../../help-doc.html">Help</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="subNav">
|
|
<div>
|
|
<ul class="subNavList">
|
|
<li>Summary: </li>
|
|
<li><a href="#nested.class.summary">Nested</a> | </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </li>
|
|
<li><a href="#method.detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<a id="skip.navbar.bottom">
|
|
<!-- -->
|
|
</a>
|
|
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|
</nav>
|
|
</footer>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|