Upstream
/
UltraChat
mirror of https://github.com/ryandw11/UltraChat.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
UltraChat/docs/me/ryandw11/ultrachat/api/JSONChatBuilder.html

400 lines
15 KiB
HTML
Raw Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_112) on Fri Jun 26 19:55:13 MST 2020 -->
<title>JSONChatBuilder</title>
<meta name="date" content="2020-06-26">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="JSONChatBuilder";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.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-files/index-1.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../me/ryandw11/ultrachat/api/ChatType.html" title="enum in me.ryandw11.ultrachat.api"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../me/ryandw11/ultrachat/api/Lang.html" title="enum in me.ryandw11.ultrachat.api"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?me/ryandw11/ultrachat/api/JSONChatBuilder.html" target="_top">Frames</a></li>
<li><a href="JSONChatBuilder.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">me.ryandw11.ultrachat.api</div>
<h2 title="Class JSONChatBuilder" class="title">Class JSONChatBuilder</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>me.ryandw11.ultrachat.api.JSONChatBuilder</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">JSONChatBuilder</span>
extends java.lang.Object</pre>
<div class="block">API to standardize JSONChatBuilding
<p>To be used with the MessageBuilder <a href="../../../../me/ryandw11/ultrachat/api/MessageBuilder.html" title="class in me.ryandw11.ultrachat.api"><code>MessageBuilder</code></a></div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.4</dd>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Ryandw11</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../me/ryandw11/ultrachat/api/JSONChatBuilder.html#JSONChatBuilder-java.lang.String-">JSONChatBuilder</a></span>(java.lang.String&nbsp;displayMessage)</code>
<div class="block">Create a JSON Message</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../me/ryandw11/ultrachat/api/JSONChatBuilder.html#JSONChatBuilder-java.lang.String-org.bukkit.entity.Player-">JSONChatBuilder</a></span>(java.lang.String&nbsp;displayMessage,
org.bukkit.entity.Player&nbsp;p)</code>
<div class="block">Create a JSON Message</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>net.md_5.bungee.api.chat.BaseComponent[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../me/ryandw11/ultrachat/api/JSONChatBuilder.html#build--">build</a></span>()</code>
<div class="block">Build the JSONChatMessage</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../me/ryandw11/ultrachat/api/JSONChatBuilder.html" title="class in me.ryandw11.ultrachat.api">JSONChatBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../me/ryandw11/ultrachat/api/JSONChatBuilder.html#setClickOpenUrl-java.lang.String-">setClickOpenUrl</a></span>(java.lang.String&nbsp;url)</code>
<div class="block">Have the JSON open up a url.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../me/ryandw11/ultrachat/api/JSONChatBuilder.html" title="class in me.ryandw11.ultrachat.api">JSONChatBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../me/ryandw11/ultrachat/api/JSONChatBuilder.html#setClickRunCommand-java.lang.String-">setClickRunCommand</a></span>(java.lang.String&nbsp;command)</code>
<div class="block">Have the JSON run a command.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../me/ryandw11/ultrachat/api/JSONChatBuilder.html" title="class in me.ryandw11.ultrachat.api">JSONChatBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../me/ryandw11/ultrachat/api/JSONChatBuilder.html#setClickSuggestCommand-java.lang.String-">setClickSuggestCommand</a></span>(java.lang.String&nbsp;command)</code>
<div class="block">Have the JSON suggest a command</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../me/ryandw11/ultrachat/api/JSONChatBuilder.html" title="class in me.ryandw11.ultrachat.api">JSONChatBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../me/ryandw11/ultrachat/api/JSONChatBuilder.html#setHoverShowText-java.util.List-">setHoverShowText</a></span>(java.util.List&lt;java.lang.String&gt;&nbsp;lore)</code>
<div class="block">Add a hove message.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="JSONChatBuilder-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>JSONChatBuilder</h4>
<pre>public&nbsp;JSONChatBuilder(java.lang.String&nbsp;displayMessage)</pre>
<div class="block">Create a JSON Message</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>displayMessage</code> - The base string that you would hover or click on.</dd>
</dl>
</li>
</ul>
<a name="JSONChatBuilder-java.lang.String-org.bukkit.entity.Player-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>JSONChatBuilder</h4>
<pre>public&nbsp;JSONChatBuilder(java.lang.String&nbsp;displayMessage,
org.bukkit.entity.Player&nbsp;p)</pre>
<div class="block">Create a JSON Message</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>displayMessage</code> - The base string that you would hover or click on.</dd>
<dd><code>p</code> - The player to use when doing PlaceHolders.</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="setHoverShowText-java.util.List-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setHoverShowText</h4>
<pre>public&nbsp;<a href="../../../../me/ryandw11/ultrachat/api/JSONChatBuilder.html" title="class in me.ryandw11.ultrachat.api">JSONChatBuilder</a>&nbsp;setHoverShowText(java.util.List&lt;java.lang.String&gt;&nbsp;lore)</pre>
<div class="block">Add a hove message. (ChatColors are translated)</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>lore</code> - Lore</dd>
</dl>
</li>
</ul>
<a name="setClickOpenUrl-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setClickOpenUrl</h4>
<pre>public&nbsp;<a href="../../../../me/ryandw11/ultrachat/api/JSONChatBuilder.html" title="class in me.ryandw11.ultrachat.api">JSONChatBuilder</a>&nbsp;setClickOpenUrl(java.lang.String&nbsp;url)</pre>
<div class="block">Have the JSON open up a url.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>url</code> - The url</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The builder</dd>
</dl>
</li>
</ul>
<a name="setClickRunCommand-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setClickRunCommand</h4>
<pre>public&nbsp;<a href="../../../../me/ryandw11/ultrachat/api/JSONChatBuilder.html" title="class in me.ryandw11.ultrachat.api">JSONChatBuilder</a>&nbsp;setClickRunCommand(java.lang.String&nbsp;command)</pre>
<div class="block">Have the JSON run a command.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>command</code> - The command to run</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The builder</dd>
</dl>
</li>
</ul>
<a name="setClickSuggestCommand-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setClickSuggestCommand</h4>
<pre>public&nbsp;<a href="../../../../me/ryandw11/ultrachat/api/JSONChatBuilder.html" title="class in me.ryandw11.ultrachat.api">JSONChatBuilder</a>&nbsp;setClickSuggestCommand(java.lang.String&nbsp;command)</pre>
<div class="block">Have the JSON suggest a command</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>command</code> - The command</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The Builder</dd>
</dl>
</li>
</ul>
<a name="build--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>build</h4>
<pre>public&nbsp;net.md_5.bungee.api.chat.BaseComponent[]&nbsp;build()</pre>
<div class="block">Build the JSONChatMessage</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The BaseComponent[]</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.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-files/index-1.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../me/ryandw11/ultrachat/api/ChatType.html" title="enum in me.ryandw11.ultrachat.api"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../me/ryandw11/ultrachat/api/Lang.html" title="enum in me.ryandw11.ultrachat.api"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?me/ryandw11/ultrachat/api/JSONChatBuilder.html" target="_top">Frames</a></li>
<li><a href="JSONChatBuilder.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink