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/UltraChatAPI.html

936 lines
35 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 Wed Mar 27 22:52:46 MST 2019 -->
<title>UltraChatAPI</title>
<meta name="date" content="2019-03-27">
<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="UltraChatAPI";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":41,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":9,"i17":10,"i18":42,"i19":10,"i20":42,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated 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="class-use/UltraChatAPI.html">Use</a></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/Lang.html" title="enum in me.ryandw11.ultrachat.api"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../me/ryandw11/ultrachat/api/Util.html" title="class 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/UltraChatAPI.html" target="_top">Frames</a></li>
<li><a href="UltraChatAPI.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 UltraChatAPI" class="title">Class UltraChatAPI</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>me.ryandw11.ultrachat.api.UltraChatAPI</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">UltraChatAPI</span>
extends java.lang.Object</pre>
<div class="block">UltraChatAPI</div>
<dl>
<dt><span class="simpleTagLabel">Version:</span></dt>
<dd>2.1.0</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/UltraChatAPI.html#UltraChatAPI-me.ryandw11.ultrachat.UltraChat-">UltraChatAPI</a></span>(<a href="../../../../me/ryandw11/ultrachat/UltraChat.html" title="class in me.ryandw11.ultrachat">UltraChat</a>&nbsp;plugin)</code>&nbsp;</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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated 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>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../me/ryandw11/ultrachat/api/UltraChatAPI.html#createChannel-java.lang.String-java.lang.String-java.lang.String-boolean-java.lang.String-java.util.ArrayList-">createChannel</a></span>(java.lang.String&nbsp;channel,
java.lang.String&nbsp;prefix,
java.lang.String&nbsp;permission,
boolean&nbsp;always_appear,
java.lang.String&nbsp;format,
java.util.ArrayList&lt;java.lang.String&gt;&nbsp;json)</code>
<div class="block">Create a channel.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.util.Set&lt;java.lang.String&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../me/ryandw11/ultrachat/api/UltraChatAPI.html#getActiveHooks--">getActiveHooks</a></span>()</code>
<div class="block">Get the current active hooks.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.util.ArrayList&lt;java.lang.String&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../me/ryandw11/ultrachat/api/UltraChatAPI.html#getChannelJson-java.lang.String-">getChannelJson</a></span>(java.lang.String&nbsp;channel)</code>
<div class="block">Get a channel's json.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../me/ryandw11/ultrachat/api/UltraChatAPI.html#getChatCount--">getChatCount</a></span>()</code>
<div class="block">Get the number of formats</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>java.util.ArrayList&lt;java.lang.String&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../me/ryandw11/ultrachat/api/UltraChatAPI.html#getChatFormatJson-java.lang.String-">getChatFormatJson</a></span>(java.lang.String&nbsp;number)</code>
<div class="block">Get a format's json.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../me/ryandw11/ultrachat/api/UltraChatAPI.html#getDefaultChannel--">getDefaultChannel</a></span>()</code>
<div class="block">Get the servers default channel.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../me/ryandw11/ultrachat/api/UltraChatAPI.html#getDefaultFormat--">getDefaultFormat</a></span>()</code>
<div class="block">Get the default format.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../me/ryandw11/ultrachat/api/UltraChatAPI.html#getFormat-java.lang.String-">getFormat</a></span>(java.lang.String&nbsp;number)</code>
<div class="block">Get a chat format.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../me/ryandw11/ultrachat/api/UltraChatAPI.html#getFormattingType--">getFormattingType</a></span>()</code>
<div class="block">Get the current formatting type.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../me/ryandw11/ultrachat/UltraChat.html" title="class in me.ryandw11.ultrachat">UltraChat</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../me/ryandw11/ultrachat/api/UltraChatAPI.html#getInstance--">getInstance</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;&nbsp;</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="../../../../me/ryandw11/ultrachat/api/ChatMode.html" title="enum in me.ryandw11.ultrachat.api">ChatMode</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../me/ryandw11/ultrachat/api/UltraChatAPI.html#getMode--">getMode</a></span>()</code>
<div class="block">Get the current chat mode.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../me/ryandw11/ultrachat/api/UltraChatAPI.html#getOpFormat--">getOpFormat</a></span>()</code>
<div class="block">Get the op format.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../me/ryandw11/ultrachat/api/UltraChatAPI.html#getPermission-java.lang.String-">getPermission</a></span>(java.lang.String&nbsp;number)</code>
<div class="block">Get the permission of a chat group.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../me/ryandw11/ultrachat/api/UltraChatAPI.html#getPlayerChannel-org.bukkit.entity.Player-">getPlayerChannel</a></span>(org.bukkit.entity.Player&nbsp;player)</code>
<div class="block">Grab the player's current channel.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../me/ryandw11/ultrachat/api/UltraChatAPI.html#getPlayerColor-org.bukkit.entity.Player-">getPlayerColor</a></span>(org.bukkit.entity.Player&nbsp;player)</code>
<div class="block">Get a player's color.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code><a href="../../../../me/ryandw11/ultrachat/formatting/PlayerFormatting.html" title="class in me.ryandw11.ultrachat.formatting">PlayerFormatting</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../me/ryandw11/ultrachat/api/UltraChatAPI.html#getPlayerFormatting-org.bukkit.entity.Player-">getPlayerFormatting</a></span>(org.bukkit.entity.Player&nbsp;p)</code>
<div class="block">Grab the player's formatting.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>static <a href="../../../../me/ryandw11/ultrachat/UltraChat.html" title="class in me.ryandw11.ultrachat">UltraChat</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../me/ryandw11/ultrachat/api/UltraChatAPI.html#getPlugin--">getPlugin</a></span>()</code>
<div class="block">Grab the plugin.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>java.util.ArrayList&lt;java.lang.String&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../me/ryandw11/ultrachat/api/UltraChatAPI.html#getSwearWords--">getSwearWords</a></span>()</code>
<div class="block">Get the swear word list.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../me/ryandw11/ultrachat/api/UltraChatAPI.html#isChannelEnabled--">isChannelEnabled</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">Use getMode()</span></div>
</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../me/ryandw11/ultrachat/api/UltraChatAPI.html#isChannelJson--">isChannelJson</a></span>()</code>
<div class="block">Get if the channel has json enabled or not.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../me/ryandw11/ultrachat/api/UltraChatAPI.html#isJsonEnabled--">isJsonEnabled</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">Use getMode()</span></div>
</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../me/ryandw11/ultrachat/api/UltraChatAPI.html#isRangeJson--">isRangeJson</a></span>()</code>
<div class="block">Get if range has json or not.</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../me/ryandw11/ultrachat/api/UltraChatAPI.html#legitDefaultChannel-java.lang.String-">legitDefaultChannel</a></span>(java.lang.String&nbsp;chan)</code>
<div class="block">See if default channel exists.</div>
</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../me/ryandw11/ultrachat/api/UltraChatAPI.html#removeChannel-java.lang.String-">removeChannel</a></span>(java.lang.String&nbsp;channel)</code>
<div class="block">Remove a channel.</div>
</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../me/ryandw11/ultrachat/api/UltraChatAPI.html#setChannelJson-java.util.ArrayList-java.lang.String-">setChannelJson</a></span>(java.util.ArrayList&lt;java.lang.String&gt;&nbsp;json,
java.lang.String&nbsp;channel)</code>
<div class="block">Set a channel's json.</div>
</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../me/ryandw11/ultrachat/api/UltraChatAPI.html#setChatFormatJson-java.util.ArrayList-java.lang.String-">setChatFormatJson</a></span>(java.util.ArrayList&lt;java.lang.String&gt;&nbsp;json,
java.lang.String&nbsp;number)</code>
<div class="block">Set a format's json.</div>
</td>
</tr>
<tr id="i26" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../me/ryandw11/ultrachat/api/UltraChatAPI.html#setDefaultChannel-java.lang.String-">setDefaultChannel</a></span>(java.lang.String&nbsp;channel)</code>
<div class="block">Set the default channel</div>
</td>
</tr>
<tr id="i27" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../me/ryandw11/ultrachat/api/UltraChatAPI.html#setMode-me.ryandw11.ultrachat.api.ChatMode-">setMode</a></span>(<a href="../../../../me/ryandw11/ultrachat/api/ChatMode.html" title="enum in me.ryandw11.ultrachat.api">ChatMode</a>&nbsp;cm)</code>
<div class="block">Set the chat mode.</div>
</td>
</tr>
<tr id="i28" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../me/ryandw11/ultrachat/api/UltraChatAPI.html#setPlayerChannel-org.bukkit.entity.Player-java.lang.String-">setPlayerChannel</a></span>(org.bukkit.entity.Player&nbsp;player,
java.lang.String&nbsp;channel)</code>
<div class="block">Set the player's channel.</div>
</td>
</tr>
<tr id="i29" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../me/ryandw11/ultrachat/api/UltraChatAPI.html#setPlayerColor-org.bukkit.entity.Player-java.lang.String-">setPlayerColor</a></span>(org.bukkit.entity.Player&nbsp;player,
java.lang.String&nbsp;color)</code>
<div class="block">Set a player's color.</div>
</td>
</tr>
<tr id="i30" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../me/ryandw11/ultrachat/api/UltraChatAPI.html#setSwearWords-java.util.ArrayList-">setSwearWords</a></span>(java.util.ArrayList&lt;java.lang.String&gt;&nbsp;words)</code>
<div class="block">Set the swear word list.</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="UltraChatAPI-me.ryandw11.ultrachat.UltraChat-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>UltraChatAPI</h4>
<pre>public&nbsp;UltraChatAPI(<a href="../../../../me/ryandw11/ultrachat/UltraChat.html" title="class in me.ryandw11.ultrachat">UltraChat</a>&nbsp;plugin)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getInstance--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInstance</h4>
<pre>public static&nbsp;<a href="../../../../me/ryandw11/ultrachat/UltraChat.html" title="class in me.ryandw11.ultrachat">UltraChat</a>&nbsp;getInstance()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Grab the Instance</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>#getPlugin()</dd>
</dl>
</li>
</ul>
<a name="getPlayerChannel-org.bukkit.entity.Player-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPlayerChannel</h4>
<pre>public&nbsp;java.lang.String&nbsp;getPlayerChannel(org.bukkit.entity.Player&nbsp;player)</pre>
<div class="block">Grab the player's current channel.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>player</code> - </dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The player's current channel.</dd>
</dl>
</li>
</ul>
<a name="getDefaultChannel--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDefaultChannel</h4>
<pre>public&nbsp;java.lang.String&nbsp;getDefaultChannel()</pre>
<div class="block">Get the servers default channel.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Default Channel</dd>
</dl>
</li>
</ul>
<a name="setPlayerChannel-org.bukkit.entity.Player-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPlayerChannel</h4>
<pre>public&nbsp;void&nbsp;setPlayerChannel(org.bukkit.entity.Player&nbsp;player,
java.lang.String&nbsp;channel)</pre>
<div class="block">Set the player's channel.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>player</code> - </dd>
<dd><code>channel</code> - </dd>
</dl>
</li>
</ul>
<a name="setDefaultChannel-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDefaultChannel</h4>
<pre>public&nbsp;void&nbsp;setDefaultChannel(java.lang.String&nbsp;channel)</pre>
<div class="block">Set the default channel</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>channel</code> - </dd>
</dl>
</li>
</ul>
<a name="getChannelJson-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getChannelJson</h4>
<pre>public&nbsp;java.util.ArrayList&lt;java.lang.String&gt;&nbsp;getChannelJson(java.lang.String&nbsp;channel)</pre>
<div class="block">Get a channel's json.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>channel</code> - </dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Json array</dd>
</dl>
</li>
</ul>
<a name="getChatFormatJson-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getChatFormatJson</h4>
<pre>public&nbsp;java.util.ArrayList&lt;java.lang.String&gt;&nbsp;getChatFormatJson(java.lang.String&nbsp;number)</pre>
<div class="block">Get a format's json.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>number</code> - </dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Json array</dd>
</dl>
</li>
</ul>
<a name="setChannelJson-java.util.ArrayList-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setChannelJson</h4>
<pre>public&nbsp;void&nbsp;setChannelJson(java.util.ArrayList&lt;java.lang.String&gt;&nbsp;json,
java.lang.String&nbsp;channel)</pre>
<div class="block">Set a channel's json.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>json</code> - </dd>
<dd><code>channel</code> - </dd>
</dl>
</li>
</ul>
<a name="setChatFormatJson-java.util.ArrayList-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setChatFormatJson</h4>
<pre>public&nbsp;void&nbsp;setChatFormatJson(java.util.ArrayList&lt;java.lang.String&gt;&nbsp;json,
java.lang.String&nbsp;number)</pre>
<div class="block">Set a format's json.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>json</code> - </dd>
<dd><code>number</code> - </dd>
</dl>
</li>
</ul>
<a name="isChannelEnabled--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isChannelEnabled</h4>
<pre>public&nbsp;boolean&nbsp;isChannelEnabled()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">Use getMode()</span></div>
<div class="block">Check to see if channels are enabled.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>boolean</dd>
</dl>
</li>
</ul>
<a name="isJsonEnabled--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isJsonEnabled</h4>
<pre>public&nbsp;boolean&nbsp;isJsonEnabled()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">Use getMode()</span></div>
<div class="block">Check to see if json is enabled.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>boolean</dd>
</dl>
</li>
</ul>
<a name="getMode--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMode</h4>
<pre>public&nbsp;<a href="../../../../me/ryandw11/ultrachat/api/ChatMode.html" title="enum in me.ryandw11.ultrachat.api">ChatMode</a>&nbsp;getMode()</pre>
<div class="block">Get the current chat mode.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>chat mode</dd>
</dl>
</li>
</ul>
<a name="setMode-me.ryandw11.ultrachat.api.ChatMode-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMode</h4>
<pre>public&nbsp;void&nbsp;setMode(<a href="../../../../me/ryandw11/ultrachat/api/ChatMode.html" title="enum in me.ryandw11.ultrachat.api">ChatMode</a>&nbsp;cm)</pre>
<div class="block">Set the chat mode. Can be disabled in the config.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>cm</code> - The chat manager</dd>
</dl>
</li>
</ul>
<a name="getPlayerFormatting-org.bukkit.entity.Player-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPlayerFormatting</h4>
<pre>public&nbsp;<a href="../../../../me/ryandw11/ultrachat/formatting/PlayerFormatting.html" title="class in me.ryandw11.ultrachat.formatting">PlayerFormatting</a>&nbsp;getPlayerFormatting(org.bukkit.entity.Player&nbsp;p)</pre>
<div class="block">Grab the player's formatting.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>p</code> - The player.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The player's formatting.</dd>
</dl>
</li>
</ul>
<a name="getFormat-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFormat</h4>
<pre>public&nbsp;java.lang.String&nbsp;getFormat(java.lang.String&nbsp;number)</pre>
<div class="block">Get a chat format.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>number</code> - </dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Chat format.</dd>
</dl>
</li>
</ul>
<a name="getOpFormat--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOpFormat</h4>
<pre>public&nbsp;java.lang.String&nbsp;getOpFormat()</pre>
<div class="block">Get the op format.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>op format.</dd>
</dl>
</li>
</ul>
<a name="getDefaultFormat--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDefaultFormat</h4>
<pre>public&nbsp;java.lang.String&nbsp;getDefaultFormat()</pre>
<div class="block">Get the default format.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>op format.</dd>
</dl>
</li>
</ul>
<a name="getPermission-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPermission</h4>
<pre>public&nbsp;java.lang.String&nbsp;getPermission(java.lang.String&nbsp;number)</pre>
<div class="block">Get the permission of a chat group.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>number</code> - </dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>permission</dd>
</dl>
</li>
</ul>
<a name="getChatCount--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getChatCount</h4>
<pre>public&nbsp;int&nbsp;getChatCount()</pre>
<div class="block">Get the number of formats</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Chat Count</dd>
</dl>
</li>
</ul>
<a name="getPlayerColor-org.bukkit.entity.Player-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPlayerColor</h4>
<pre>public&nbsp;java.lang.String&nbsp;getPlayerColor(org.bukkit.entity.Player&nbsp;player)</pre>
<div class="block">Get a player's color. Example: &4</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>player</code> - </dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>color code.</dd>
</dl>
</li>
</ul>
<a name="setPlayerColor-org.bukkit.entity.Player-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPlayerColor</h4>
<pre>public&nbsp;void&nbsp;setPlayerColor(org.bukkit.entity.Player&nbsp;player,
java.lang.String&nbsp;color)</pre>
<div class="block">Set a player's color.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>player</code> - </dd>
<dd><code>color</code> - </dd>
</dl>
</li>
</ul>
<a name="getSwearWords--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSwearWords</h4>
<pre>public&nbsp;java.util.ArrayList&lt;java.lang.String&gt;&nbsp;getSwearWords()</pre>
<div class="block">Get the swear word list.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Block swear words.</dd>
</dl>
</li>
</ul>
<a name="setSwearWords-java.util.ArrayList-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSwearWords</h4>
<pre>public&nbsp;void&nbsp;setSwearWords(java.util.ArrayList&lt;java.lang.String&gt;&nbsp;words)</pre>
<div class="block">Set the swear word list.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>words</code> - </dd>
</dl>
</li>
</ul>
<a name="createChannel-java.lang.String-java.lang.String-java.lang.String-boolean-java.lang.String-java.util.ArrayList-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createChannel</h4>
<pre>public&nbsp;void&nbsp;createChannel(java.lang.String&nbsp;channel,
java.lang.String&nbsp;prefix,
java.lang.String&nbsp;permission,
boolean&nbsp;always_appear,
java.lang.String&nbsp;format,
java.util.ArrayList&lt;java.lang.String&gt;&nbsp;json)</pre>
<div class="block">Create a channel.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>channel</code> - </dd>
<dd><code>prefix</code> - </dd>
<dd><code>permission</code> - </dd>
<dd><code>always_appear</code> - </dd>
<dd><code>format</code> - </dd>
<dd><code>json</code> - </dd>
</dl>
</li>
</ul>
<a name="removeChannel-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeChannel</h4>
<pre>public&nbsp;void&nbsp;removeChannel(java.lang.String&nbsp;channel)</pre>
<div class="block">Remove a channel.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>channel</code> - </dd>
</dl>
</li>
</ul>
<a name="getPlugin--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPlugin</h4>
<pre>public static&nbsp;<a href="../../../../me/ryandw11/ultrachat/UltraChat.html" title="class in me.ryandw11.ultrachat">UltraChat</a>&nbsp;getPlugin()</pre>
<div class="block">Grab the plugin.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>plugin. Don't worry about the return</dd>
</dl>
</li>
</ul>
<a name="getFormattingType--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFormattingType</h4>
<pre>public&nbsp;java.lang.String&nbsp;getFormattingType()</pre>
<div class="block">Get the current formatting type.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The value of the config.</dd>
</dl>
</li>
</ul>
<a name="isChannelJson--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isChannelJson</h4>
<pre>public&nbsp;boolean&nbsp;isChannelJson()</pre>
<div class="block">Get if the channel has json enabled or not.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>True or false.</dd>
</dl>
</li>
</ul>
<a name="legitDefaultChannel-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>legitDefaultChannel</h4>
<pre>public&nbsp;boolean&nbsp;legitDefaultChannel(java.lang.String&nbsp;chan)</pre>
<div class="block">See if default channel exists.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>chan</code> - - The channel in the config.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>True if it does, false if not.</dd>
</dl>
</li>
</ul>
<a name="isRangeJson--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isRangeJson</h4>
<pre>public&nbsp;boolean&nbsp;isRangeJson()</pre>
<div class="block">Get if range has json or not.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>True or False.</dd>
</dl>
</li>
</ul>
<a name="getActiveHooks--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getActiveHooks</h4>
<pre>public&nbsp;java.util.Set&lt;java.lang.String&gt;&nbsp;getActiveHooks()</pre>
<div class="block">Get the current active hooks.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The set witht the names of the plugins. Returns null if no hooks are active.</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="class-use/UltraChatAPI.html">Use</a></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/Lang.html" title="enum in me.ryandw11.ultrachat.api"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../me/ryandw11/ultrachat/api/Util.html" title="class 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/UltraChatAPI.html" target="_top">Frames</a></li>
<li><a href="UltraChatAPI.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