Scissors-Website/public/javadoc/1.18.2/org/bukkit/event/Cancellable.html

154 lines
44 KiB
HTML
Raw Permalink Normal View History

2022-07-05 23:33:56 +00:00
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>Cancellable (Scissors-API 1.18.2-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, interface: Cancellable">
<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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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>&nbsp;<a href="package-summary.html">org.bukkit.event</a></div>
<h1 title="Interface Cancellable" class="title">Interface Cancellable</h1>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="../../../io/papermc/paper/event/player/AbstractChatEvent.html" title="class in io.papermc.paper.event.player">AbstractChatEvent</a></code>, <code><a href="../../../com/destroystokyo/paper/event/block/AnvilDamagedEvent.html" title="class in com.destroystokyo.paper.event.block">AnvilDamagedEvent</a></code>, <code><a href="entity/AreaEffectCloudApplyEvent.html" title="class in org.bukkit.event.entity">AreaEffectCloudApplyEvent</a></code>, <code><a href="entity/ArrowBodyCountChangeEvent.html" title="class in org.bukkit.event.entity">ArrowBodyCountChangeEvent</a></code>, <code><a href="../../../io/papermc/paper/event/player/AsyncChatEvent.html" title="class in io.papermc.paper.event.player">AsyncChatEvent</a></code>, <code><a href="player/AsyncPlayerChatEvent.html" title="class in org.bukkit.event.player">AsyncPlayerChatEvent</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="entity/BatToggleSleepEvent.html" title="class in org.bukkit.event.entity">BatToggleSleepEvent</a></code>, <code><a href="../../../com/destroystokyo/paper/event/block/BeaconEffectEvent.html" title="class in com.destroystokyo.paper.event.block">BeaconEffectEvent</a></code>, <code><a href="../../../io/papermc/paper/event/block/BellRevealRaiderEvent.html" title="class in io.papermc.paper.event.block">BellRevealRaiderEvent</a></code>, <code><a href="../../../io/papermc/paper/event/block/BellRingEvent.html" title="class in io.papermc.paper.event.block">BellRingEvent</a></code>, <code><a href="block/BlockBreakEvent.html" title="class in org.bukkit.event.block">BlockBreakEvent</a></code>, <code><a href="block/BlockBurnEvent.html" title="class in org.bukkit.event.block">BlockBurnEvent</a></code>, <code><a href="block/BlockCookEvent.html" title="class in org.bukkit.event.block">BlockCookEvent</a></code>, <code><a href="block/BlockDamageEvent.html" title="class in org.bukkit.event.block">BlockDamageEvent</a></code>, <code><a href="../../../com/destroystokyo/paper/event/block/BlockDestroyEvent.html" title="class in com.destroystokyo.paper.event.block">BlockDestroyEvent</a></code>, <code><a href="block/BlockDispenseArmorEvent.html" title="class in org.bukkit.event.block">BlockDispenseArmorEvent</a></code>, <code><a href="block/BlockDispenseEvent.html" title="class in org.bukkit.event.block">BlockDispenseEvent</a></code>, <code><a href="block/BlockDropItemEvent.html" title="class in org.bukkit.event.block">BlockDropItemEvent</a></code>, <code><a href="block/BlockExplodeEvent.html" title="class in org.bukkit.event.block">BlockExplodeEvent</a></code>, <code><a href="block/BlockFadeEvent.html" title="class in org.bukkit.event.block">BlockFadeEvent</a></code>, <code><a href="block/BlockFertilizeEvent.html" title="class in org.bukkit.event.block">BlockFertilizeEvent</a></code>, <code><a href="block/BlockFormEvent.html" title="class in org.bukkit.event.block">BlockFormEvent</a></code>, <code><a href="block/BlockFromToEvent.html" title="class in org.bukkit.event.block">BlockFromToEvent</a></code>, <code><a href="block/BlockGrowEvent.html" title="class in org.bukkit.event.block">BlockGrowEvent</a></code>, <code><a href="block/BlockIgniteEvent.html" title="class in org.bukkit.event.block">BlockIgniteEvent</a></code>, <code><a href="block/BlockMultiPlaceEvent.html" title="class in org.bukkit.event.block">BlockMultiPlaceEvent</a></code>, <code><a href="block/BlockPhysicsEvent.html" title="class in org.bukkit.event.block">BlockPhysicsEvent</a></code>, <code><a href="block/BlockPistonEvent.html" title="class in org.bukkit.event.block">BlockPistonEvent</a></code>, <code><a href="block/BlockPistonExtendEvent.html" title="class in org.bukkit.event.block">BlockPistonExtendEvent</a></code>, <code><a href="block/BlockPistonRetractEvent.html" title="class in org.bukkit.event.block">BlockPistonRetractEvent</a></code>, <code><a href="block/BlockPlaceEvent.html" title="class in org.bukkit.event.block">BlockPlaceEvent</a>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">Cancellable</span></div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ========== 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></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-tab3"><code>boolean</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#isCancelled()" class="member-name-link">isCancelled</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Gets the cancellation state of this event.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setCancelled(boolean)" class="member-name-link">setCancelled</a><wbr>(boolean&nbsp;cancel)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Sets the cancellation state of this event.</div>
</div>
</div>
</div>
</div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="isCancelled()">
<h3>isCancelled</h3>
<div class="member-signature"><span class="return-type">boolean</span>&nbsp;<span class="element-name">isCancelled</span>()</div>
<div class="block">Gets the cancellation state of this event. A cancelled event will not
be executed in the server, but will still pass to other plugins</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>true if this event is cancelled</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setCancelled(boolean)">
<h3>setCancelled</h3>
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">setCancelled</span><wbr><span class="parameters">(boolean&nbsp;cancel)</span></div>
<div class="block">Sets the cancellation state of this event. A cancelled event will not
be executed in the server, but will still pass to other plugins.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>cancel</code> - true if you wish to cancel this event</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
</div>
</div>
</body>
</html>