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

589 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>PowerLossEvent</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="PowerLossEvent";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":42,"i3":42,"i4":10,"i5":42,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10};
var tabs = {65535:["t0","All 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";
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><a href="#nested.class.summary">Nested</a>&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>Field&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.event</a></div>
<h2 title="Class PowerLossEvent" class="title">Class PowerLossEvent</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.bukkit.event.Event</li>
<li>
<ul class="inheritance">
<li><a href="FactionEvent.html" title="class in com.massivecraft.factions.event">com.massivecraft.factions.event.FactionEvent</a></li>
<li>
<ul class="inheritance">
<li><a href="FactionPlayerEvent.html" title="class in com.massivecraft.factions.event">com.massivecraft.factions.event.FactionPlayerEvent</a></li>
<li>
<ul class="inheritance">
<li>com.massivecraft.factions.event.PowerLossEvent</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code>org.bukkit.event.Cancellable</code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">PowerLossEvent</span>
extends <a href="FactionPlayerEvent.html" title="class in com.massivecraft.factions.event">FactionPlayerEvent</a>
implements org.bukkit.event.Cancellable</pre>
<div class="block">Event called when a player loses power.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<ul class="blockList">
<li class="blockList"><a id="nested.classes.inherited.from.class.org.bukkit.event.Event">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from class&nbsp;org.bukkit.event.Event</h3>
<code>org.bukkit.event.Event.Result</code></li>
</ul>
</li>
</ul>
</section>
<!-- =========== FIELD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a id="fields.inherited.from.class.com.massivecraft.factions.event.FactionPlayerEvent">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;com.massivecraft.factions.event.<a href="FactionPlayerEvent.html" title="class in com.massivecraft.factions.event">FactionPlayerEvent</a></h3>
<code><a href="FactionPlayerEvent.html#fPlayer">fPlayer</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(com.massivecraft.factions.Faction,com.massivecraft.factions.FPlayer)">PowerLossEvent</a></span>&#8203;(<a href="../Faction.html" title="interface in com.massivecraft.factions">Faction</a>&nbsp;f,
<a href="../FPlayer.html" title="interface in com.massivecraft.factions">FPlayer</a>&nbsp;p)</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><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>double</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCustomPowerLost()">getCustomPowerLost</a></span>()</code></th>
<td class="colLast">
<div class="block">Gets the variable power lost.</div>
</td>
</tr>
<tr class="rowColor" id="i1">
<td class="colFirst"><code>double</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDefaultPowerLost()">getDefaultPowerLost</a></span>()</code></th>
<td class="colLast">
<div class="block">Gets the configured damage to a players individual power on death</div>
</td>
</tr>
<tr class="altColor" id="i2">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFactionId()">getFactionId</a></span>()</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">use getFaction().getId() instead.</div>
</div>
</td>
</tr>
<tr class="rowColor" id="i3">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFactionTag()">getFactionTag</a></span>()</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">use getFaction().getTag() instead.</div>
</div>
</td>
</tr>
<tr class="altColor" id="i4">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMessage()">getMessage</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the power loss message.</div>
</td>
</tr>
<tr class="rowColor" id="i5">
<td class="colFirst"><code>org.bukkit.entity.Player</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPlayer()">getPlayer</a></span>()</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">use getfPlayer().getPlayer() instead.</div>
</div>
</td>
</tr>
<tr class="altColor" id="i6">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isCancelled()">isCancelled</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor" id="i7">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setCancelled(boolean)">setCancelled</a></span>&#8203;(boolean&nbsp;c)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor" id="i8">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setCustomPowerLost(java.lang.Double)">setCustomPowerLost</a></span>&#8203;(java.lang.Double&nbsp;loss)</code></th>
<td class="colLast">
<div class="block">Sets the variable power lost.</div>
</td>
</tr>
<tr class="rowColor" id="i9">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setMessage(java.lang.String)">setMessage</a></span>&#8203;(java.lang.String&nbsp;message)</code></th>
<td class="colLast">
<div class="block">Set the power loss message.</div>
</td>
</tr>
<tr class="altColor" id="i10">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#usingCustomPower()">usingCustomPower</a></span>()</code></th>
<td class="colLast">
<div class="block">Determines if custom power is to be used.</div>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.com.massivecraft.factions.event.FactionPlayerEvent">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;com.massivecraft.factions.event.<a href="FactionPlayerEvent.html" title="class in com.massivecraft.factions.event">FactionPlayerEvent</a></h3>
<code><a href="FactionPlayerEvent.html#getfPlayer()">getfPlayer</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.com.massivecraft.factions.event.FactionEvent">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;com.massivecraft.factions.event.<a href="FactionEvent.html" title="class in com.massivecraft.factions.event">FactionEvent</a></h3>
<code><a href="FactionEvent.html#getFaction()">getFaction</a>, <a href="FactionEvent.html#getHandlerList()">getHandlerList</a>, <a href="FactionEvent.html#getHandlers()">getHandlers</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.bukkit.event.Event">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.bukkit.event.Event</h3>
<code>getEventName, isAsynchronous</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">
<!-- ========= 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;(com.massivecraft.factions.Faction,com.massivecraft.factions.FPlayer)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>PowerLossEvent</h4>
<pre>public&nbsp;PowerLossEvent&#8203;(<a href="../Faction.html" title="interface in com.massivecraft.factions">Faction</a>&nbsp;f,
<a href="../FPlayer.html" title="interface in com.massivecraft.factions">FPlayer</a>&nbsp;p)</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="getFactionId()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFactionId</h4>
<pre class="methodSignature">@Deprecated
public&nbsp;java.lang.String&nbsp;getFactionId()</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">use getFaction().getId() instead.</div>
</div>
<div class="block">Get the id of the faction.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>id of faction as String</dd>
</dl>
</li>
</ul>
<a id="getFactionTag()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFactionTag</h4>
<pre class="methodSignature">@Deprecated
public&nbsp;java.lang.String&nbsp;getFactionTag()</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">use getFaction().getTag() instead.</div>
</div>
<div class="block">Get the tag of the faction.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>tag of faction as String</dd>
</dl>
</li>
</ul>
<a id="getPlayer()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPlayer</h4>
<pre class="methodSignature">@Deprecated
public&nbsp;org.bukkit.entity.Player&nbsp;getPlayer()</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">use getfPlayer().getPlayer() instead.</div>
</div>
<div class="block">Get the Player involved in the event.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Player from FPlayer.</dd>
</dl>
</li>
</ul>
<a id="getMessage()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMessage</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;getMessage()</pre>
<div class="block">Get the power loss message.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>power loss message as String.</dd>
</dl>
</li>
</ul>
<a id="setMessage(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMessage</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setMessage&#8203;(java.lang.String&nbsp;message)</pre>
<div class="block">Set the power loss message.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>message</code> - of powerloss</dd>
</dl>
</li>
</ul>
<a id="getDefaultPowerLost()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDefaultPowerLost</h4>
<pre class="methodSignature">public&nbsp;double&nbsp;getDefaultPowerLost()</pre>
<div class="block">Gets the configured damage to a players individual power on death</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>power to be lost as a Double.</dd>
</dl>
</li>
</ul>
<a id="getCustomPowerLost()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCustomPowerLost</h4>
<pre class="methodSignature">public&nbsp;double&nbsp;getCustomPowerLost()</pre>
<div class="block">Gets the variable power lost. Custom power ignored when less than or equal to zero.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>custom power to be lost as a Double.</dd>
</dl>
</li>
</ul>
<a id="setCustomPowerLost(java.lang.Double)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setCustomPowerLost</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setCustomPowerLost&#8203;(java.lang.Double&nbsp;loss)</pre>
<div class="block">Sets the variable power lost. Custom power ignored when less than or equal to zero.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>loss</code> - Double amount for the custom power loss to be set to.</dd>
</dl>
</li>
</ul>
<a id="usingCustomPower()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>usingCustomPower</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;usingCustomPower()</pre>
<div class="block">Determines if custom power is to be used.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>If custom power is to be used as a boolean.</dd>
</dl>
</li>
</ul>
<a id="isCancelled()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isCancelled</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isCancelled()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>isCancelled</code>&nbsp;in interface&nbsp;<code>org.bukkit.event.Cancellable</code></dd>
</dl>
</li>
</ul>
<a id="setCancelled(boolean)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setCancelled</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setCancelled&#8203;(boolean&nbsp;c)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>setCancelled</code>&nbsp;in interface&nbsp;<code>org.bukkit.event.Cancellable</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><a href="#nested.class.summary">Nested</a>&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>Field&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