<!DOCTYPE HTML> <!-- NewPage --> <html lang="en"> <head> <!-- Generated by javadoc (12.0.1) on Fri Nov 01 13:30:56 CDT 2019 --> <title>PowerRegenEvent</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="PowerRegenEvent"; } } catch(err) { } //--> var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":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: </li> <li><a href="#nested.class.summary">Nested</a> | </li> <li><a href="#field.summary">Field</a> | </li> <li><a href="#constructor.summary">Constr</a> | </li> <li><a href="#method.summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>Field | </li> <li><a href="#constructor.detail">Constr</a> | </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"> </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> <a href="package-summary.html">com.massivecraft.factions.event</a></div> <h2 title="Class PowerRegenEvent" class="title">Class PowerRegenEvent</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.PowerRegenEvent</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">PowerRegenEvent</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 regenerate 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 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 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"> </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)">PowerRegenEvent</a></span>​(<a href="../Faction.html" title="interface in com.massivecraft.factions">Faction</a> f, <a href="../FPlayer.html" title="interface in com.massivecraft.factions">FPlayer</a> p)</code></th> <td class="colLast"> </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>double</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCustomPower()">getCustomPower</a></span>()</code></th> <td class="colLast"> <div class="block">Get the amount of custom power this player will gain.</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="#getDefaultPowerGained()">getDefaultPowerGained</a></span>()</code></th> <td class="colLast"> <div class="block">Get the amount of power this player will regen by default</div> </td> </tr> <tr class="altColor" id="i2"> <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"> </td> </tr> <tr class="rowColor" id="i3"> <td class="colFirst"><code>void</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setCancelled(boolean)">setCancelled</a></span>​(boolean c)</code></th> <td class="colLast"> </td> </tr> <tr class="altColor" id="i4"> <td class="colFirst"><code>void</code></td> <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setCustomPower(java.lang.Double)">setCustomPower</a></span>​(java.lang.Double gain)</code></th> <td class="colLast"> <div class="block">Set the custom power gain for this event.</div> </td> </tr> <tr class="rowColor" id="i5"> <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">Get if we will be using the custom power gain instead of default.</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 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 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 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 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="<init>(com.massivecraft.factions.Faction,com.massivecraft.factions.FPlayer)"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>PowerRegenEvent</h4> <pre>public PowerRegenEvent​(<a href="../Faction.html" title="interface in com.massivecraft.factions">Faction</a> f, <a href="../FPlayer.html" title="interface in com.massivecraft.factions">FPlayer</a> 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="getDefaultPowerGained()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getDefaultPowerGained</h4> <pre class="methodSignature">public double getDefaultPowerGained()</pre> <div class="block">Get the amount of power this player will regen by default</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>power amount gained as a Double.</dd> </dl> </li> </ul> <a id="getCustomPower()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getCustomPower</h4> <pre class="methodSignature">public double getCustomPower()</pre> <div class="block">Get the amount of custom power this player will gain. Ignored if less than or equal to 0.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>Custom power as a double</dd> </dl> </li> </ul> <a id="usingCustomPower()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>usingCustomPower</h4> <pre class="methodSignature">public boolean usingCustomPower()</pre> <div class="block">Get if we will be using the custom power gain instead of default.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>If we will process the event custom returned as a Boolean.</dd> </dl> </li> </ul> <a id="setCustomPower(java.lang.Double)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>setCustomPower</h4> <pre class="methodSignature">public void setCustomPower​(java.lang.Double gain)</pre> <div class="block">Set the custom power gain for this event.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>gain</code> - Amount of power to be added to player.</dd> </dl> </li> </ul> <a id="isCancelled()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>isCancelled</h4> <pre class="methodSignature">public boolean isCancelled()</pre> <dl> <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> <dd><code>isCancelled</code> in interface <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 void setCancelled​(boolean c)</pre> <dl> <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> <dd><code>setCancelled</code> in interface <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: </li> <li><a href="#nested.class.summary">Nested</a> | </li> <li><a href="#field.summary">Field</a> | </li> <li><a href="#constructor.summary">Constr</a> | </li> <li><a href="#method.summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>Field | </li> <li><a href="#constructor.detail">Constr</a> | </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>