Saber-Factions/javadoc/com/massivecraft/factions/cmd/relational/FRelationCommand.html

373 lines
15 KiB
HTML
Raw Permalink Normal View History

<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (12.0.1) on Fri Nov 01 13:30:56 CDT 2019 -->
<title>FRelationCommand</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="FRelationCommand";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":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";
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.cmd.relational</a></div>
<h2 title="Class FRelationCommand" class="title">Class FRelationCommand</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../FCommand.html" title="class in com.massivecraft.factions.cmd">com.massivecraft.factions.cmd.FCommand</a></li>
<li>
<ul class="inheritance">
<li>com.massivecraft.factions.cmd.relational.FRelationCommand</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><code><a href="CmdRelationAlly.html" title="class in com.massivecraft.factions.cmd.relational">CmdRelationAlly</a></code>, <code><a href="CmdRelationEnemy.html" title="class in com.massivecraft.factions.cmd.relational">CmdRelationEnemy</a></code>, <code><a href="CmdRelationNeutral.html" title="class in com.massivecraft.factions.cmd.relational">CmdRelationNeutral</a></code>, <code><a href="CmdRelationTruce.html" title="class in com.massivecraft.factions.cmd.relational">CmdRelationTruce</a></code></dd>
</dl>
<hr>
<pre>public abstract class <span class="typeNameLabel">FRelationCommand</span>
extends <a href="../FCommand.html" title="class in com.massivecraft.factions.cmd">FCommand</a></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><a href="../../struct/Relation.html" title="enum in com.massivecraft.factions.struct">Relation</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#targetRelation">targetRelation</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</div>
<ul class="blockList">
<li class="blockList"><a id="fields.inherited.from.class.com.massivecraft.factions.cmd.FCommand">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;com.massivecraft.factions.cmd.<a href="../FCommand.html" title="class in com.massivecraft.factions.cmd">FCommand</a></h3>
<code><a href="../FCommand.html#aliases">aliases</a>, <a href="../FCommand.html#helpLong">helpLong</a>, <a href="../FCommand.html#optionalArgs">optionalArgs</a>, <a href="../FCommand.html#requiredArgs">requiredArgs</a>, <a href="../FCommand.html#requirements">requirements</a>, <a href="../FCommand.html#sdf">sdf</a>, <a href="../FCommand.html#subCommands">subCommands</a>, <a href="../FCommand.html#visibility">visibility</a></code></li>
</ul>
</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()">FRelationCommand</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="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">
<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><a href="../../zcore/util/TL.html" title="enum in com.massivecraft.factions.zcore.util">TL</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getUsageTranslation()">getUsageTranslation</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor" id="i1">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#perform(com.massivecraft.factions.cmd.CommandContext)">perform</a></span>&#8203;(<a href="../CommandContext.html" title="class in com.massivecraft.factions.cmd">CommandContext</a>&nbsp;context)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</div>
</div>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.com.massivecraft.factions.cmd.FCommand">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;com.massivecraft.factions.cmd.<a href="../FCommand.html" title="class in com.massivecraft.factions.cmd">FCommand</a></h3>
<code><a href="../FCommand.html#addSubCommand(com.massivecraft.factions.cmd.FCommand)">addSubCommand</a>, <a href="../FCommand.html#execute(com.massivecraft.factions.cmd.CommandContext)">execute</a>, <a href="../FCommand.html#getHelpShort()">getHelpShort</a>, <a href="../FCommand.html#getToolTips(com.massivecraft.factions.Faction)">getToolTips</a>, <a href="../FCommand.html#getToolTips(com.massivecraft.factions.FPlayer)">getToolTips</a>, <a href="../FCommand.html#getUsageTemplate(com.massivecraft.factions.cmd.CommandContext)">getUsageTemplate</a>, <a href="../FCommand.html#getUsageTemplate(com.massivecraft.factions.cmd.CommandContext,boolean)">getUsageTemplate</a>, <a href="../FCommand.html#isEnabled(com.massivecraft.factions.cmd.CommandContext)">isEnabled</a>, <a href="../FCommand.html#replaceFactionTags(java.lang.String,com.massivecraft.factions.Faction)">replaceFactionTags</a>, <a href="../FCommand.html#replaceFPlayerTags(java.lang.String,com.massivecraft.factions.FPlayer)">replaceFPlayerTags</a>, <a href="../FCommand.html#setHelpShort(java.lang.String)">setHelpShort</a>, <a href="../FCommand.html#validArgs(com.massivecraft.factions.cmd.CommandContext)">validArgs</a>, <a href="../FCommand.html#validCall(com.massivecraft.factions.cmd.CommandContext)">validCall</a></code></li>
</ul>
<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="targetRelation">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>targetRelation</h4>
<pre>public&nbsp;<a href="../../struct/Relation.html" title="enum in com.massivecraft.factions.struct">Relation</a> targetRelation</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>FRelationCommand</h4>
<pre>public&nbsp;FRelationCommand()</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="perform(com.massivecraft.factions.cmd.CommandContext)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>perform</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;perform&#8203;(<a href="../CommandContext.html" title="class in com.massivecraft.factions.cmd">CommandContext</a>&nbsp;context)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../FCommand.html#perform(com.massivecraft.factions.cmd.CommandContext)">perform</a></code>&nbsp;in class&nbsp;<code><a href="../FCommand.html" title="class in com.massivecraft.factions.cmd">FCommand</a></code></dd>
</dl>
</li>
</ul>
<a id="getUsageTranslation()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getUsageTranslation</h4>
<pre class="methodSignature">public&nbsp;<a href="../../zcore/util/TL.html" title="enum in com.massivecraft.factions.zcore.util">TL</a>&nbsp;getUsageTranslation()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../FCommand.html#getUsageTranslation()">getUsageTranslation</a></code>&nbsp;in class&nbsp;<code><a href="../FCommand.html" title="class in com.massivecraft.factions.cmd">FCommand</a></code></dd>
</dl>
</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>