<!DOCTYPE HTML> <html lang="en"> <head> <!-- Generated by javadoc (21) --> <title>PunishedPlayerEvent (server 1.5-SNAPSHOT API)</title> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <meta name="description" content="declaration: package: dev.plex.event, class: PunishedPlayerEvent"> <meta name="generator" content="javadoc/ClassWriterImpl"> <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../../script-dir/jquery-ui.min.css" title="Style"> <script type="text/javascript" src="../../../script.js"></script> <script type="text/javascript" src="../../../script-dir/jquery-3.6.1.min.js"></script> <script type="text/javascript" src="../../../script-dir/jquery-ui.min.js"></script> </head> <body class="class-declaration-page"> <script type="text/javascript">var pathtoroot = "../../../"; loadScripts(document, 'script');</script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript> <div class="flex-box"> <header role="banner" class="flex-header"> <nav role="navigation"> <!-- ========= START OF TOP NAVBAR ======= --> <div class="top-nav" id="navbar-top"> <button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span> </button> <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a> </div> <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> <li><a href="../../../index.html">Overview</a></li> <li><a href="package-summary.html">Package</a></li> <li class="nav-bar-cell1-rev">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#class">Help</a></li> </ul> <ul class="sub-nav-list-small"> <li> <p>Summary:</p> <ul> <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> </li> <li> <p>Detail:</p> <ul> <li><a href="#field-detail">Field</a></li> <li><a href="#constructor-detail">Constr</a></li> <li>Method</li> </ul> </li> </ul> </div> <div class="sub-nav"> <div id="navbar-sub-list"> <ul class="sub-nav-list"> <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="sub-nav-list"> <li>Detail: </li> <li><a href="#field-detail">Field</a> | </li> <li><a href="#constructor-detail">Constr</a> | </li> <li>Method</li> </ul> </div> <div class="nav-list-search"><a href="../../../search.html">SEARCH</a> <input type="text" id="search-input" disabled placeholder="Search"> <input type="reset" id="reset-button" disabled value="reset"> </div> </div> <!-- ========= END OF TOP NAVBAR ========= --> <span class="skip-nav" id="skip-navbar-top"></span></nav> </header> <div class="flex-content"> <main role="main"> <!-- ======== START OF CLASS DATA ======== --> <div class="header"> <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">dev.plex.event</a></div> <h1 title="Class PunishedPlayerEvent" class="title">Class PunishedPlayerEvent</h1> </div> <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> <div class="inheritance">org.bukkit.event.Event <div class="inheritance">org.bukkit.event.player.PlayerEvent <div class="inheritance">dev.plex.event.PunishedPlayerEvent</div> </div> </div> </div> <section class="class-description" id="class-description"> <dl class="notes"> <dt>All Implemented Interfaces:</dt> <dd><code>org.bukkit.event.Cancellable</code></dd> </dl> <dl class="notes"> <dt>Direct Known Subclasses:</dt> <dd><code><a href="PunishedPlayerFreezeEvent.html" title="class in dev.plex.event">PunishedPlayerFreezeEvent</a></code>, <code><a href="PunishedPlayerLockupEvent.html" title="class in dev.plex.event">PunishedPlayerLockupEvent</a></code>, <code><a href="PunishedPlayerMuteEvent.html" title="class in dev.plex.event">PunishedPlayerMuteEvent</a></code> </dd> </dl> <hr> <div class="type-signature"><span class="modifiers">public abstract class </span><span class="element-name type-name-label">PunishedPlayerEvent</span> <span class="extends-implements">extends org.bukkit.event.player.PlayerEvent implements org.bukkit.event.Cancellable</span></div> <div class="block">Superclass for punishment events</div> </section> <section class="summary"> <ul class="summary-list"> <!-- ======== NESTED CLASS SUMMARY ======== --> <li> <section class="nested-class-summary" id="nested-class-summary"> <h2>Nested Class Summary</h2> <div class="inherited-list"> <h2 id="nested-classes-inherited-from-class-org.bukkit.event.Event">Nested classes/interfaces inherited from class org.bukkit.event.Event</h2> <code>org.bukkit.event.Event.Result</code></div> </section> </li> <!-- =========== FIELD SUMMARY =========== --> <li> <section class="field-summary" id="field-summary"> <h2>Field Summary</h2> <div class="caption"><span>Fields</span></div> <div class="summary-table three-column-summary"> <div class="table-header col-first">Modifier and Type</div> <div class="table-header col-second">Field</div> <div class="table-header col-last">Description</div> <div class="col-first even-row-color"><code>protected boolean</code></div> <div class="col-second even-row-color"><code><a href="#cancelled" class="member-name-link">cancelled</a></code> </div> <div class="col-last even-row-color"> <div class="block">Whether the event was cancelled</div> </div> <div class="col-first odd-row-color"><code>protected <a href="../player/PlexPlayer.html" title="class in dev.plex.player">PlexPlayer</a></code> </div> <div class="col-second odd-row-color"><code><a href="#punishedPlayer" class="member-name-link">punishedPlayer</a></code> </div> <div class="col-last odd-row-color"> <div class="block">The player who was punished</div> </div> </div> <div class="inherited-list"> <h3 id="fields-inherited-from-class-org.bukkit.event.player.PlayerEvent">Fields inherited from class org.bukkit.event.player.PlayerEvent</h3> <code>player</code></div> </section> </li> <!-- ======== CONSTRUCTOR SUMMARY ======== --> <li> <section class="constructor-summary" id="constructor-summary"> <h2>Constructor Summary</h2> <div class="caption"><span>Constructors</span></div> <div class="summary-table three-column-summary"> <div class="table-header col-first">Modifier</div> <div class="table-header col-second">Constructor</div> <div class="table-header col-last">Description</div> <div class="col-first even-row-color"><code>protected </code></div> <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(dev.plex.player.PlexPlayer)" class="member-name-link">PunishedPlayerEvent</a> <wbr> (<a href="../player/PlexPlayer.html" title="class in dev.plex.player">PlexPlayer</a> punishedPlayer)</code> </div> <div class="col-last even-row-color"> <div class="block">Creates an event object</div> </div> </div> </section> </li> <!-- ========== METHOD SUMMARY =========== --> <li> <section class="method-summary" id="method-summary"> <h2>Method Summary</h2> <div class="inherited-list"> <h3 id="methods-inherited-from-class-org.bukkit.event.player.PlayerEvent">Methods inherited from class org.bukkit.event.player.PlayerEvent</h3> <code>getPlayer</code></div> <div class="inherited-list"> <h3 id="methods-inherited-from-class-org.bukkit.event.Event">Methods inherited from class org.bukkit.event.Event</h3> <code>callEvent, getEventName, getHandlers, isAsynchronous</code></div> <div class="inherited-list"> <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> <code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code> </div> <div class="inherited-list"> <h3 id="methods-inherited-from-class-org.bukkit.event.Cancellable">Methods inherited from interface org.bukkit.event.Cancellable</h3> <code>isCancelled, setCancelled</code></div> </section> </li> </ul> </section> <section class="details"> <ul class="details-list"> <!-- ============ FIELD DETAIL =========== --> <li> <section class="field-details" id="field-detail"> <h2>Field Details</h2> <ul class="member-list"> <li> <section class="detail" id="punishedPlayer"> <h3>punishedPlayer</h3> <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="../player/PlexPlayer.html" title="class in dev.plex.player">PlexPlayer</a></span> <span class="element-name">punishedPlayer</span></div> <div class="block">The player who was punished</div> </section> </li> <li> <section class="detail" id="cancelled"> <h3>cancelled</h3> <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">boolean</span> <span class="element-name">cancelled</span></div> <div class="block">Whether the event was cancelled</div> </section> </li> </ul> </section> </li> <!-- ========= CONSTRUCTOR DETAIL ======== --> <li> <section class="constructor-details" id="constructor-detail"> <h2>Constructor Details</h2> <ul class="member-list"> <li> <section class="detail" id="<init>(dev.plex.player.PlexPlayer)"> <h3>PunishedPlayerEvent</h3> <div class="member-signature"><span class="modifiers">protected</span> <span class="element-name">PunishedPlayerEvent</span> <wbr> <span class="parameters">(<a href="../player/PlexPlayer.html" title="class in dev.plex.player">PlexPlayer</a> punishedPlayer)</span> </div> <div class="block">Creates an event object</div> <dl class="notes"> <dt>Parameters:</dt> <dd><code>punishedPlayer</code> - The player who was punished</dd> <dt>See Also:</dt> <dd> <ul class="tag-list"> <li><a href="../player/PlexPlayer.html" title="class in dev.plex.player"><code>PlexPlayer</code></a> </li> </ul> </dd> </dl> </section> </li> </ul> </section> </li> </ul> </section> <!-- ========= END OF CLASS DATA ========= --> </main> </div> </div> </body> </html>