Files
KSpigot/docs/-k-spigot/net.axay.kspigot.extensions.events/index.html
2021-05-15 22:14:07 +02:00

124 lines
15 KiB
HTML

<html>
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>net.axay.kspigot.extensions.events</title>
<link href="../../../../images/logo-icon.svg" rel="icon" type="image/svg"><script>var pathToRoot = "../../";</script><script type="text/javascript" src="../../scripts/sourceset_dependencies.js" async="async"></script><link href="../../styles/style.css" rel="Stylesheet"><link href="../../styles/logo-styles.css" rel="Stylesheet"><link href="../../styles/jetbrains-mono.css" rel="Stylesheet"><link href="../../styles/main.css" rel="Stylesheet"><script type="text/javascript" src="../../scripts/clipboard.js" async="async"></script><script type="text/javascript" src="../../scripts/navigation-loader.js" async="async"></script><script type="text/javascript" src="../../scripts/platform-content-handler.js" async="async"></script><script type="text/javascript" src="../../scripts/main.js" async="async"></script> </head>
<body>
<div id="container">
<div id="leftColumn"><a href="../../index.html">
<div id="logo"></div>
</a>
<div id="paneSearch"></div>
<div id="sideMenu"></div>
</div>
<div id="main">
<div id="leftToggler"><span class="icon-toggler"></span></div>
<script type="text/javascript" src="../../scripts/main.js"></script> <div class="main-content" id="content" pageIds="KSpigot::net.axay.kspigot.extensions.events////PointingToDeclaration//769193423">
<div class="navigation-wrapper" id="navigation-wrapper">
<div class="breadcrumbs"><a href="../../index.html">KSpigot</a>/<a href="index.html">net.axay.kspigot.extensions.events</a></div>
<div class="pull-right d-flex">
<div id="searchBar"></div>
</div>
</div>
<div class="cover ">
<h1 class="cover"><span>Package net.</span><wbr></wbr><span>axay.</span><wbr></wbr><span>kspigot.</span><wbr></wbr><span>extensions.</span><wbr></wbr><span>events</span></h1>
</div>
<div class="tabbedcontent">
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="Functions">Functions</button><button class="section-tab" data-togglable="Properties">Properties</button></div>
<div class="tabs-section-body">
<h2 class="">Functions</h2>
<div class="table" data-togglable="Functions"><a data-name="750705353%2FFunctions%2F769193423" anchor-label="cancel" id="750705353%2FFunctions%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex"><a href="cancel.html">cancel</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="750705353%2FFunctions%2F769193423"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title"><div class="divergent-group" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="with-platform-tags"><span class="pull-right"></span></div>
<div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace">fun <span data-unresolved-link="org.bukkit.event.inventory/PrepareItemCraftEvent///PointingToDeclaration/">PrepareItemCraftEvent</span>.<a href="cancel.html">cancel</a>()<span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div></div></div>
</div>
<a data-name="750705353%2FFunctions%2F769193423" anchor-label="cancel" id="750705353%2FFunctions%2F769193423" data-filterable-set=":dokkaHtml/main"></a><div class="brief "><a data-name="750705353%2FFunctions%2F769193423" anchor-label="cancel" id="750705353%2FFunctions%2F769193423" data-filterable-set=":dokkaHtml/main"></a>&quot;Cancels&quot; this event by setting the result to <span data-unresolved-link="org.bukkit/Material.AIR///PointingToDeclaration/">Material.AIR</span>.</div></div>
</div>
</div>
</div>
</div>
</div>
<h2 class="">Properties</h2>
<div class="table" data-togglable="Properties"><a data-name="2081958808%2FProperties%2F769193423" anchor-label="clickedBlockExceptAir" id="2081958808%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex"><a href="clicked-block-except-air.html">clickedBlockExceptAir</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="2081958808%2FProperties%2F769193423"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted" data-togglable="Properties"><div class="content sourceset-depenent-content" data-active="" data-togglable=":dokkaHtml/main"><a data-name="2081958808%2FProperties%2F769193423" anchor-label="clickedBlockExceptAir" id="2081958808%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><div class="symbol monospace">val <span data-unresolved-link="org.bukkit.event.player/PlayerInteractEvent///PointingToDeclaration/">PlayerInteractEvent</span>.<a href="clicked-block-except-air.html">clickedBlockExceptAir</a>: <span data-unresolved-link="org.bukkit.block/Block///PointingToDeclaration/">Block</span>?<span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-2137462153%2FProperties%2F769193423" anchor-label="interactItem" id="-2137462153%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex"><a href="interact-item.html">interactItem</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-2137462153%2FProperties%2F769193423"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted" data-togglable="Properties"><div class="content sourceset-depenent-content" data-active="" data-togglable=":dokkaHtml/main"><a data-name="-2137462153%2FProperties%2F769193423" anchor-label="interactItem" id="-2137462153%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><div class="symbol monospace">val <span data-unresolved-link="org.bukkit.event.player/PlayerInteractEntityEvent///PointingToDeclaration/">PlayerInteractEntityEvent</span>.<a href="interact-item.html">interactItem</a>: <span data-unresolved-link="org.bukkit.inventory/ItemStack///PointingToDeclaration/">ItemStack</span>?<span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div><div class="brief "><a data-name="-2137462153%2FProperties%2F769193423" anchor-label="interactItem" id="-2137462153%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a>Returns the item used in the interaction with the use of the <span data-unresolved-link="org.bukkit.inventory/EquipmentSlot///PointingToDeclaration/">EquipmentSlot</span> returned by the value <span data-unresolved-link="org.bukkit.event.player/PlayerInteractEntityEvent/hand/#/PointingToDeclaration/">PlayerInteractEntityEvent.hand</span>.</div></div></div>
</div>
</div>
</div>
</div>
<a data-name="20059040%2FProperties%2F769193423" anchor-label="isCancelled" id="20059040%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex"><a href="is-cancelled.html">isCancelled</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="20059040%2FProperties%2F769193423"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted" data-togglable="Properties"><div class="content sourceset-depenent-content" data-active="" data-togglable=":dokkaHtml/main"><a data-name="20059040%2FProperties%2F769193423" anchor-label="isCancelled" id="20059040%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><div class="symbol monospace">val <span data-unresolved-link="org.bukkit.event.inventory/PrepareItemCraftEvent///PointingToDeclaration/">PrepareItemCraftEvent</span>.<a href="is-cancelled.html">isCancelled</a>: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div><div class="brief "><a data-name="20059040%2FProperties%2F769193423" anchor-label="isCancelled" id="20059040%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a>Checks if the event is &quot;cancelled&quot; by returning if the material of the result is equal to <span data-unresolved-link="org.bukkit/Material.AIR///PointingToDeclaration/">Material.AIR</span>.</div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-1821304507%2FProperties%2F769193423" anchor-label="isLeftClick" id="-1821304507%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex"><a href="is-left-click.html">isLeftClick</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1821304507%2FProperties%2F769193423"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted" data-togglable="Properties"><div class="content sourceset-depenent-content" data-active="" data-togglable=":dokkaHtml/main"><a data-name="-1821304507%2FProperties%2F769193423" anchor-label="isLeftClick" id="-1821304507%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><div class="symbol monospace">val <span data-unresolved-link="org.bukkit.event.block/Action///PointingToDeclaration/">Action</span>.<a href="is-left-click.html">isLeftClick</a>: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div><div class="brief "><a data-name="-1821304507%2FProperties%2F769193423" anchor-label="isLeftClick" id="-1821304507%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="1542654184%2FProperties%2F769193423" anchor-label="isRightClick" id="1542654184%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex"><a href="is-right-click.html">isRightClick</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1542654184%2FProperties%2F769193423"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted" data-togglable="Properties"><div class="content sourceset-depenent-content" data-active="" data-togglable=":dokkaHtml/main"><a data-name="1542654184%2FProperties%2F769193423" anchor-label="isRightClick" id="1542654184%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><div class="symbol monospace">val <span data-unresolved-link="org.bukkit.event.block/Action///PointingToDeclaration/">Action</span>.<a href="is-right-click.html">isRightClick</a>: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div><div class="brief "><a data-name="1542654184%2FProperties%2F769193423" anchor-label="isRightClick" id="1542654184%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a></div></div></div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="footer"><span class="go-to-top-icon"><a href="#content"></a></span><span>© 2021 Copyright</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span></div>
</div>
</div>
</body>
</html>