mirror of
https://github.com/AtlasMediaGroup/Scissors-Website.git
synced 2024-07-03 07:30:02 +00:00
280 lines
23 KiB
HTML
280 lines
23 KiB
HTML
<!DOCTYPE HTML>
|
|
<html lang="en">
|
|
<head>
|
|
<!-- Generated by javadoc (17) -->
|
|
<title>Event (Scissors-API 1.17.1-R0.1-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: org.bukkit.event, class: Event">
|
|
<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">
|
|
<link rel="stylesheet" type="text/css" href="../../../jquery-ui.overrides.css" title="Style">
|
|
<script type="text/javascript" src="../../../script.js"></script>
|
|
<script type="text/javascript" src="../../../script-dir/jquery-3.5.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 evenRowColor = "even-row-color";
|
|
var oddRowColor = "odd-row-color";
|
|
var tableTab = "table-tab";
|
|
var activeTableTab = "active-table-tab";
|
|
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">
|
|
<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>
|
|
</div>
|
|
<div class="sub-nav">
|
|
<div>
|
|
<ul class="sub-nav-list">
|
|
<li>Summary: </li>
|
|
<li><a href="#nested-class-summary">Nested</a> | </li>
|
|
<li>Field | </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>Field | </li>
|
|
<li><a href="#constructor-detail">Constr</a> | </li>
|
|
<li><a href="#method-detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
|
<input type="text" id="search-input" value="search" disabled="disabled">
|
|
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
|
</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">org.bukkit.event</a></div>
|
|
<h1 title="Class Event" class="title">Class Event</h1>
|
|
</div>
|
|
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/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>
|
|
</div>
|
|
<section class="class-description" id="class-description">
|
|
<dl class="notes">
|
|
<dt>Direct Known Subclasses:</dt>
|
|
<dd><code><a href="player/AsyncPlayerPreLoginEvent.html" title="class in org.bukkit.event.player">AsyncPlayerPreLoginEvent</a></code>, <code><a href="../../../com/destroystokyo/paper/event/server/AsyncTabCompleteEvent.html" title="class in com.destroystokyo.paper.event.server">AsyncTabCompleteEvent</a></code>, <code><a href="block/BlockEvent.html" title="class in org.bukkit.event.block">BlockEvent</a></code>, <code><a href="entity/EntityEvent.html" title="class in org.bukkit.event.entity">EntityEvent</a></code>, <code><a href="../../../com/destroystokyo/paper/event/profile/FillProfileEvent.html" title="class in com.destroystokyo.paper.event.profile">FillProfileEvent</a></code>, <code><a href="../../../com/destroystokyo/paper/event/server/GS4QueryEvent.html" title="class in com.destroystokyo.paper.event.server">GS4QueryEvent</a></code>, <code><a href="hanging/HangingEvent.html" title="class in org.bukkit.event.hanging">HangingEvent</a></code>, <code><a href="inventory/InventoryEvent.html" title="class in org.bukkit.event.inventory">InventoryEvent</a></code>, <code><a href="inventory/InventoryMoveItemEvent.html" title="class in org.bukkit.event.inventory">InventoryMoveItemEvent</a></code>, <code><a href="inventory/InventoryPickupItemEvent.html" title="class in org.bukkit.event.inventory">InventoryPickupItemEvent</a></code>, <code><a href="../../../com/destroystokyo/paper/event/profile/LookupProfileEvent.html" title="class in com.destroystokyo.paper.event.profile">LookupProfileEvent</a></code>, <code><a href="../../../com/github/atlasmediagroup/scissors/event/block/MasterBlockFireEvent.html" title="class in com.github.atlasmediagroup.scissors.event.block">MasterBlockFireEvent</a></code>, <code><a href="../../../com/destroystokyo/paper/event/player/PlayerConnectionCloseEvent.html" title="class in com.destroystokyo.paper.event.player">PlayerConnectionCloseEvent</a></code>, <code><a href="player/PlayerEvent.html" title="class in org.bukkit.event.player">PlayerEvent</a></code>, <code><a href="../../../com/destroystokyo/paper/event/player/PlayerHandshakeEvent.html" title="class in com.destroystokyo.paper.event.player">PlayerHandshakeEvent</a></code>, <code><a href="entity/PlayerLeashEntityEvent.html" title="class in org.bukkit.event.entity">PlayerLeashEntityEvent</a></code>, <code><a href="player/PlayerPreLoginEvent.html" title="class in org.bukkit.event.player">PlayerPreLoginEvent</a></code>, <code><a href="../../../com/destroystokyo/paper/event/entity/PreCreatureSpawnEvent.html" title="class in com.destroystokyo.paper.event.entity">PreCreatureSpawnEvent</a></code>, <code><a href="../../../com/destroystokyo/paper/event/profile/PreFillProfileEvent.html" title="class in com.destroystokyo.paper.event.profile">PreFillProfileEvent</a></code>, <code><a href="../../../com/destroystokyo/paper/event/profile/PreLookupProfileEvent.html" title="class in com.destroystokyo.paper.event.profile">PreLookupProfileEvent</a></code>, <code><a href="../../../com/destroystokyo/paper/event/profile/ProfileWhitelistVerifyEvent.html" title="class in com.destroystokyo.paper.event.profile">ProfileWhitelistVerifyEvent</a></code>, <code><a href="server/ServerEvent.html" title="class in org.bukkit.event.server">ServerEvent</a></code>, <code><a href="../../../com/destroystokyo/paper/event/server/ServerExceptionEvent.html" title="class in com.destroystokyo.paper.event.server">ServerExceptionEvent</a></code>, <code><a href="../../../com/destroystokyo/paper/event/server/ServerTickEndEvent.html" title="class in com.destroystokyo.paper.event.server">ServerTickEndEvent</a></code>, <code><a href="../../../com/destroystokyo/paper/event/server/ServerTickStartEvent.html" title="class in com.destroystokyo.paper.event.server">ServerTickStartEvent</a></code>, <code><a href="../../../com/github/atlasmediagroup/scissors/event/player/SpectatorTeleportEvent.html" title="class in com.github.atlasmediagroup.scissors.event.player">SpectatorTeleportEvent</a></code>, <code><a href="server/TabCompleteEvent.html" title="class in org.bukkit.event.server">TabCompleteEvent</a></code>, <code><a href="../../../com/destroystokyo/paper/event/entity/ThrownEggHatchEvent.html" title="class in com.destroystokyo.paper.event.entity">ThrownEggHatchEvent</a></code>, <code><a href="command/UnknownCommandEvent.html" title="class in org.bukkit.event.command">UnknownCommandEvent</a></code>, <code><a href="vehicle/VehicleEvent.html" title="class in org.bukkit.event.vehicle">VehicleEvent</a></code>, <code><a href="weather/WeatherEvent.html" title="class in org.bukkit.event.weather">WeatherEvent</a></code>, <code><a href="../../../com/destroystokyo/paper/event/server/WhitelistToggleEvent.html" title="class in com.destroystokyo.paper.event.server">WhitelistToggleEvent</a></code>, <code><a href="world/WorldEvent.html" title="class in org.bukkit.event.world">WorldEvent</a></code></dd>
|
|
</dl>
|
|
<hr>
|
|
<div class="type-signature"><span class="modifiers">public abstract class </span><span class="element-name type-name-label">Event</span>
|
|
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div>
|
|
<div class="block">Represents an event.
|
|
|
|
All events require a static method named getHandlerList() which returns the same <a href="HandlerList.html" title="class in org.bukkit.event"><code>HandlerList</code></a> as <a href="#getHandlers()"><code>getHandlers()</code></a>.</div>
|
|
<dl class="notes">
|
|
<dt>See Also:</dt>
|
|
<dd>
|
|
<ul class="see-list-long">
|
|
<li><a href="../plugin/PluginManager.html#callEvent(org.bukkit.event.Event)"><code>PluginManager.callEvent(Event)</code></a></li>
|
|
<li><a href="../plugin/PluginManager.html#registerEvents(org.bukkit.event.Listener,org.bukkit.plugin.Plugin)"><code>PluginManager.registerEvents(Listener,Plugin)</code></a></li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
</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="caption"><span>Nested Classes</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">Class</div>
|
|
<div class="table-header col-last">Description</div>
|
|
<div class="col-first even-row-color"><code>static enum </code></div>
|
|
<div class="col-second even-row-color"><code><a href="Event.Result.html" class="type-name-link" title="enum class in org.bukkit.event">Event.Result</a></code></div>
|
|
<div class="col-last even-row-color"> </div>
|
|
</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 two-column-summary">
|
|
<div class="table-header col-first">Constructor</div>
|
|
<div class="table-header col-last">Description</div>
|
|
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">Event</a>()</code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">The default constructor is defined for cleaner code.</div>
|
|
</div>
|
|
<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(boolean)" class="member-name-link">Event</a><wbr>(boolean isAsync)</code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">This constructor is used to explicitly declare an event as synchronous
|
|
or asynchronous.</div>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<!-- ========== METHOD SUMMARY =========== -->
|
|
<li>
|
|
<section class="method-summary" id="method-summary">
|
|
<h2>Method Summary</h2>
|
|
<div id="method-summary-table">
|
|
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
|
|
<div id="method-summary-table.tabpanel" role="tabpanel">
|
|
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
|
|
<div class="table-header col-first">Modifier and Type</div>
|
|
<div class="table-header col-second">Method</div>
|
|
<div class="table-header col-last">Description</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#callEvent()" class="member-name-link">callEvent</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Calls the event and tests if cancelled.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getEventName()" class="member-name-link">getEventName</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Convenience method for providing a user-friendly identifier.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract <a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="HandlerList.html" title="class in org.bukkit.event">HandlerList</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getHandlers()" class="member-name-link">getHandlers</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final boolean</code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isAsynchronous()" class="member-name-link">isAsynchronous</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Any custom event that should not by synchronized with other events must
|
|
use the specific constructor.</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</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/17/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/17/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/17/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/17/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/17/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/17/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/17/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/17/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/17/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/17/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/17/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/17/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>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="details">
|
|
<ul class="details-list">
|
|
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
<li>
|
|
<section class="constructor-details" id="constructor-detail">
|
|
<h2>Constructor Details</h2>
|
|
<ul class="member-list">
|
|
<li>
|
|
<section class="detail" id="<init>()">
|
|
<h3>Event</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">Event</span>()</div>
|
|
<div class="block">The default constructor is defined for cleaner code. This constructor
|
|
assumes the event is synchronous.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="<init>(boolean)">
|
|
<h3>Event</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">Event</span><wbr><span class="parameters">(boolean isAsync)</span></div>
|
|
<div class="block">This constructor is used to explicitly declare an event as synchronous
|
|
or asynchronous.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>isAsync</code> - true indicates the event will fire asynchronously, false
|
|
by default from default constructor</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
<li>
|
|
<section class="method-details" id="method-detail">
|
|
<h2>Method Details</h2>
|
|
<ul class="member-list">
|
|
<li>
|
|
<section class="detail" id="callEvent()">
|
|
<h3>callEvent</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">callEvent</span>()</div>
|
|
<div class="block">Calls the event and tests if cancelled.</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>false if event was cancelled, if cancellable. otherwise true.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getEventName()">
|
|
<h3>getEventName</h3>
|
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
|
</span><span class="modifiers">public</span> <span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getEventName</span>()</div>
|
|
<div class="block">Convenience method for providing a user-friendly identifier. By
|
|
default, it is the event's class's <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html#getSimpleName()" title="class or interface in java.lang" class="external-link">simple name</a>.</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>name of this event</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getHandlers()">
|
|
<h3>getHandlers</h3>
|
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
|
</span><span class="modifiers">public abstract</span> <span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="HandlerList.html" title="class in org.bukkit.event">HandlerList</a></span> <span class="element-name">getHandlers</span>()</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="isAsynchronous()">
|
|
<h3>isAsynchronous</h3>
|
|
<div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">boolean</span> <span class="element-name">isAsynchronous</span>()</div>
|
|
<div class="block">Any custom event that should not by synchronized with other events must
|
|
use the specific constructor. These are the caveats of using an
|
|
asynchronous event:
|
|
<ul>
|
|
<li>The event is never fired from inside code triggered by a
|
|
synchronous event. Attempting to do so results in an <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalStateException.html" title="class or interface in java.lang" class="external-link"><code>IllegalStateException</code></a>.
|
|
<li>However, asynchronous event handlers may fire synchronous or
|
|
asynchronous events
|
|
<li>The event may be fired multiple times simultaneously and in any
|
|
order.
|
|
<li>Any newly registered or unregistered handler is ignored after an
|
|
event starts execution.
|
|
<li>The handlers for this event may block for any length of time.
|
|
<li>Some implementations may selectively declare a specific event use
|
|
as asynchronous. This behavior should be clearly defined.
|
|
<li>Asynchronous calls are not calculated in the plugin timing system.
|
|
</ul></div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>false by default, true if the event fires asynchronously</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
</main>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|