SubServers-2/JavaDoc/SubServers.Bungee/net/ME1312/SubServers/Bungee/Event/SubStopEvent.html

389 lines
14 KiB
HTML
Raw Normal View History

2017-01-01 22:38:48 +01:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
2017-01-02 01:30:14 +01:00
<!-- Generated by javadoc (1.8.0_111) on Sun Jan 01 19:28:34 EST 2017 -->
2017-01-01 22:38:48 +01:00
<title>SubStopEvent (SubServers.Bungee)</title>
<meta name="date" content="2017-01-01">
<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="SubStopEvent (SubServers.Bungee)";
}
}
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-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../net/ME1312/SubServers/Bungee/Event/SubStartEvent.html" title="class in net.ME1312.SubServers.Bungee.Event"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../net/ME1312/SubServers/Bungee/Event/SubStoppedEvent.html" title="class in net.ME1312.SubServers.Bungee.Event"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?net/ME1312/SubServers/Bungee/Event/SubStopEvent.html" target="_top">Frames</a></li>
<li><a href="SubStopEvent.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">net.ME1312.SubServers.Bungee.Event</div>
<h2 title="Class SubStopEvent" class="title">Class SubStopEvent</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
2017-01-02 00:06:38 +01:00
<li>net.md_5.bungee.api.plugin.Event</li>
2017-01-01 22:38:48 +01:00
<li>
<ul class="inheritance">
<li>net.ME1312.SubServers.Bungee.Event.SubStopEvent</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
2017-01-02 00:06:38 +01:00
<dd>net.md_5.bungee.api.plugin.Cancellable, <a href="../../../../../net/ME1312/SubServers/Bungee/Library/SubEvent.html" title="interface in net.ME1312.SubServers.Bungee.Library">SubEvent</a></dd>
2017-01-01 22:38:48 +01:00
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">SubStopEvent</span>
2017-01-02 00:06:38 +01:00
extends net.md_5.bungee.api.plugin.Event
implements <a href="../../../../../net/ME1312/SubServers/Bungee/Library/SubEvent.html" title="interface in net.ME1312.SubServers.Bungee.Library">SubEvent</a>, net.md_5.bungee.api.plugin.Cancellable</pre>
2017-01-01 22:38:48 +01:00
</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="../../../../../net/ME1312/SubServers/Bungee/Event/SubStopEvent.html#SubStopEvent-java.util.UUID-net.ME1312.SubServers.Bungee.Host.SubServer-boolean-">SubStopEvent</a></span>(java.util.UUID&nbsp;player,
<a href="../../../../../net/ME1312/SubServers/Bungee/Host/SubServer.html" title="class in net.ME1312.SubServers.Bungee.Host">SubServer</a>&nbsp;server,
boolean&nbsp;force)</code>
<div class="block">Server Stop Event</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>java.util.UUID</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../net/ME1312/SubServers/Bungee/Event/SubStopEvent.html#getPlayer--">getPlayer</a></span>()</code>
<div class="block">Gets the player that triggered the Event</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../../net/ME1312/SubServers/Bungee/Host/SubServer.html" title="class in net.ME1312.SubServers.Bungee.Host">SubServer</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../net/ME1312/SubServers/Bungee/Event/SubStopEvent.html#getServer--">getServer</a></span>()</code>
<div class="block">Gets the Server Effected</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../net/ME1312/SubServers/Bungee/Event/SubStopEvent.html#isCancelled--">isCancelled</a></span>()</code>
<div class="block">Gets the Cancelled Status</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../net/ME1312/SubServers/Bungee/Event/SubStopEvent.html#isForced--">isForced</a></span>()</code>
<div class="block">Gets if it was a forced shutdown</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../net/ME1312/SubServers/Bungee/Event/SubStopEvent.html#setCancelled-boolean-">setCancelled</a></span>(boolean&nbsp;value)</code>
<div class="block">Sets the Cancelled Status</div>
</td>
</tr>
</table>
<ul class="blockList">
2017-01-02 00:06:38 +01:00
<li class="blockList"><a name="methods.inherited.from.class.net.md_5.bungee.api.plugin.Event">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;net.md_5.bungee.api.plugin.Event</h3>
<code>postCall</code></li>
</ul>
<ul class="blockList">
2017-01-01 22:38:48 +01:00
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
2017-01-02 00:06:38 +01:00
<code>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
2017-01-01 22:38:48 +01:00
</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="SubStopEvent-java.util.UUID-net.ME1312.SubServers.Bungee.Host.SubServer-boolean-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SubStopEvent</h4>
<pre>public&nbsp;SubStopEvent(java.util.UUID&nbsp;player,
<a href="../../../../../net/ME1312/SubServers/Bungee/Host/SubServer.html" title="class in net.ME1312.SubServers.Bungee.Host">SubServer</a>&nbsp;server,
boolean&nbsp;force)</pre>
<div class="block">Server Stop Event</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>player</code> - Player Stopping Server</dd>
<dd><code>server</code> - Server Stopping</dd>
<dd><code>force</code> - If it was a Forced Shutdown</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="getServer--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getServer</h4>
<pre>public&nbsp;<a href="../../../../../net/ME1312/SubServers/Bungee/Host/SubServer.html" title="class in net.ME1312.SubServers.Bungee.Host">SubServer</a>&nbsp;getServer()</pre>
<div class="block">Gets the Server Effected</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The Server Effected</dd>
</dl>
</li>
</ul>
<a name="getPlayer--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPlayer</h4>
<pre>public&nbsp;java.util.UUID&nbsp;getPlayer()</pre>
<div class="block">Gets the player that triggered the Event</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The Player that triggered this Event or null if Console</dd>
</dl>
</li>
</ul>
<a name="isForced--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isForced</h4>
<pre>public&nbsp;boolean&nbsp;isForced()</pre>
<div class="block">Gets if it was a forced shutdown</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Forced Shutdown Status</dd>
</dl>
</li>
</ul>
<a name="isCancelled--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isCancelled</h4>
<pre>public&nbsp;boolean&nbsp;isCancelled()</pre>
<div class="block">Gets the Cancelled Status</div>
<dl>
2017-01-02 00:06:38 +01:00
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>isCancelled</code>&nbsp;in interface&nbsp;<code>net.md_5.bungee.api.plugin.Cancellable</code></dd>
2017-01-01 22:38:48 +01:00
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Cancelled Status</dd>
</dl>
</li>
</ul>
<a name="setCancelled-boolean-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setCancelled</h4>
<pre>public&nbsp;void&nbsp;setCancelled(boolean&nbsp;value)</pre>
<div class="block">Sets the Cancelled Status</div>
2017-01-02 00:06:38 +01:00
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>setCancelled</code>&nbsp;in interface&nbsp;<code>net.md_5.bungee.api.plugin.Cancellable</code></dd>
</dl>
2017-01-01 22:38:48 +01:00
</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-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../net/ME1312/SubServers/Bungee/Event/SubStartEvent.html" title="class in net.ME1312.SubServers.Bungee.Event"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../net/ME1312/SubServers/Bungee/Event/SubStoppedEvent.html" title="class in net.ME1312.SubServers.Bungee.Event"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?net/ME1312/SubServers/Bungee/Event/SubStopEvent.html" target="_top">Frames</a></li>
<li><a href="SubStopEvent.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>