SpigotMC/Saber-Factions
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
57ac2c8c98
Saber-Factions/javadoc/com/massivecraft/factions/Factions.html
DroppingAnvil 35dc4bb481 Fresh javadocs. 
Signed-off-by: DroppingAnvil <dr0pping.4nvi1@gmail.com>
2019-11-01 14:03:36 -05:00

560 lines
20 KiB
HTML
Raw Blame History

<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (12.0.1) on Fri Nov 01 13:30:56 CDT 2019 -->
<title>Factions</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2019-11-01">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
<script type="text/javascript" src="../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../jquery/jquery-3.3.1.js"></script>
<script type="text/javascript" src="../../../jquery/jquery-migrate-3.0.1.js"></script>
<script type="text/javascript" src="../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Factions";
}
}
catch(err) {
}
//-->
var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":9,"i9":38,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= 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-files/index-1.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">com.massivecraft.factions</a></div>
<h2 title="Class Factions" class="title">Class Factions</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>com.massivecraft.factions.Factions</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><code><a href="zcore/persist/MemoryFactions.html" title="class in com.massivecraft.factions.zcore.persist">MemoryFactions</a></code></dd>
</dl>
<hr>
<pre>public abstract class <span class="typeNameLabel">Factions</span>
extends java.lang.Object</pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<div class="memberSummary">
<table>
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><code>protected static <a href="Factions.html" title="class in com.massivecraft.factions">Factions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#instance">instance</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</div>
</li>
</ul>
</section>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<div class="memberSummary">
<table>
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">Factions</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</div>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<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="t3" class="tableTab" onclick="show(4);">Abstract 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><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t6" class="tableTab" onclick="show(32);">Deprecated Methods</button></div>
<div id="memberSummary_tabpanel" role="tabpanel">
<table aria-labelledby="t0">
<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>
<tbody>
<tr class="altColor" id="i0">
<td class="colFirst"><code>abstract <a href="Faction.html" title="interface in com.massivecraft.factions">Faction</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createFaction()">createFaction</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor" id="i1">
<td class="colFirst"><code>abstract void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#forceSave()">forceSave</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor" id="i2">
<td class="colFirst"><code>abstract void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#forceSave(boolean)">forceSave</a></span>&#8203;(boolean&nbsp;sync)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor" id="i3">
<td class="colFirst"><code>abstract java.util.ArrayList&lt;<a href="Faction.html" title="interface in com.massivecraft.factions">Faction</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAllFactions()">getAllFactions</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor" id="i4">
<td class="colFirst"><code>abstract <a href="Faction.html" title="interface in com.massivecraft.factions">Faction</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBestTagMatch(java.lang.String)">getBestTagMatch</a></span>&#8203;(java.lang.String&nbsp;start)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor" id="i5">
<td class="colFirst"><code>abstract <a href="Faction.html" title="interface in com.massivecraft.factions">Faction</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getByTag(java.lang.String)">getByTag</a></span>&#8203;(java.lang.String&nbsp;str)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor" id="i6">
<td class="colFirst"><code>abstract <a href="Faction.html" title="interface in com.massivecraft.factions">Faction</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFactionById(java.lang.String)">getFactionById</a></span>&#8203;(java.lang.String&nbsp;id)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor" id="i7">
<td class="colFirst"><code>abstract java.util.Set&lt;java.lang.String&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFactionTags()">getFactionTags</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor" id="i8">
<td class="colFirst"><code>static <a href="Factions.html" title="class in com.massivecraft.factions">Factions</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getInstance()">getInstance</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor" id="i9">
<td class="colFirst"><code>abstract <a href="Faction.html" title="interface in com.massivecraft.factions">Faction</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getNone()">getNone</a></span>()</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
</td>
</tr>
<tr class="altColor" id="i10">
<td class="colFirst"><code>abstract <a href="Faction.html" title="interface in com.massivecraft.factions">Faction</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSafeZone()">getSafeZone</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor" id="i11">
<td class="colFirst"><code>abstract <a href="Faction.html" title="interface in com.massivecraft.factions">Faction</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getWarZone()">getWarZone</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor" id="i12">
<td class="colFirst"><code>abstract <a href="Faction.html" title="interface in com.massivecraft.factions">Faction</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getWilderness()">getWilderness</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor" id="i13">
<td class="colFirst"><code>abstract boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isTagTaken(java.lang.String)">isTagTaken</a></span>&#8203;(java.lang.String&nbsp;str)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor" id="i14">
<td class="colFirst"><code>abstract boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isValidFactionId(java.lang.String)">isValidFactionId</a></span>&#8203;(java.lang.String&nbsp;id)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor" id="i15">
<td class="colFirst"><code>abstract void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#load()">load</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor" id="i16">
<td class="colFirst"><code>abstract void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeFaction(java.lang.String)">removeFaction</a></span>&#8203;(java.lang.String&nbsp;id)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</div>
</div>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a id="instance">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>instance</h4>
<pre>protected static&nbsp;<a href="Factions.html" title="class in com.massivecraft.factions">Factions</a> instance</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Factions</h4>
<pre>public&nbsp;Factions()</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="getInstance()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInstance</h4>
<pre class="methodSignature">public static&nbsp;<a href="Factions.html" title="class in com.massivecraft.factions">Factions</a>&nbsp;getInstance()</pre>
</li>
</ul>
<a id="getFactionById(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFactionById</h4>
<pre class="methodSignature">public abstract&nbsp;<a href="Faction.html" title="interface in com.massivecraft.factions">Faction</a>&nbsp;getFactionById&#8203;(java.lang.String&nbsp;id)</pre>
</li>
</ul>
<a id="getByTag(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getByTag</h4>
<pre class="methodSignature">public abstract&nbsp;<a href="Faction.html" title="interface in com.massivecraft.factions">Faction</a>&nbsp;getByTag&#8203;(java.lang.String&nbsp;str)</pre>
</li>
</ul>
<a id="getBestTagMatch(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBestTagMatch</h4>
<pre class="methodSignature">public abstract&nbsp;<a href="Faction.html" title="interface in com.massivecraft.factions">Faction</a>&nbsp;getBestTagMatch&#8203;(java.lang.String&nbsp;start)</pre>
</li>
</ul>
<a id="isTagTaken(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isTagTaken</h4>
<pre class="methodSignature">public abstract&nbsp;boolean&nbsp;isTagTaken&#8203;(java.lang.String&nbsp;str)</pre>
</li>
</ul>
<a id="isValidFactionId(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isValidFactionId</h4>
<pre class="methodSignature">public abstract&nbsp;boolean&nbsp;isValidFactionId&#8203;(java.lang.String&nbsp;id)</pre>
</li>
</ul>
<a id="createFaction()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createFaction</h4>
<pre class="methodSignature">public abstract&nbsp;<a href="Faction.html" title="interface in com.massivecraft.factions">Faction</a>&nbsp;createFaction()</pre>
</li>
</ul>
<a id="removeFaction(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeFaction</h4>
<pre class="methodSignature">public abstract&nbsp;void&nbsp;removeFaction&#8203;(java.lang.String&nbsp;id)</pre>
</li>
</ul>
<a id="getFactionTags()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFactionTags</h4>
<pre class="methodSignature">public abstract&nbsp;java.util.Set&lt;java.lang.String&gt;&nbsp;getFactionTags()</pre>
</li>
</ul>
<a id="getAllFactions()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAllFactions</h4>
<pre class="methodSignature">public abstract&nbsp;java.util.ArrayList&lt;<a href="Faction.html" title="interface in com.massivecraft.factions">Faction</a>&gt;&nbsp;getAllFactions()</pre>
</li>
</ul>
<a id="getNone()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNone</h4>
<pre class="methodSignature">@Deprecated
public abstract&nbsp;<a href="Faction.html" title="interface in com.massivecraft.factions">Faction</a>&nbsp;getNone()</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div>
</li>
</ul>
<a id="getWilderness()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWilderness</h4>
<pre class="methodSignature">public abstract&nbsp;<a href="Faction.html" title="interface in com.massivecraft.factions">Faction</a>&nbsp;getWilderness()</pre>
</li>
</ul>
<a id="getSafeZone()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSafeZone</h4>
<pre class="methodSignature">public abstract&nbsp;<a href="Faction.html" title="interface in com.massivecraft.factions">Faction</a>&nbsp;getSafeZone()</pre>
</li>
</ul>
<a id="getWarZone()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWarZone</h4>
<pre class="methodSignature">public abstract&nbsp;<a href="Faction.html" title="interface in com.massivecraft.factions">Faction</a>&nbsp;getWarZone()</pre>
</li>
</ul>
<a id="forceSave()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>forceSave</h4>
<pre class="methodSignature">public abstract&nbsp;void&nbsp;forceSave()</pre>
</li>
</ul>
<a id="forceSave(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>forceSave</h4>
<pre class="methodSignature">public abstract&nbsp;void&nbsp;forceSave&#8203;(boolean&nbsp;sync)</pre>
</li>
</ul>
<a id="load()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>load</h4>
<pre class="methodSignature">public abstract&nbsp;void&nbsp;load()</pre>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<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-files/index-1.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
</footer>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink