Updated docs
This commit is contained in:
@@ -1,186 +0,0 @@
|
||||
<html>
|
||||
<head>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
|
||||
<title>SingleListener</title>
|
||||
<link href="../../../images/logo-icon.svg" rel="icon" type="image/svg">
|
||||
<link href="../../../styles/style.css" rel="Stylesheet">
|
||||
<script type="text/javascript" src="../../../scripts/navigationLoader.js" async="async"></script>
|
||||
<script type="text/javascript" src="../../../scripts/platformContentHandler.js" async="async"></script>
|
||||
<script type="text/javascript" src="../../../scripts/sourceset_dependencies.js" async="async"></script>
|
||||
<script type="text/javascript" src="../../../scripts/clipboard.js" async="async"></script>
|
||||
<link href="../../../styles/jetbrains-mono.css" rel="Stylesheet">
|
||||
<script>var pathToRoot = "../../../";</script>
|
||||
</head>
|
||||
<body>
|
||||
<div id="container">
|
||||
<div id="leftColumn">
|
||||
<div id="logo"></div>
|
||||
<div id="paneSearch"></div>
|
||||
<div id="sideMenu"></div>
|
||||
</div>
|
||||
<div id="main">
|
||||
<div id="leftToggler"><span class="icon-toggler"></span></div>
|
||||
<div id="searchBar"></div>
|
||||
<script type="text/javascript" src="../../../scripts/pages.js"></script>
|
||||
<script type="text/javascript" src="../../../scripts/main.js"></script>
|
||||
<div id="content" pageIds="net.axay.kspigot.event/SingleListener///PointingToDeclaration/">
|
||||
<div class="breadcrumbs"><a href="../../index.html">KSpigot</a>/<a href="../index.html">net.axay.kspigot.event</a>/<a href="index.html">SingleListener</a></div>
|
||||
<div class="cover ">
|
||||
<h1 class="cover"><a data-name="singlelistener"></a><span>Single</span><wbr></wbr><span>Listener</span></h1>
|
||||
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":dokkaHtml/main"><p class="paragraph">This class represents a <span data-unresolved-link="org.bukkit.event/Listener///PointingToDeclaration/">Listener</span> with only one event to listen to.</p><div class="symbol monospace">interface <a href="index.html">SingleListener</a><<a href="index.html">T</a> : <span data-unresolved-link="org.bukkit.event/Event///PointingToDeclaration/">Event</span>> : <span data-unresolved-link="org.bukkit.event/Listener///PointingToDeclaration/">Listener</span><span class="top-right-position"><span class="copy-icon"><svg width="24" height="24" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||
<path fill-rule="evenodd" clip-rule="evenodd" d="M5 4H15V16H5V4ZM17 7H19V18V20H17H8V18H17V7Z" fill="black"/>
|
||||
</svg></span><div class="copy-popup-wrapper popup-to-left"><svg width="18" height="18" viewBox="0 0 18 18" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||
<path d="M18 9C18 14 14 18 9 18C4 18 0 14 0 9C0 4 4 0 9 0C14 0 18 4 18 9ZM14.2 6.2L12.8 4.8L7.5 10.1L5.3 7.8L3.8 9.2L7.5 13L14.2 6.2Z" fill="#4DBB5F"/>
|
||||
</svg><span>Content copied to clipboard</span></div></span></div></div></div>
|
||||
</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="Extensions">Extensions</button></div>
|
||||
<div class="tabs-section-body">
|
||||
<h2 class=""><a data-name="functions"></a>Functions</h2>
|
||||
<div class="table" data-togglable="Functions"><a data-name="kotlin/Any/equals/#kotlin.Any?/PointingToDeclaration/"></a>
|
||||
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
|
||||
<div class="main-subrow "><span><a href="../../net.axay.kspigot.utils/-registerable-command/index.html#kotlin/Any/equals/#kotlin.Any?/PointingToDeclaration/">equals</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="kotlin/Any/equals/#kotlin.Any?/PointingToDeclaration/"><svg width="24" height="24" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||
<path d="M21.2496 5.3C20.3496 4.5 19.2496 4 18.0496 4C16.8496 4 15.6496 4.5 14.8496 5.3L10.3496 9.8L11.7496 11.2L16.2496 6.7C17.2496 5.7 18.8496 5.7 19.8496 6.7C20.8496 7.7 20.8496 9.3 19.8496 10.3L15.3496 14.8L16.7496 16.2L21.2496 11.7C22.1496 10.8 22.5496 9.7 22.5496 8.5C22.5496 7.3 22.1496 6.2 21.2496 5.3Z"/>
|
||||
<path d="M8.35 16.7998C7.35 17.7998 5.75 17.7998 4.75 16.7998C3.75 15.7998 3.75 14.1998 4.75 13.1998L9.25 8.6998L7.85 7.2998L3.35 11.7998C1.55 13.5998 1.55 16.3998 3.35 18.1998C4.25 19.0998 5.35 19.4998 6.55 19.4998C7.75 19.4998 8.85 19.0998 9.75 18.1998L14.25 13.6998L12.85 12.2998L8.35 16.7998Z"/>
|
||||
</svg></span>
|
||||
<div class="copy-popup-wrapper "><svg width="18" height="18" viewBox="0 0 18 18" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||
<path d="M18 9C18 14 14 18 9 18C4 18 0 14 0 9C0 4 4 0 9 0C14 0 18 4 18 9ZM14.2 6.2L12.8 4.8L7.5 10.1L5.3 7.8L3.8 9.2L7.5 13L14.2 6.2Z" fill="#4DBB5F"/>
|
||||
</svg><span>Link copied to clipboard</span></div>
|
||||
</span></span></div>
|
||||
<div class="platform-dependent-row keyValue">
|
||||
<div></div>
|
||||
<div class="title"><div class="divergent-group" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="brief-with-platform-tags"><div class="inner-brief-with-platform-tags"></div>
|
||||
<span class="pull-right"></span></div>
|
||||
|
||||
<div class="main-subrow">
|
||||
<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">open operator override fun <a href="../../net.axay.kspigot.utils/-registerable-command/index.html#kotlin/Any/equals/#kotlin.Any?/PointingToDeclaration/">equals</a>(other: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</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"><svg width="24" height="24" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||
<path fill-rule="evenodd" clip-rule="evenodd" d="M5 4H15V16H5V4ZM17 7H19V18V20H17H8V18H17V7Z" fill="black"/>
|
||||
</svg></span><div class="copy-popup-wrapper popup-to-left"><svg width="18" height="18" viewBox="0 0 18 18" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||
<path d="M18 9C18 14 14 18 9 18C4 18 0 14 0 9C0 4 4 0 9 0C14 0 18 4 18 9ZM14.2 6.2L12.8 4.8L7.5 10.1L5.3 7.8L3.8 9.2L7.5 13L14.2 6.2Z" fill="#4DBB5F"/>
|
||||
</svg><span>Content copied to clipboard</span></div></span></div></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<a data-name="kotlin/Any/hashCode/#/PointingToDeclaration/"></a>
|
||||
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
|
||||
<div class="main-subrow "><span><a href="../../net.axay.kspigot.utils/-registerable-command/index.html#kotlin/Any/hashCode/#/PointingToDeclaration/">hashCode</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="kotlin/Any/hashCode/#/PointingToDeclaration/"><svg width="24" height="24" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||
<path d="M21.2496 5.3C20.3496 4.5 19.2496 4 18.0496 4C16.8496 4 15.6496 4.5 14.8496 5.3L10.3496 9.8L11.7496 11.2L16.2496 6.7C17.2496 5.7 18.8496 5.7 19.8496 6.7C20.8496 7.7 20.8496 9.3 19.8496 10.3L15.3496 14.8L16.7496 16.2L21.2496 11.7C22.1496 10.8 22.5496 9.7 22.5496 8.5C22.5496 7.3 22.1496 6.2 21.2496 5.3Z"/>
|
||||
<path d="M8.35 16.7998C7.35 17.7998 5.75 17.7998 4.75 16.7998C3.75 15.7998 3.75 14.1998 4.75 13.1998L9.25 8.6998L7.85 7.2998L3.35 11.7998C1.55 13.5998 1.55 16.3998 3.35 18.1998C4.25 19.0998 5.35 19.4998 6.55 19.4998C7.75 19.4998 8.85 19.0998 9.75 18.1998L14.25 13.6998L12.85 12.2998L8.35 16.7998Z"/>
|
||||
</svg></span>
|
||||
<div class="copy-popup-wrapper "><svg width="18" height="18" viewBox="0 0 18 18" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||
<path d="M18 9C18 14 14 18 9 18C4 18 0 14 0 9C0 4 4 0 9 0C14 0 18 4 18 9ZM14.2 6.2L12.8 4.8L7.5 10.1L5.3 7.8L3.8 9.2L7.5 13L14.2 6.2Z" fill="#4DBB5F"/>
|
||||
</svg><span>Link copied to clipboard</span></div>
|
||||
</span></span></div>
|
||||
<div class="platform-dependent-row keyValue">
|
||||
<div></div>
|
||||
<div class="title"><div class="divergent-group" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="brief-with-platform-tags"><div class="inner-brief-with-platform-tags"></div>
|
||||
<span class="pull-right"></span></div>
|
||||
|
||||
<div class="main-subrow">
|
||||
<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">open override fun <a href="../../net.axay.kspigot.utils/-registerable-command/index.html#kotlin/Any/hashCode/#/PointingToDeclaration/">hashCode</a>(): <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a><span class="top-right-position"><span class="copy-icon"><svg width="24" height="24" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||
<path fill-rule="evenodd" clip-rule="evenodd" d="M5 4H15V16H5V4ZM17 7H19V18V20H17H8V18H17V7Z" fill="black"/>
|
||||
</svg></span><div class="copy-popup-wrapper popup-to-left"><svg width="18" height="18" viewBox="0 0 18 18" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||
<path d="M18 9C18 14 14 18 9 18C4 18 0 14 0 9C0 4 4 0 9 0C14 0 18 4 18 9ZM14.2 6.2L12.8 4.8L7.5 10.1L5.3 7.8L3.8 9.2L7.5 13L14.2 6.2Z" fill="#4DBB5F"/>
|
||||
</svg><span>Content copied to clipboard</span></div></span></div></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<a data-name="net.axay.kspigot.event/SingleListener/onEvent/#TypeParam(bounds=[org.bukkit.event.Event])/PointingToDeclaration/"></a>
|
||||
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
|
||||
<div class="main-subrow "><span><a href="on-event.html">onEvent</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="net.axay.kspigot.event/SingleListener/onEvent/#TypeParam(bounds=[org.bukkit.event.Event])/PointingToDeclaration/"><svg width="24" height="24" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||
<path d="M21.2496 5.3C20.3496 4.5 19.2496 4 18.0496 4C16.8496 4 15.6496 4.5 14.8496 5.3L10.3496 9.8L11.7496 11.2L16.2496 6.7C17.2496 5.7 18.8496 5.7 19.8496 6.7C20.8496 7.7 20.8496 9.3 19.8496 10.3L15.3496 14.8L16.7496 16.2L21.2496 11.7C22.1496 10.8 22.5496 9.7 22.5496 8.5C22.5496 7.3 22.1496 6.2 21.2496 5.3Z"/>
|
||||
<path d="M8.35 16.7998C7.35 17.7998 5.75 17.7998 4.75 16.7998C3.75 15.7998 3.75 14.1998 4.75 13.1998L9.25 8.6998L7.85 7.2998L3.35 11.7998C1.55 13.5998 1.55 16.3998 3.35 18.1998C4.25 19.0998 5.35 19.4998 6.55 19.4998C7.75 19.4998 8.85 19.0998 9.75 18.1998L14.25 13.6998L12.85 12.2998L8.35 16.7998Z"/>
|
||||
</svg></span>
|
||||
<div class="copy-popup-wrapper "><svg width="18" height="18" viewBox="0 0 18 18" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||
<path d="M18 9C18 14 14 18 9 18C4 18 0 14 0 9C0 4 4 0 9 0C14 0 18 4 18 9ZM14.2 6.2L12.8 4.8L7.5 10.1L5.3 7.8L3.8 9.2L7.5 13L14.2 6.2Z" fill="#4DBB5F"/>
|
||||
</svg><span>Link copied to clipboard</span></div>
|
||||
</span></span></div>
|
||||
<div class="platform-dependent-row keyValue">
|
||||
<div></div>
|
||||
<div class="title"><div class="divergent-group" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="brief-with-platform-tags"><div class="inner-brief-with-platform-tags"></div>
|
||||
<span class="pull-right"></span></div>
|
||||
|
||||
<div class="main-subrow">
|
||||
<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">abstract fun <a href="on-event.html">onEvent</a>(event: <a href="index.html">T</a>)<span class="top-right-position"><span class="copy-icon"><svg width="24" height="24" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||
<path fill-rule="evenodd" clip-rule="evenodd" d="M5 4H15V16H5V4ZM17 7H19V18V20H17H8V18H17V7Z" fill="black"/>
|
||||
</svg></span><div class="copy-popup-wrapper popup-to-left"><svg width="18" height="18" viewBox="0 0 18 18" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||
<path d="M18 9C18 14 14 18 9 18C4 18 0 14 0 9C0 4 4 0 9 0C14 0 18 4 18 9ZM14.2 6.2L12.8 4.8L7.5 10.1L5.3 7.8L3.8 9.2L7.5 13L14.2 6.2Z" fill="#4DBB5F"/>
|
||||
</svg><span>Content copied to clipboard</span></div></span></div></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<a data-name="kotlin/Any/toString/#/PointingToDeclaration/"></a>
|
||||
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
|
||||
<div class="main-subrow "><span><a href="../../net.axay.kspigot.utils/-registerable-command/index.html#kotlin/Any/toString/#/PointingToDeclaration/">toString</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="kotlin/Any/toString/#/PointingToDeclaration/"><svg width="24" height="24" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||
<path d="M21.2496 5.3C20.3496 4.5 19.2496 4 18.0496 4C16.8496 4 15.6496 4.5 14.8496 5.3L10.3496 9.8L11.7496 11.2L16.2496 6.7C17.2496 5.7 18.8496 5.7 19.8496 6.7C20.8496 7.7 20.8496 9.3 19.8496 10.3L15.3496 14.8L16.7496 16.2L21.2496 11.7C22.1496 10.8 22.5496 9.7 22.5496 8.5C22.5496 7.3 22.1496 6.2 21.2496 5.3Z"/>
|
||||
<path d="M8.35 16.7998C7.35 17.7998 5.75 17.7998 4.75 16.7998C3.75 15.7998 3.75 14.1998 4.75 13.1998L9.25 8.6998L7.85 7.2998L3.35 11.7998C1.55 13.5998 1.55 16.3998 3.35 18.1998C4.25 19.0998 5.35 19.4998 6.55 19.4998C7.75 19.4998 8.85 19.0998 9.75 18.1998L14.25 13.6998L12.85 12.2998L8.35 16.7998Z"/>
|
||||
</svg></span>
|
||||
<div class="copy-popup-wrapper "><svg width="18" height="18" viewBox="0 0 18 18" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||
<path d="M18 9C18 14 14 18 9 18C4 18 0 14 0 9C0 4 4 0 9 0C14 0 18 4 18 9ZM14.2 6.2L12.8 4.8L7.5 10.1L5.3 7.8L3.8 9.2L7.5 13L14.2 6.2Z" fill="#4DBB5F"/>
|
||||
</svg><span>Link copied to clipboard</span></div>
|
||||
</span></span></div>
|
||||
<div class="platform-dependent-row keyValue">
|
||||
<div></div>
|
||||
<div class="title"><div class="divergent-group" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="brief-with-platform-tags"><div class="inner-brief-with-platform-tags"></div>
|
||||
<span class="pull-right"></span></div>
|
||||
|
||||
<div class="main-subrow">
|
||||
<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">open override fun <a href="../../net.axay.kspigot.utils/-registerable-command/index.html#kotlin/Any/toString/#/PointingToDeclaration/">toString</a>(): <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="top-right-position"><span class="copy-icon"><svg width="24" height="24" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||
<path fill-rule="evenodd" clip-rule="evenodd" d="M5 4H15V16H5V4ZM17 7H19V18V20H17H8V18H17V7Z" fill="black"/>
|
||||
</svg></span><div class="copy-popup-wrapper popup-to-left"><svg width="18" height="18" viewBox="0 0 18 18" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||
<path d="M18 9C18 14 14 18 9 18C4 18 0 14 0 9C0 4 4 0 9 0C14 0 18 4 18 9ZM14.2 6.2L12.8 4.8L7.5 10.1L5.3 7.8L3.8 9.2L7.5 13L14.2 6.2Z" fill="#4DBB5F"/>
|
||||
</svg><span>Content copied to clipboard</span></div></span></div></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<h2 class="tabbedcontent"><a data-name="extensions"></a>Extensions</h2>
|
||||
<div class="table" data-togglable="Extensions"><a data-name="net.axay.kspigot.event//register/net.axay.kspigot.event.SingleListener[TypeParam(bounds=[org.bukkit.event.Event])]#org.bukkit.plugin.Plugin#org.bukkit.event.EventPriority#kotlin.Boolean/PointingToDeclaration/"></a>
|
||||
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
|
||||
<div class="main-subrow "><span><a href="../register.html">register</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="net.axay.kspigot.event//register/net.axay.kspigot.event.SingleListener[TypeParam(bounds=[org.bukkit.event.Event])]#org.bukkit.plugin.Plugin#org.bukkit.event.EventPriority#kotlin.Boolean/PointingToDeclaration/"><svg width="24" height="24" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||
<path d="M21.2496 5.3C20.3496 4.5 19.2496 4 18.0496 4C16.8496 4 15.6496 4.5 14.8496 5.3L10.3496 9.8L11.7496 11.2L16.2496 6.7C17.2496 5.7 18.8496 5.7 19.8496 6.7C20.8496 7.7 20.8496 9.3 19.8496 10.3L15.3496 14.8L16.7496 16.2L21.2496 11.7C22.1496 10.8 22.5496 9.7 22.5496 8.5C22.5496 7.3 22.1496 6.2 21.2496 5.3Z"/>
|
||||
<path d="M8.35 16.7998C7.35 17.7998 5.75 17.7998 4.75 16.7998C3.75 15.7998 3.75 14.1998 4.75 13.1998L9.25 8.6998L7.85 7.2998L3.35 11.7998C1.55 13.5998 1.55 16.3998 3.35 18.1998C4.25 19.0998 5.35 19.4998 6.55 19.4998C7.75 19.4998 8.85 19.0998 9.75 18.1998L14.25 13.6998L12.85 12.2998L8.35 16.7998Z"/>
|
||||
</svg></span>
|
||||
<div class="copy-popup-wrapper "><svg width="18" height="18" viewBox="0 0 18 18" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||
<path d="M18 9C18 14 14 18 9 18C4 18 0 14 0 9C0 4 4 0 9 0C14 0 18 4 18 9ZM14.2 6.2L12.8 4.8L7.5 10.1L5.3 7.8L3.8 9.2L7.5 13L14.2 6.2Z" fill="#4DBB5F"/>
|
||||
</svg><span>Link copied to clipboard</span></div>
|
||||
</span></span></div>
|
||||
<div class="platform-dependent-row keyValue">
|
||||
<div></div>
|
||||
<div class="title"><div class="divergent-group" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="brief-with-platform-tags"><div class="inner-brief-with-platform-tags"><div class="brief "><p class="paragraph">Registers the <a href="index.html">SingleListener</a> with its event listener.</p></div></div>
|
||||
<span class="pull-right"></span></div>
|
||||
|
||||
<div class="main-subrow">
|
||||
<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">inline fun <<a href="../register.html">T</a> : <span data-unresolved-link="org.bukkit.event/Event///PointingToDeclaration/">Event</span>> <a href="index.html">SingleListener</a><<a href="../register.html">T</a>>.<a href="../register.html">register</a>(plugin: <span data-unresolved-link="org.bukkit.plugin/Plugin///PointingToDeclaration/">Plugin</span>, priority: <span data-unresolved-link="org.bukkit.event/EventPriority///PointingToDeclaration/">EventPriority</span>, ignoreCancelled: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a>)<span class="top-right-position"><span class="copy-icon"><svg width="24" height="24" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||
<path fill-rule="evenodd" clip-rule="evenodd" d="M5 4H15V16H5V4ZM17 7H19V18V20H17H8V18H17V7Z" fill="black"/>
|
||||
</svg></span><div class="copy-popup-wrapper popup-to-left"><svg width="18" height="18" viewBox="0 0 18 18" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||
<path d="M18 9C18 14 14 18 9 18C4 18 0 14 0 9C0 4 4 0 9 0C14 0 18 4 18 9ZM14.2 6.2L12.8 4.8L7.5 10.1L5.3 7.8L3.8 9.2L7.5 13L14.2 6.2Z" fill="#4DBB5F"/>
|
||||
</svg><span>Content copied to clipboard</span></div></span></div></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="footer"><span class="go-to-top-icon"><a href="#container"><svg width="12" height="10" viewBox="0 0 12 10" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||
<path d="M11.3337 9.66683H0.666992L6.00033 3.66683L11.3337 9.66683Z" fill="black"/>
|
||||
<path d="M0.666992 0.333496H11.3337V1.66683H0.666992V0.333496Z" fill="black"/>
|
||||
</svg></a></span><span>© 2020 Copyright</span><span class="pull-right"><span>Sponsored and developed by dokka</span><a href="https://github.com/Kotlin/dokka"><span class="padded-icon"><svg width="8" height="8" viewBox="0 0 8 8" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||
<path d="M8 0H2.3949L4.84076 2.44586L0 7.28662L0.713376 8L5.55414 3.15924L8 5.6051V0Z" fill="black"/>
|
||||
</svg></span></a></span></div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
@@ -0,0 +1,31 @@
|
||||
---
|
||||
title: SingleListener -
|
||||
---
|
||||
//[KSpigot](../../index.md)/[net.axay.kspigot.event](../index.md)/[SingleListener](index.md)
|
||||
|
||||
|
||||
|
||||
# SingleListener
|
||||
[jvm]
|
||||
|
||||
This class represents a Listener with only one event to listen to.
|
||||
|
||||
interface [SingleListener](index.md)<[T](index.md) : Event> : Listener
|
||||
|
||||
|
||||
## Functions
|
||||
|
||||
| Name| Summary|
|
||||
|---|---|
|
||||
| [equals](../../net.axay.kspigot.utils/-registerable-command/index.md#kotlin/Any/equals/#kotlin.Any?/PointingToDeclaration/)| [jvm] <br>Content <br>open operator override fun [equals](../../net.axay.kspigot.utils/-registerable-command/index.md#kotlin/Any/equals/#kotlin.Any?/PointingToDeclaration/)(other: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)?): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) <br><br><br>
|
||||
| [hashCode](../../net.axay.kspigot.utils/-registerable-command/index.md#kotlin/Any/hashCode/#/PointingToDeclaration/)| [jvm] <br>Content <br>open override fun [hashCode](../../net.axay.kspigot.utils/-registerable-command/index.md#kotlin/Any/hashCode/#/PointingToDeclaration/)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) <br><br><br>
|
||||
| [onEvent](on-event.md)| [jvm] <br>Content <br>abstract fun [onEvent](on-event.md)(event: [T](index.md)) <br><br><br>
|
||||
| [toString](../../net.axay.kspigot.utils/-registerable-command/index.md#kotlin/Any/toString/#/PointingToDeclaration/)| [jvm] <br>Content <br>open override fun [toString](../../net.axay.kspigot.utils/-registerable-command/index.md#kotlin/Any/toString/#/PointingToDeclaration/)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) <br><br><br>
|
||||
|
||||
|
||||
## Extensions
|
||||
|
||||
| Name| Summary|
|
||||
|---|---|
|
||||
| [register](../register.md)| [jvm] <br>Brief description <br><br><br>Registers the [SingleListener](index.md) with its event listener.<br><br> <br>Content <br>inline fun <[T](../register.md) : Event> [SingleListener](index.md)<[T](../register.md)>.[register](../register.md)(priority: EventPriority, ignoreCancelled: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) <br><br><br>
|
||||
|
@@ -1,53 +0,0 @@
|
||||
<html>
|
||||
<head>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
|
||||
<title>onEvent</title>
|
||||
<link href="../../../images/logo-icon.svg" rel="icon" type="image/svg">
|
||||
<link href="../../../styles/style.css" rel="Stylesheet">
|
||||
<script type="text/javascript" src="../../../scripts/navigationLoader.js" async="async"></script>
|
||||
<script type="text/javascript" src="../../../scripts/platformContentHandler.js" async="async"></script>
|
||||
<script type="text/javascript" src="../../../scripts/sourceset_dependencies.js" async="async"></script>
|
||||
<script type="text/javascript" src="../../../scripts/clipboard.js" async="async"></script>
|
||||
<link href="../../../styles/jetbrains-mono.css" rel="Stylesheet">
|
||||
<script>var pathToRoot = "../../../";</script>
|
||||
</head>
|
||||
<body>
|
||||
<div id="container">
|
||||
<div id="leftColumn">
|
||||
<div id="logo"></div>
|
||||
<div id="paneSearch"></div>
|
||||
<div id="sideMenu"></div>
|
||||
</div>
|
||||
<div id="main">
|
||||
<div id="leftToggler"><span class="icon-toggler"></span></div>
|
||||
<div id="searchBar"></div>
|
||||
<script type="text/javascript" src="../../../scripts/pages.js"></script>
|
||||
<script type="text/javascript" src="../../../scripts/main.js"></script>
|
||||
<div id="content" pageIds="net.axay.kspigot.event/SingleListener/onEvent/#TypeParam(bounds=[org.bukkit.event.Event])/PointingToDeclaration/">
|
||||
<div class="breadcrumbs"><a href="../../index.html">KSpigot</a>/<a href="../index.html">net.axay.kspigot.event</a>/<a href="index.html">SingleListener</a>/<a href="on-event.html">onEvent</a></div>
|
||||
<div class="cover ">
|
||||
<h1 class="cover"><a data-name="onevent"></a><span>on</span><wbr></wbr><span>Event</span></h1>
|
||||
</div>
|
||||
<div class="divergent-group" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="brief-with-platform-tags"><div class="inner-brief-with-platform-tags"></div>
|
||||
<span class="pull-right"></span></div>
|
||||
|
||||
<div class="main-subrow">
|
||||
<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 "><div class="symbol monospace">abstract fun <a href="on-event.html">onEvent</a>(event: <a href="index.html">T</a>)<span class="top-right-position"><span class="copy-icon"><svg width="24" height="24" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||
<path fill-rule="evenodd" clip-rule="evenodd" d="M5 4H15V16H5V4ZM17 7H19V18V20H17H8V18H17V7Z" fill="black"/>
|
||||
</svg></span><div class="copy-popup-wrapper popup-to-left"><svg width="18" height="18" viewBox="0 0 18 18" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||
<path d="M18 9C18 14 14 18 9 18C4 18 0 14 0 9C0 4 4 0 9 0C14 0 18 4 18 9ZM14.2 6.2L12.8 4.8L7.5 10.1L5.3 7.8L3.8 9.2L7.5 13L14.2 6.2Z" fill="#4DBB5F"/>
|
||||
</svg><span>Content copied to clipboard</span></div></span></div></div></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="footer"><span class="go-to-top-icon"><a href="#container"><svg width="12" height="10" viewBox="0 0 12 10" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||
<path d="M11.3337 9.66683H0.666992L6.00033 3.66683L11.3337 9.66683Z" fill="black"/>
|
||||
<path d="M0.666992 0.333496H11.3337V1.66683H0.666992V0.333496Z" fill="black"/>
|
||||
</svg></a></span><span>© 2020 Copyright</span><span class="pull-right"><span>Sponsored and developed by dokka</span><a href="https://github.com/Kotlin/dokka"><span class="padded-icon"><svg width="8" height="8" viewBox="0 0 8 8" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||
<path d="M8 0H2.3949L4.84076 2.44586L0 7.28662L0.713376 8L5.55414 3.15924L8 5.6051V0Z" fill="black"/>
|
||||
</svg></span></a></span></div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
@@ -0,0 +1,14 @@
|
||||
---
|
||||
title: onEvent -
|
||||
---
|
||||
//[KSpigot](../../index.md)/[net.axay.kspigot.event](../index.md)/[SingleListener](index.md)/[onEvent](on-event.md)
|
||||
|
||||
|
||||
|
||||
# onEvent
|
||||
[jvm]
|
||||
Content
|
||||
abstract fun [onEvent](on-event.md)(event: [T](index.md))
|
||||
|
||||
|
||||
|
@@ -1,177 +0,0 @@
|
||||
<html>
|
||||
<head>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
|
||||
<title>net.axay.kspigot.event</title>
|
||||
<link href="../../images/logo-icon.svg" rel="icon" type="image/svg">
|
||||
<link href="../../styles/style.css" rel="Stylesheet">
|
||||
<script type="text/javascript" src="../../scripts/navigationLoader.js" async="async"></script>
|
||||
<script type="text/javascript" src="../../scripts/platformContentHandler.js" async="async"></script>
|
||||
<script type="text/javascript" src="../../scripts/sourceset_dependencies.js" async="async"></script>
|
||||
<script type="text/javascript" src="../../scripts/clipboard.js" async="async"></script>
|
||||
<link href="../../styles/jetbrains-mono.css" rel="Stylesheet">
|
||||
<script>var pathToRoot = "../../";</script>
|
||||
</head>
|
||||
<body>
|
||||
<div id="container">
|
||||
<div id="leftColumn">
|
||||
<div id="logo"></div>
|
||||
<div id="paneSearch"></div>
|
||||
<div id="sideMenu"></div>
|
||||
</div>
|
||||
<div id="main">
|
||||
<div id="leftToggler"><span class="icon-toggler"></span></div>
|
||||
<div id="searchBar"></div>
|
||||
<script type="text/javascript" src="../../scripts/pages.js"></script>
|
||||
<script type="text/javascript" src="../../scripts/main.js"></script>
|
||||
<div id="content" pageIds="net.axay.kspigot.event////PointingToDeclaration/">
|
||||
<div class="breadcrumbs"><a href="../index.html">KSpigot</a>/<a href="index.html">net.axay.kspigot.event</a></div>
|
||||
<div class="cover ">
|
||||
<h1 class="cover"><a data-name="packagenet.axay.kspigot.event"></a><span>Package net.</span><wbr></wbr><span>axay.</span><wbr></wbr><span>kspigot.</span><wbr></wbr><span>event</span></h1>
|
||||
</div>
|
||||
<div class="tabbedcontent">
|
||||
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="Types">Types</button><button class="section-tab" data-togglable="Functions">Functions</button></div>
|
||||
<div class="tabs-section-body">
|
||||
<h2 class=""><a data-name="types"></a>Types</h2>
|
||||
<div class="table" data-togglable="Types"><a data-name="net.axay.kspigot.event/SingleListener///PointingToDeclaration/"></a>
|
||||
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
|
||||
<div class="main-subrow "><span><a href="-single-listener/index.html">SingleListener</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="net.axay.kspigot.event/SingleListener///PointingToDeclaration/"><svg width="24" height="24" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||
<path d="M21.2496 5.3C20.3496 4.5 19.2496 4 18.0496 4C16.8496 4 15.6496 4.5 14.8496 5.3L10.3496 9.8L11.7496 11.2L16.2496 6.7C17.2496 5.7 18.8496 5.7 19.8496 6.7C20.8496 7.7 20.8496 9.3 19.8496 10.3L15.3496 14.8L16.7496 16.2L21.2496 11.7C22.1496 10.8 22.5496 9.7 22.5496 8.5C22.5496 7.3 22.1496 6.2 21.2496 5.3Z"/>
|
||||
<path d="M8.35 16.7998C7.35 17.7998 5.75 17.7998 4.75 16.7998C3.75 15.7998 3.75 14.1998 4.75 13.1998L9.25 8.6998L7.85 7.2998L3.35 11.7998C1.55 13.5998 1.55 16.3998 3.35 18.1998C4.25 19.0998 5.35 19.4998 6.55 19.4998C7.75 19.4998 8.85 19.0998 9.75 18.1998L14.25 13.6998L12.85 12.2998L8.35 16.7998Z"/>
|
||||
</svg></span>
|
||||
<div class="copy-popup-wrapper "><svg width="18" height="18" viewBox="0 0 18 18" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||
<path d="M18 9C18 14 14 18 9 18C4 18 0 14 0 9C0 4 4 0 9 0C14 0 18 4 18 9ZM14.2 6.2L12.8 4.8L7.5 10.1L5.3 7.8L3.8 9.2L7.5 13L14.2 6.2Z" fill="#4DBB5F"/>
|
||||
</svg><span>Link copied to clipboard</span></div>
|
||||
</span></span></div>
|
||||
<div class="platform-dependent-row keyValue">
|
||||
<div></div>
|
||||
<div class="title"><div class="divergent-group" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="brief-with-platform-tags"><div class="inner-brief-with-platform-tags"><div class="brief "><p class="paragraph">This class represents a <span data-unresolved-link="org.bukkit.event/Listener///PointingToDeclaration/">Listener</span> with only one event to listen to.</p></div></div>
|
||||
<span class="pull-right"></span></div>
|
||||
|
||||
<div class="main-subrow">
|
||||
<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">interface <a href="-single-listener/index.html">SingleListener</a><<a href="-single-listener/index.html">T</a> : <span data-unresolved-link="org.bukkit.event/Event///PointingToDeclaration/">Event</span>> : <span data-unresolved-link="org.bukkit.event/Listener///PointingToDeclaration/">Listener</span><span class="top-right-position"><span class="copy-icon"><svg width="24" height="24" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||
<path fill-rule="evenodd" clip-rule="evenodd" d="M5 4H15V16H5V4ZM17 7H19V18V20H17H8V18H17V7Z" fill="black"/>
|
||||
</svg></span><div class="copy-popup-wrapper popup-to-left"><svg width="18" height="18" viewBox="0 0 18 18" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||
<path d="M18 9C18 14 14 18 9 18C4 18 0 14 0 9C0 4 4 0 9 0C14 0 18 4 18 9ZM14.2 6.2L12.8 4.8L7.5 10.1L5.3 7.8L3.8 9.2L7.5 13L14.2 6.2Z" fill="#4DBB5F"/>
|
||||
</svg><span>Content copied to clipboard</span></div></span></div></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<h2 class=""><a data-name="functions"></a>Functions</h2>
|
||||
<div class="table" data-togglable="Functions"><a data-name="net.axay.kspigot.event//listen/org.bukkit.plugin.Plugin#org.bukkit.event.EventPriority#kotlin.Boolean#kotlin.Function1[TypeParam(bounds=[org.bukkit.event.Event]),kotlin.Unit]/PointingToDeclaration/"></a>
|
||||
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
|
||||
<div class="main-subrow "><span><a href="listen.html">listen</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="net.axay.kspigot.event//listen/org.bukkit.plugin.Plugin#org.bukkit.event.EventPriority#kotlin.Boolean#kotlin.Function1[TypeParam(bounds=[org.bukkit.event.Event]),kotlin.Unit]/PointingToDeclaration/"><svg width="24" height="24" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||
<path d="M21.2496 5.3C20.3496 4.5 19.2496 4 18.0496 4C16.8496 4 15.6496 4.5 14.8496 5.3L10.3496 9.8L11.7496 11.2L16.2496 6.7C17.2496 5.7 18.8496 5.7 19.8496 6.7C20.8496 7.7 20.8496 9.3 19.8496 10.3L15.3496 14.8L16.7496 16.2L21.2496 11.7C22.1496 10.8 22.5496 9.7 22.5496 8.5C22.5496 7.3 22.1496 6.2 21.2496 5.3Z"/>
|
||||
<path d="M8.35 16.7998C7.35 17.7998 5.75 17.7998 4.75 16.7998C3.75 15.7998 3.75 14.1998 4.75 13.1998L9.25 8.6998L7.85 7.2998L3.35 11.7998C1.55 13.5998 1.55 16.3998 3.35 18.1998C4.25 19.0998 5.35 19.4998 6.55 19.4998C7.75 19.4998 8.85 19.0998 9.75 18.1998L14.25 13.6998L12.85 12.2998L8.35 16.7998Z"/>
|
||||
</svg></span>
|
||||
<div class="copy-popup-wrapper "><svg width="18" height="18" viewBox="0 0 18 18" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||
<path d="M18 9C18 14 14 18 9 18C4 18 0 14 0 9C0 4 4 0 9 0C14 0 18 4 18 9ZM14.2 6.2L12.8 4.8L7.5 10.1L5.3 7.8L3.8 9.2L7.5 13L14.2 6.2Z" fill="#4DBB5F"/>
|
||||
</svg><span>Link copied to clipboard</span></div>
|
||||
</span></span></div>
|
||||
<div class="platform-dependent-row keyValue">
|
||||
<div></div>
|
||||
<div class="title"><div class="divergent-group" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="brief-with-platform-tags"><div class="inner-brief-with-platform-tags"></div>
|
||||
<span class="pull-right"></span></div>
|
||||
|
||||
<div class="main-subrow">
|
||||
<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">inline fun <<a href="listen.html">T</a> : <span data-unresolved-link="org.bukkit.event/Event///PointingToDeclaration/">Event</span>> <span data-unresolved-link="org.bukkit.plugin/Plugin///PointingToDeclaration/">Plugin</span>.<a href="listen.html">listen</a>(priority: <span data-unresolved-link="org.bukkit.event/EventPriority///PointingToDeclaration/">EventPriority</span>, ignoreCancelled: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a>, crossinline onEvent: (<a href="listen.html">T</a>) -> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a>): <a href="-single-listener/index.html">SingleListener</a><<a href="listen.html">T</a>><span class="top-right-position"><span class="copy-icon"><svg width="24" height="24" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||
<path fill-rule="evenodd" clip-rule="evenodd" d="M5 4H15V16H5V4ZM17 7H19V18V20H17H8V18H17V7Z" fill="black"/>
|
||||
</svg></span><div class="copy-popup-wrapper popup-to-left"><svg width="18" height="18" viewBox="0 0 18 18" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||
<path d="M18 9C18 14 14 18 9 18C4 18 0 14 0 9C0 4 4 0 9 0C14 0 18 4 18 9ZM14.2 6.2L12.8 4.8L7.5 10.1L5.3 7.8L3.8 9.2L7.5 13L14.2 6.2Z" fill="#4DBB5F"/>
|
||||
</svg><span>Content copied to clipboard</span></div></span></div></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<a data-name="net.axay.kspigot.event//register/org.bukkit.event.Listener#org.bukkit.plugin.Plugin/PointingToDeclaration/"></a>
|
||||
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
|
||||
<div class="main-subrow "><span><a href="register.html">register</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="net.axay.kspigot.event//register/org.bukkit.event.Listener#org.bukkit.plugin.Plugin/PointingToDeclaration/"><svg width="24" height="24" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||
<path d="M21.2496 5.3C20.3496 4.5 19.2496 4 18.0496 4C16.8496 4 15.6496 4.5 14.8496 5.3L10.3496 9.8L11.7496 11.2L16.2496 6.7C17.2496 5.7 18.8496 5.7 19.8496 6.7C20.8496 7.7 20.8496 9.3 19.8496 10.3L15.3496 14.8L16.7496 16.2L21.2496 11.7C22.1496 10.8 22.5496 9.7 22.5496 8.5C22.5496 7.3 22.1496 6.2 21.2496 5.3Z"/>
|
||||
<path d="M8.35 16.7998C7.35 17.7998 5.75 17.7998 4.75 16.7998C3.75 15.7998 3.75 14.1998 4.75 13.1998L9.25 8.6998L7.85 7.2998L3.35 11.7998C1.55 13.5998 1.55 16.3998 3.35 18.1998C4.25 19.0998 5.35 19.4998 6.55 19.4998C7.75 19.4998 8.85 19.0998 9.75 18.1998L14.25 13.6998L12.85 12.2998L8.35 16.7998Z"/>
|
||||
</svg></span>
|
||||
<div class="copy-popup-wrapper "><svg width="18" height="18" viewBox="0 0 18 18" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||
<path d="M18 9C18 14 14 18 9 18C4 18 0 14 0 9C0 4 4 0 9 0C14 0 18 4 18 9ZM14.2 6.2L12.8 4.8L7.5 10.1L5.3 7.8L3.8 9.2L7.5 13L14.2 6.2Z" fill="#4DBB5F"/>
|
||||
</svg><span>Link copied to clipboard</span></div>
|
||||
</span></span></div>
|
||||
<div class="platform-dependent-row keyValue">
|
||||
<div></div>
|
||||
<div class="title"><div class="divergent-group" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="brief-with-platform-tags"><div class="inner-brief-with-platform-tags"><div class="brief "><p class="paragraph">Shortcut for registering this listener on the given plugin.</p></div></div>
|
||||
<span class="pull-right"></span></div>
|
||||
|
||||
<div class="main-subrow">
|
||||
<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/Listener///PointingToDeclaration/">Listener</span>.<a href="register.html">register</a>(plugin: <span data-unresolved-link="org.bukkit.plugin/Plugin///PointingToDeclaration/">Plugin</span>)<span class="top-right-position"><span class="copy-icon"><svg width="24" height="24" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||
<path fill-rule="evenodd" clip-rule="evenodd" d="M5 4H15V16H5V4ZM17 7H19V18V20H17H8V18H17V7Z" fill="black"/>
|
||||
</svg></span><div class="copy-popup-wrapper popup-to-left"><svg width="18" height="18" viewBox="0 0 18 18" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||
<path d="M18 9C18 14 14 18 9 18C4 18 0 14 0 9C0 4 4 0 9 0C14 0 18 4 18 9ZM14.2 6.2L12.8 4.8L7.5 10.1L5.3 7.8L3.8 9.2L7.5 13L14.2 6.2Z" fill="#4DBB5F"/>
|
||||
</svg><span>Content copied to clipboard</span></div></span></div></div></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="divergent-group" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="brief-with-platform-tags"><div class="inner-brief-with-platform-tags"><div class="brief "><p class="paragraph">Registers the <a href="-single-listener/index.html">SingleListener</a> with its event listener.</p></div></div>
|
||||
<span class="pull-right"></span></div>
|
||||
|
||||
<div class="main-subrow">
|
||||
<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">inline fun <<a href="register.html">T</a> : <span data-unresolved-link="org.bukkit.event/Event///PointingToDeclaration/">Event</span>> <a href="-single-listener/index.html">SingleListener</a><<a href="register.html">T</a>>.<a href="register.html">register</a>(plugin: <span data-unresolved-link="org.bukkit.plugin/Plugin///PointingToDeclaration/">Plugin</span>, priority: <span data-unresolved-link="org.bukkit.event/EventPriority///PointingToDeclaration/">EventPriority</span>, ignoreCancelled: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a>)<span class="top-right-position"><span class="copy-icon"><svg width="24" height="24" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||
<path fill-rule="evenodd" clip-rule="evenodd" d="M5 4H15V16H5V4ZM17 7H19V18V20H17H8V18H17V7Z" fill="black"/>
|
||||
</svg></span><div class="copy-popup-wrapper popup-to-left"><svg width="18" height="18" viewBox="0 0 18 18" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||
<path d="M18 9C18 14 14 18 9 18C4 18 0 14 0 9C0 4 4 0 9 0C14 0 18 4 18 9ZM14.2 6.2L12.8 4.8L7.5 10.1L5.3 7.8L3.8 9.2L7.5 13L14.2 6.2Z" fill="#4DBB5F"/>
|
||||
</svg><span>Content copied to clipboard</span></div></span></div></div></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="divergent-group" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="brief-with-platform-tags"><div class="inner-brief-with-platform-tags"><div class="brief "><p class="paragraph">Registers the event with a custom event <span data-unresolved-link="net.axay.kspigot.event//executor/#/PointingToCallableParameters(-1)/">executor</span>.</p></div></div>
|
||||
<span class="pull-right"></span></div>
|
||||
|
||||
<div class="main-subrow">
|
||||
<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">inline fun <<a href="register.html">T</a> : <span data-unresolved-link="org.bukkit.event/Event///PointingToDeclaration/">Event</span>> <span data-unresolved-link="org.bukkit.event/Listener///PointingToDeclaration/">Listener</span>.<a href="register.html">register</a>(plugin: <span data-unresolved-link="org.bukkit.plugin/Plugin///PointingToDeclaration/">Plugin</span>, priority: <span data-unresolved-link="org.bukkit.event/EventPriority///PointingToDeclaration/">EventPriority</span>, ignoreCancelled: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a>, noinline executor: (<span data-unresolved-link="org.bukkit.event/Listener///PointingToDeclaration/">Listener</span>, <span data-unresolved-link="org.bukkit.event/Event///PointingToDeclaration/">Event</span>) -> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a>)<span class="top-right-position"><span class="copy-icon"><svg width="24" height="24" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||
<path fill-rule="evenodd" clip-rule="evenodd" d="M5 4H15V16H5V4ZM17 7H19V18V20H17H8V18H17V7Z" fill="black"/>
|
||||
</svg></span><div class="copy-popup-wrapper popup-to-left"><svg width="18" height="18" viewBox="0 0 18 18" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||
<path d="M18 9C18 14 14 18 9 18C4 18 0 14 0 9C0 4 4 0 9 0C14 0 18 4 18 9ZM14.2 6.2L12.8 4.8L7.5 10.1L5.3 7.8L3.8 9.2L7.5 13L14.2 6.2Z" fill="#4DBB5F"/>
|
||||
</svg><span>Content copied to clipboard</span></div></span></div></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<a data-name="net.axay.kspigot.event//unregister/org.bukkit.event.Listener#/PointingToDeclaration/"></a>
|
||||
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
|
||||
<div class="main-subrow "><span><a href="unregister.html">unregister</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="net.axay.kspigot.event//unregister/org.bukkit.event.Listener#/PointingToDeclaration/"><svg width="24" height="24" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||
<path d="M21.2496 5.3C20.3496 4.5 19.2496 4 18.0496 4C16.8496 4 15.6496 4.5 14.8496 5.3L10.3496 9.8L11.7496 11.2L16.2496 6.7C17.2496 5.7 18.8496 5.7 19.8496 6.7C20.8496 7.7 20.8496 9.3 19.8496 10.3L15.3496 14.8L16.7496 16.2L21.2496 11.7C22.1496 10.8 22.5496 9.7 22.5496 8.5C22.5496 7.3 22.1496 6.2 21.2496 5.3Z"/>
|
||||
<path d="M8.35 16.7998C7.35 17.7998 5.75 17.7998 4.75 16.7998C3.75 15.7998 3.75 14.1998 4.75 13.1998L9.25 8.6998L7.85 7.2998L3.35 11.7998C1.55 13.5998 1.55 16.3998 3.35 18.1998C4.25 19.0998 5.35 19.4998 6.55 19.4998C7.75 19.4998 8.85 19.0998 9.75 18.1998L14.25 13.6998L12.85 12.2998L8.35 16.7998Z"/>
|
||||
</svg></span>
|
||||
<div class="copy-popup-wrapper "><svg width="18" height="18" viewBox="0 0 18 18" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||
<path d="M18 9C18 14 14 18 9 18C4 18 0 14 0 9C0 4 4 0 9 0C14 0 18 4 18 9ZM14.2 6.2L12.8 4.8L7.5 10.1L5.3 7.8L3.8 9.2L7.5 13L14.2 6.2Z" fill="#4DBB5F"/>
|
||||
</svg><span>Link copied to clipboard</span></div>
|
||||
</span></span></div>
|
||||
<div class="platform-dependent-row keyValue">
|
||||
<div></div>
|
||||
<div class="title"><div class="divergent-group" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="brief-with-platform-tags"><div class="inner-brief-with-platform-tags"><div class="brief "><p class="paragraph">Shortcut for unregistering all events in this listener.</p></div></div>
|
||||
<span class="pull-right"></span></div>
|
||||
|
||||
<div class="main-subrow">
|
||||
<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/Listener///PointingToDeclaration/">Listener</span>.<a href="unregister.html">unregister</a>()<span class="top-right-position"><span class="copy-icon"><svg width="24" height="24" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||
<path fill-rule="evenodd" clip-rule="evenodd" d="M5 4H15V16H5V4ZM17 7H19V18V20H17H8V18H17V7Z" fill="black"/>
|
||||
</svg></span><div class="copy-popup-wrapper popup-to-left"><svg width="18" height="18" viewBox="0 0 18 18" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||
<path d="M18 9C18 14 14 18 9 18C4 18 0 14 0 9C0 4 4 0 9 0C14 0 18 4 18 9ZM14.2 6.2L12.8 4.8L7.5 10.1L5.3 7.8L3.8 9.2L7.5 13L14.2 6.2Z" fill="#4DBB5F"/>
|
||||
</svg><span>Content copied to clipboard</span></div></span></div></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="footer"><span class="go-to-top-icon"><a href="#container"><svg width="12" height="10" viewBox="0 0 12 10" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||
<path d="M11.3337 9.66683H0.666992L6.00033 3.66683L11.3337 9.66683Z" fill="black"/>
|
||||
<path d="M0.666992 0.333496H11.3337V1.66683H0.666992V0.333496Z" fill="black"/>
|
||||
</svg></a></span><span>© 2020 Copyright</span><span class="pull-right"><span>Sponsored and developed by dokka</span><a href="https://github.com/Kotlin/dokka"><span class="padded-icon"><svg width="8" height="8" viewBox="0 0 8 8" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||
<path d="M8 0H2.3949L4.84076 2.44586L0 7.28662L0.713376 8L5.55414 3.15924L8 5.6051V0Z" fill="black"/>
|
||||
</svg></span></a></span></div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
25
docs/-k-spigot/net.axay.kspigot.event/index.md
Normal file
25
docs/-k-spigot/net.axay.kspigot.event/index.md
Normal file
@@ -0,0 +1,25 @@
|
||||
---
|
||||
title: net.axay.kspigot.event -
|
||||
---
|
||||
//[KSpigot](../index.md)/[net.axay.kspigot.event](index.md)
|
||||
|
||||
|
||||
|
||||
# Package net.axay.kspigot.event
|
||||
|
||||
|
||||
## Types
|
||||
|
||||
| Name| Summary|
|
||||
|---|---|
|
||||
| [SingleListener](-single-listener/index.md)| [jvm] <br>Brief description <br><br><br>This class represents a Listener with only one event to listen to.<br><br> <br>Content <br>interface [SingleListener](-single-listener/index.md)<[T](-single-listener/index.md) : Event> : Listener <br><br><br>
|
||||
|
||||
|
||||
## Functions
|
||||
|
||||
| Name| Summary|
|
||||
|---|---|
|
||||
| [listen](listen.md)| [jvm] <br>Content <br>inline fun <[T](listen.md) : Event> [listen](listen.md)(priority: EventPriority, ignoreCancelled: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), crossinline onEvent: ([T](listen.md)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)): [SingleListener](-single-listener/index.md)<[T](listen.md)> <br><br><br>
|
||||
| [register](register.md)| [jvm] <br>Brief description <br><br><br>Shortcut for registering this listener on the given plugin.<br><br> <br>Content <br>fun Listener.[register](register.md)() <br><br><br>[jvm] <br>Brief description <br><br><br>Registers the [SingleListener](-single-listener/index.md) with its event listener.<br><br> <br>Content <br>inline fun <[T](register.md) : Event> [SingleListener](-single-listener/index.md)<[T](register.md)>.[register](register.md)(priority: EventPriority, ignoreCancelled: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) <br><br><br>[jvm] <br>Brief description <br><br><br>Registers the event with a custom event executor.<br><br> <br>Content <br>inline fun <[T](register.md) : Event> Listener.[register](register.md)(priority: EventPriority, ignoreCancelled: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), noinline executor: (Listener, Event) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)) <br><br><br>
|
||||
| [unregister](unregister.md)| [jvm] <br>Brief description <br><br><br>Shortcut for unregistering all events in this listener.<br><br> <br>Content <br>fun Listener.[unregister](unregister.md)() <br><br><br>
|
||||
|
@@ -1,53 +0,0 @@
|
||||
<html>
|
||||
<head>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
|
||||
<title>listen</title>
|
||||
<link href="../../images/logo-icon.svg" rel="icon" type="image/svg">
|
||||
<link href="../../styles/style.css" rel="Stylesheet">
|
||||
<script type="text/javascript" src="../../scripts/navigationLoader.js" async="async"></script>
|
||||
<script type="text/javascript" src="../../scripts/platformContentHandler.js" async="async"></script>
|
||||
<script type="text/javascript" src="../../scripts/sourceset_dependencies.js" async="async"></script>
|
||||
<script type="text/javascript" src="../../scripts/clipboard.js" async="async"></script>
|
||||
<link href="../../styles/jetbrains-mono.css" rel="Stylesheet">
|
||||
<script>var pathToRoot = "../../";</script>
|
||||
</head>
|
||||
<body>
|
||||
<div id="container">
|
||||
<div id="leftColumn">
|
||||
<div id="logo"></div>
|
||||
<div id="paneSearch"></div>
|
||||
<div id="sideMenu"></div>
|
||||
</div>
|
||||
<div id="main">
|
||||
<div id="leftToggler"><span class="icon-toggler"></span></div>
|
||||
<div id="searchBar"></div>
|
||||
<script type="text/javascript" src="../../scripts/pages.js"></script>
|
||||
<script type="text/javascript" src="../../scripts/main.js"></script>
|
||||
<div id="content" pageIds="net.axay.kspigot.event//listen/org.bukkit.plugin.Plugin#org.bukkit.event.EventPriority#kotlin.Boolean#kotlin.Function1[TypeParam(bounds=[org.bukkit.event.Event]),kotlin.Unit]/PointingToDeclaration/">
|
||||
<div class="breadcrumbs"><a href="../index.html">KSpigot</a>/<a href="index.html">net.axay.kspigot.event</a>/<a href="listen.html">listen</a></div>
|
||||
<div class="cover ">
|
||||
<h1 class="cover"><a data-name="listen"></a><span>listen</span></h1>
|
||||
</div>
|
||||
<div class="divergent-group" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="brief-with-platform-tags"><div class="inner-brief-with-platform-tags"><h2 class=""><a data-name="parameters"></a>Parameters</h2><div data-togglable="Parameters"><div class="platform-hinted WithExtraAttributes" data-platform-hinted="data-platform-hinted" data-togglable="Parameters"><div class="content sourceset-depenent-content" data-active="" data-togglable=":dokkaHtml/main"><div data-togglable="Parameters"><div class="table" data-togglable="Parameters"><a data-name="net.axay.kspigot.event//listen/org.bukkit.plugin.Plugin#org.bukkit.event.EventPriority#kotlin.Boolean#kotlin.Function1[TypeParam(bounds=[org.bukkit.event.Event]),kotlin.Unit]/PointingToDeclaration/"></a><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="platform-dependent-row keyValue"><div>ignoreCancelled</div><div class="title"><div data-togglable="Parameters"><p class="paragraph">if manual cancellation should be ignored</p></div></div></div></div><a data-name="net.axay.kspigot.event//listen/org.bukkit.plugin.Plugin#org.bukkit.event.EventPriority#kotlin.Boolean#kotlin.Function1[TypeParam(bounds=[org.bukkit.event.Event]),kotlin.Unit]/PointingToDeclaration/"></a><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="platform-dependent-row keyValue"><div>onEvent</div><div class="title"><div data-togglable="Parameters"><p class="paragraph">the event callback</p></div></div></div></div><a data-name="net.axay.kspigot.event//listen/org.bukkit.plugin.Plugin#org.bukkit.event.EventPriority#kotlin.Boolean#kotlin.Function1[TypeParam(bounds=[org.bukkit.event.Event]),kotlin.Unit]/PointingToDeclaration/"></a><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="platform-dependent-row keyValue"><div>priority</div><div class="title"><div data-togglable="Parameters"><p class="paragraph">the priority when multiple listeners handle this event</p></div></div></div></div><a data-name="net.axay.kspigot.event//listen/org.bukkit.plugin.Plugin#org.bukkit.event.EventPriority#kotlin.Boolean#kotlin.Function1[TypeParam(bounds=[org.bukkit.event.Event]),kotlin.Unit]/PointingToDeclaration/"></a><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="platform-dependent-row keyValue"><div>T</div><div class="title"><div data-togglable="Parameters"><p class="paragraph">the type of event to listen to</p></div></div></div></div></div></div></div></div></div></div>
|
||||
<span class="pull-right"></span></div>
|
||||
|
||||
<div class="main-subrow">
|
||||
<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 "><div class="symbol monospace">inline fun <<a href="listen.html">T</a> : <span data-unresolved-link="org.bukkit.event/Event///PointingToDeclaration/">Event</span>> <span data-unresolved-link="org.bukkit.plugin/Plugin///PointingToDeclaration/">Plugin</span>.<a href="listen.html">listen</a>(priority: <span data-unresolved-link="org.bukkit.event/EventPriority///PointingToDeclaration/">EventPriority</span>, ignoreCancelled: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a>, crossinline onEvent: (<a href="listen.html">T</a>) -> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a>): <a href="-single-listener/index.html">SingleListener</a><<a href="listen.html">T</a>><span class="top-right-position"><span class="copy-icon"><svg width="24" height="24" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||
<path fill-rule="evenodd" clip-rule="evenodd" d="M5 4H15V16H5V4ZM17 7H19V18V20H17H8V18H17V7Z" fill="black"/>
|
||||
</svg></span><div class="copy-popup-wrapper popup-to-left"><svg width="18" height="18" viewBox="0 0 18 18" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||
<path d="M18 9C18 14 14 18 9 18C4 18 0 14 0 9C0 4 4 0 9 0C14 0 18 4 18 9ZM14.2 6.2L12.8 4.8L7.5 10.1L5.3 7.8L3.8 9.2L7.5 13L14.2 6.2Z" fill="#4DBB5F"/>
|
||||
</svg><span>Content copied to clipboard</span></div></span></div></div></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="footer"><span class="go-to-top-icon"><a href="#container"><svg width="12" height="10" viewBox="0 0 12 10" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||
<path d="M11.3337 9.66683H0.666992L6.00033 3.66683L11.3337 9.66683Z" fill="black"/>
|
||||
<path d="M0.666992 0.333496H11.3337V1.66683H0.666992V0.333496Z" fill="black"/>
|
||||
</svg></a></span><span>© 2020 Copyright</span><span class="pull-right"><span>Sponsored and developed by dokka</span><a href="https://github.com/Kotlin/dokka"><span class="padded-icon"><svg width="8" height="8" viewBox="0 0 8 8" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||
<path d="M8 0H2.3949L4.84076 2.44586L0 7.28662L0.713376 8L5.55414 3.15924L8 5.6051V0Z" fill="black"/>
|
||||
</svg></span></a></span></div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
29
docs/-k-spigot/net.axay.kspigot.event/listen.md
Normal file
29
docs/-k-spigot/net.axay.kspigot.event/listen.md
Normal file
@@ -0,0 +1,29 @@
|
||||
---
|
||||
title: listen -
|
||||
---
|
||||
//[KSpigot](../index.md)/[net.axay.kspigot.event](index.md)/[listen](listen.md)
|
||||
|
||||
|
||||
|
||||
# listen
|
||||
[jvm]
|
||||
Brief description
|
||||
|
||||
|
||||
## Parameters
|
||||
|
||||
jvm
|
||||
|
||||
| Name| Summary|
|
||||
|---|---|
|
||||
| ignoreCancelled| <br><br>if manual cancellation should be ignored<br><br>
|
||||
| onEvent| <br><br>the event callback<br><br>
|
||||
| priority| <br><br>the priority when multiple listeners handle this event<br><br>
|
||||
| T| <br><br>the type of event to listen to<br><br>
|
||||
|
||||
|
||||
Content
|
||||
inline fun <[T](listen.md) : Event> [listen](listen.md)(priority: EventPriority, ignoreCancelled: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), crossinline onEvent: ([T](listen.md)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)): [SingleListener](-single-listener/index.md)<[T](listen.md)>
|
||||
|
||||
|
||||
|
@@ -1,75 +0,0 @@
|
||||
<html>
|
||||
<head>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
|
||||
<title>register</title>
|
||||
<link href="../../images/logo-icon.svg" rel="icon" type="image/svg">
|
||||
<link href="../../styles/style.css" rel="Stylesheet">
|
||||
<script type="text/javascript" src="../../scripts/navigationLoader.js" async="async"></script>
|
||||
<script type="text/javascript" src="../../scripts/platformContentHandler.js" async="async"></script>
|
||||
<script type="text/javascript" src="../../scripts/sourceset_dependencies.js" async="async"></script>
|
||||
<script type="text/javascript" src="../../scripts/clipboard.js" async="async"></script>
|
||||
<link href="../../styles/jetbrains-mono.css" rel="Stylesheet">
|
||||
<script>var pathToRoot = "../../";</script>
|
||||
</head>
|
||||
<body>
|
||||
<div id="container">
|
||||
<div id="leftColumn">
|
||||
<div id="logo"></div>
|
||||
<div id="paneSearch"></div>
|
||||
<div id="sideMenu"></div>
|
||||
</div>
|
||||
<div id="main">
|
||||
<div id="leftToggler"><span class="icon-toggler"></span></div>
|
||||
<div id="searchBar"></div>
|
||||
<script type="text/javascript" src="../../scripts/pages.js"></script>
|
||||
<script type="text/javascript" src="../../scripts/main.js"></script>
|
||||
<div id="content" pageIds="net.axay.kspigot.event//register/org.bukkit.event.Listener#org.bukkit.plugin.Plugin/PointingToDeclaration/">
|
||||
<div class="breadcrumbs"><a href="../index.html">KSpigot</a>/<a href="index.html">net.axay.kspigot.event</a>/<a href="register.html">register</a></div>
|
||||
<div class="cover ">
|
||||
<h1 class="cover"><a data-name="register"></a><span>register</span></h1>
|
||||
</div>
|
||||
<div class="divergent-group" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="brief-with-platform-tags"><div class="inner-brief-with-platform-tags"><p class="paragraph">Shortcut for registering this listener on the given plugin.</p></div>
|
||||
<span class="pull-right"></span></div>
|
||||
|
||||
<div class="main-subrow">
|
||||
<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 "><div class="symbol monospace">fun <span data-unresolved-link="org.bukkit.event/Listener///PointingToDeclaration/">Listener</span>.<a href="register.html">register</a>(plugin: <span data-unresolved-link="org.bukkit.plugin/Plugin///PointingToDeclaration/">Plugin</span>)<span class="top-right-position"><span class="copy-icon"><svg width="24" height="24" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||
<path fill-rule="evenodd" clip-rule="evenodd" d="M5 4H15V16H5V4ZM17 7H19V18V20H17H8V18H17V7Z" fill="black"/>
|
||||
</svg></span><div class="copy-popup-wrapper popup-to-left"><svg width="18" height="18" viewBox="0 0 18 18" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||
<path d="M18 9C18 14 14 18 9 18C4 18 0 14 0 9C0 4 4 0 9 0C14 0 18 4 18 9ZM14.2 6.2L12.8 4.8L7.5 10.1L5.3 7.8L3.8 9.2L7.5 13L14.2 6.2Z" fill="#4DBB5F"/>
|
||||
</svg><span>Content copied to clipboard</span></div></span></div></div></div></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="divergent-group" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="brief-with-platform-tags"><div class="inner-brief-with-platform-tags"><p class="paragraph">Registers the event with a custom event <span data-unresolved-link="net.axay.kspigot.event//executor/#/PointingToCallableParameters(-1)/">executor</span>.</p><h2 class=""><a data-name="parameters"></a>Parameters</h2><div data-togglable="Parameters"><div class="platform-hinted WithExtraAttributes" data-platform-hinted="data-platform-hinted" data-togglable="Parameters"><div class="content sourceset-depenent-content" data-active="" data-togglable=":dokkaHtml/main"><div data-togglable="Parameters"><div class="table" data-togglable="Parameters"><a data-name="net.axay.kspigot.event//register/org.bukkit.event.Listener#org.bukkit.plugin.Plugin#org.bukkit.event.EventPriority#kotlin.Boolean#kotlin.Function2[org.bukkit.event.Listener,org.bukkit.event.Event,kotlin.Unit]/PointingToDeclaration/"></a><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="platform-dependent-row keyValue"><div>executor</div><div class="title"><div data-togglable="Parameters"><p class="paragraph">handles incoming events</p></div></div></div></div><a data-name="net.axay.kspigot.event//register/org.bukkit.event.Listener#org.bukkit.plugin.Plugin#org.bukkit.event.EventPriority#kotlin.Boolean#kotlin.Function2[org.bukkit.event.Listener,org.bukkit.event.Event,kotlin.Unit]/PointingToDeclaration/"></a><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="platform-dependent-row keyValue"><div>ignoreCancelled</div><div class="title"><div data-togglable="Parameters"><p class="paragraph">if manual cancellation should be ignored</p></div></div></div></div><a data-name="net.axay.kspigot.event//register/org.bukkit.event.Listener#org.bukkit.plugin.Plugin#org.bukkit.event.EventPriority#kotlin.Boolean#kotlin.Function2[org.bukkit.event.Listener,org.bukkit.event.Event,kotlin.Unit]/PointingToDeclaration/"></a><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="platform-dependent-row keyValue"><div>priority</div><div class="title"><div data-togglable="Parameters"><p class="paragraph">the priority when multiple listeners handle this event</p></div></div></div></div><a data-name="net.axay.kspigot.event//register/org.bukkit.event.Listener#org.bukkit.plugin.Plugin#org.bukkit.event.EventPriority#kotlin.Boolean#kotlin.Function2[org.bukkit.event.Listener,org.bukkit.event.Event,kotlin.Unit]/PointingToDeclaration/"></a><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="platform-dependent-row keyValue"><div>T</div><div class="title"><div data-togglable="Parameters"><p class="paragraph">the type of event</p></div></div></div></div></div></div></div></div></div></div>
|
||||
<span class="pull-right"></span></div>
|
||||
|
||||
<div class="main-subrow">
|
||||
<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 "><div class="symbol monospace">inline fun <<a href="register.html">T</a> : <span data-unresolved-link="org.bukkit.event/Event///PointingToDeclaration/">Event</span>> <span data-unresolved-link="org.bukkit.event/Listener///PointingToDeclaration/">Listener</span>.<a href="register.html">register</a>(plugin: <span data-unresolved-link="org.bukkit.plugin/Plugin///PointingToDeclaration/">Plugin</span>, priority: <span data-unresolved-link="org.bukkit.event/EventPriority///PointingToDeclaration/">EventPriority</span>, ignoreCancelled: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a>, noinline executor: (<span data-unresolved-link="org.bukkit.event/Listener///PointingToDeclaration/">Listener</span>, <span data-unresolved-link="org.bukkit.event/Event///PointingToDeclaration/">Event</span>) -> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a>)<span class="top-right-position"><span class="copy-icon"><svg width="24" height="24" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||
<path fill-rule="evenodd" clip-rule="evenodd" d="M5 4H15V16H5V4ZM17 7H19V18V20H17H8V18H17V7Z" fill="black"/>
|
||||
</svg></span><div class="copy-popup-wrapper popup-to-left"><svg width="18" height="18" viewBox="0 0 18 18" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||
<path d="M18 9C18 14 14 18 9 18C4 18 0 14 0 9C0 4 4 0 9 0C14 0 18 4 18 9ZM14.2 6.2L12.8 4.8L7.5 10.1L5.3 7.8L3.8 9.2L7.5 13L14.2 6.2Z" fill="#4DBB5F"/>
|
||||
</svg><span>Content copied to clipboard</span></div></span></div></div></div></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="divergent-group" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="brief-with-platform-tags"><div class="inner-brief-with-platform-tags"><p class="paragraph">Registers the <a href="-single-listener/index.html">SingleListener</a> with its event listener.</p><h2 class=""><a data-name="parameters"></a>Parameters</h2><div data-togglable="Parameters"><div class="platform-hinted WithExtraAttributes" data-platform-hinted="data-platform-hinted" data-togglable="Parameters"><div class="content sourceset-depenent-content" data-active="" data-togglable=":dokkaHtml/main"><div data-togglable="Parameters"><div class="table" data-togglable="Parameters"><a data-name="net.axay.kspigot.event//register/net.axay.kspigot.event.SingleListener[TypeParam(bounds=[org.bukkit.event.Event])]#org.bukkit.plugin.Plugin#org.bukkit.event.EventPriority#kotlin.Boolean/PointingToDeclaration/"></a><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="platform-dependent-row keyValue"><div>ignoreCancelled</div><div class="title"><div data-togglable="Parameters"><p class="paragraph">if manual cancellation should be ignored</p></div></div></div></div><a data-name="net.axay.kspigot.event//register/net.axay.kspigot.event.SingleListener[TypeParam(bounds=[org.bukkit.event.Event])]#org.bukkit.plugin.Plugin#org.bukkit.event.EventPriority#kotlin.Boolean/PointingToDeclaration/"></a><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="platform-dependent-row keyValue"><div>priority</div><div class="title"><div data-togglable="Parameters"><p class="paragraph">the priority when multiple listeners handle this event</p></div></div></div></div></div></div></div></div></div></div>
|
||||
<span class="pull-right"></span></div>
|
||||
|
||||
<div class="main-subrow">
|
||||
<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 "><div class="symbol monospace">inline fun <<a href="register.html">T</a> : <span data-unresolved-link="org.bukkit.event/Event///PointingToDeclaration/">Event</span>> <a href="-single-listener/index.html">SingleListener</a><<a href="register.html">T</a>>.<a href="register.html">register</a>(plugin: <span data-unresolved-link="org.bukkit.plugin/Plugin///PointingToDeclaration/">Plugin</span>, priority: <span data-unresolved-link="org.bukkit.event/EventPriority///PointingToDeclaration/">EventPriority</span>, ignoreCancelled: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a>)<span class="top-right-position"><span class="copy-icon"><svg width="24" height="24" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||
<path fill-rule="evenodd" clip-rule="evenodd" d="M5 4H15V16H5V4ZM17 7H19V18V20H17H8V18H17V7Z" fill="black"/>
|
||||
</svg></span><div class="copy-popup-wrapper popup-to-left"><svg width="18" height="18" viewBox="0 0 18 18" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||
<path d="M18 9C18 14 14 18 9 18C4 18 0 14 0 9C0 4 4 0 9 0C14 0 18 4 18 9ZM14.2 6.2L12.8 4.8L7.5 10.1L5.3 7.8L3.8 9.2L7.5 13L14.2 6.2Z" fill="#4DBB5F"/>
|
||||
</svg><span>Content copied to clipboard</span></div></span></div></div></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="footer"><span class="go-to-top-icon"><a href="#container"><svg width="12" height="10" viewBox="0 0 12 10" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||
<path d="M11.3337 9.66683H0.666992L6.00033 3.66683L11.3337 9.66683Z" fill="black"/>
|
||||
<path d="M0.666992 0.333496H11.3337V1.66683H0.666992V0.333496Z" fill="black"/>
|
||||
</svg></a></span><span>© 2020 Copyright</span><span class="pull-right"><span>Sponsored and developed by dokka</span><a href="https://github.com/Kotlin/dokka"><span class="padded-icon"><svg width="8" height="8" viewBox="0 0 8 8" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||
<path d="M8 0H2.3949L4.84076 2.44586L0 7.28662L0.713376 8L5.55414 3.15924L8 5.6051V0Z" fill="black"/>
|
||||
</svg></span></a></span></div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
66
docs/-k-spigot/net.axay.kspigot.event/register.md
Normal file
66
docs/-k-spigot/net.axay.kspigot.event/register.md
Normal file
@@ -0,0 +1,66 @@
|
||||
---
|
||||
title: register -
|
||||
---
|
||||
//[KSpigot](../index.md)/[net.axay.kspigot.event](index.md)/[register](register.md)
|
||||
|
||||
|
||||
|
||||
# register
|
||||
[jvm]
|
||||
Brief description
|
||||
|
||||
|
||||
Shortcut for registering this listener on the given plugin.
|
||||
|
||||
|
||||
Content
|
||||
fun Listener.[register](register.md)()
|
||||
|
||||
|
||||
[jvm]
|
||||
Brief description
|
||||
|
||||
|
||||
Registers the event with a custom event executor.
|
||||
|
||||
|
||||
|
||||
## Parameters
|
||||
|
||||
jvm
|
||||
|
||||
| Name| Summary|
|
||||
|---|---|
|
||||
| executor| <br><br>handles incoming events<br><br>
|
||||
| ignoreCancelled| <br><br>if manual cancellation should be ignored<br><br>
|
||||
| priority| <br><br>the priority when multiple listeners handle this event<br><br>
|
||||
| T| <br><br>the type of event<br><br>
|
||||
|
||||
|
||||
Content
|
||||
inline fun <[T](register.md) : Event> Listener.[register](register.md)(priority: EventPriority, ignoreCancelled: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), noinline executor: (Listener, Event) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html))
|
||||
|
||||
|
||||
[jvm]
|
||||
Brief description
|
||||
|
||||
|
||||
Registers the [SingleListener](-single-listener/index.md) with its event listener.
|
||||
|
||||
|
||||
|
||||
## Parameters
|
||||
|
||||
jvm
|
||||
|
||||
| Name| Summary|
|
||||
|---|---|
|
||||
| ignoreCancelled| <br><br>if manual cancellation should be ignored<br><br>
|
||||
| priority| <br><br>the priority when multiple listeners handle this event<br><br>
|
||||
|
||||
|
||||
Content
|
||||
inline fun <[T](register.md) : Event> [SingleListener](-single-listener/index.md)<[T](register.md)>.[register](register.md)(priority: EventPriority, ignoreCancelled: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
|
||||
|
||||
|
||||
|
@@ -1,53 +0,0 @@
|
||||
<html>
|
||||
<head>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
|
||||
<title>unregister</title>
|
||||
<link href="../../images/logo-icon.svg" rel="icon" type="image/svg">
|
||||
<link href="../../styles/style.css" rel="Stylesheet">
|
||||
<script type="text/javascript" src="../../scripts/navigationLoader.js" async="async"></script>
|
||||
<script type="text/javascript" src="../../scripts/platformContentHandler.js" async="async"></script>
|
||||
<script type="text/javascript" src="../../scripts/sourceset_dependencies.js" async="async"></script>
|
||||
<script type="text/javascript" src="../../scripts/clipboard.js" async="async"></script>
|
||||
<link href="../../styles/jetbrains-mono.css" rel="Stylesheet">
|
||||
<script>var pathToRoot = "../../";</script>
|
||||
</head>
|
||||
<body>
|
||||
<div id="container">
|
||||
<div id="leftColumn">
|
||||
<div id="logo"></div>
|
||||
<div id="paneSearch"></div>
|
||||
<div id="sideMenu"></div>
|
||||
</div>
|
||||
<div id="main">
|
||||
<div id="leftToggler"><span class="icon-toggler"></span></div>
|
||||
<div id="searchBar"></div>
|
||||
<script type="text/javascript" src="../../scripts/pages.js"></script>
|
||||
<script type="text/javascript" src="../../scripts/main.js"></script>
|
||||
<div id="content" pageIds="net.axay.kspigot.event//unregister/org.bukkit.event.Listener#/PointingToDeclaration/">
|
||||
<div class="breadcrumbs"><a href="../index.html">KSpigot</a>/<a href="index.html">net.axay.kspigot.event</a>/<a href="unregister.html">unregister</a></div>
|
||||
<div class="cover ">
|
||||
<h1 class="cover"><a data-name="unregister"></a><span>unregister</span></h1>
|
||||
</div>
|
||||
<div class="divergent-group" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="brief-with-platform-tags"><div class="inner-brief-with-platform-tags"><p class="paragraph">Shortcut for unregistering all events in this listener.</p></div>
|
||||
<span class="pull-right"></span></div>
|
||||
|
||||
<div class="main-subrow">
|
||||
<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 "><div class="symbol monospace">fun <span data-unresolved-link="org.bukkit.event/Listener///PointingToDeclaration/">Listener</span>.<a href="unregister.html">unregister</a>()<span class="top-right-position"><span class="copy-icon"><svg width="24" height="24" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||
<path fill-rule="evenodd" clip-rule="evenodd" d="M5 4H15V16H5V4ZM17 7H19V18V20H17H8V18H17V7Z" fill="black"/>
|
||||
</svg></span><div class="copy-popup-wrapper popup-to-left"><svg width="18" height="18" viewBox="0 0 18 18" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||
<path d="M18 9C18 14 14 18 9 18C4 18 0 14 0 9C0 4 4 0 9 0C14 0 18 4 18 9ZM14.2 6.2L12.8 4.8L7.5 10.1L5.3 7.8L3.8 9.2L7.5 13L14.2 6.2Z" fill="#4DBB5F"/>
|
||||
</svg><span>Content copied to clipboard</span></div></span></div></div></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="footer"><span class="go-to-top-icon"><a href="#container"><svg width="12" height="10" viewBox="0 0 12 10" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||
<path d="M11.3337 9.66683H0.666992L6.00033 3.66683L11.3337 9.66683Z" fill="black"/>
|
||||
<path d="M0.666992 0.333496H11.3337V1.66683H0.666992V0.333496Z" fill="black"/>
|
||||
</svg></a></span><span>© 2020 Copyright</span><span class="pull-right"><span>Sponsored and developed by dokka</span><a href="https://github.com/Kotlin/dokka"><span class="padded-icon"><svg width="8" height="8" viewBox="0 0 8 8" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||
<path d="M8 0H2.3949L4.84076 2.44586L0 7.28662L0.713376 8L5.55414 3.15924L8 5.6051V0Z" fill="black"/>
|
||||
</svg></span></a></span></div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
20
docs/-k-spigot/net.axay.kspigot.event/unregister.md
Normal file
20
docs/-k-spigot/net.axay.kspigot.event/unregister.md
Normal file
@@ -0,0 +1,20 @@
|
||||
---
|
||||
title: unregister -
|
||||
---
|
||||
//[KSpigot](../index.md)/[net.axay.kspigot.event](index.md)/[unregister](unregister.md)
|
||||
|
||||
|
||||
|
||||
# unregister
|
||||
[jvm]
|
||||
Brief description
|
||||
|
||||
|
||||
Shortcut for unregistering all events in this listener.
|
||||
|
||||
|
||||
Content
|
||||
fun Listener.[unregister](unregister.md)()
|
||||
|
||||
|
||||
|
Reference in New Issue
Block a user