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

141 lines
17 KiB
HTML

<html>
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>net.axay.kspigot.extensions</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////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</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></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="1819047555%2FFunctions%2F769193423" anchor-label="broadcast" id="1819047555%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="broadcast.html">broadcast</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1819047555%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 <a href="broadcast.html">broadcast</a>(msg: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</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"></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="1819047555%2FFunctions%2F769193423" anchor-label="broadcast" id="1819047555%2FFunctions%2F769193423" data-filterable-set=":dokkaHtml/main"></a><div class="brief "><a data-name="1819047555%2FFunctions%2F769193423" anchor-label="broadcast" id="1819047555%2FFunctions%2F769193423" data-filterable-set=":dokkaHtml/main"></a>Broadcasts a message (<a href="broadcast.html">msg</a>) on the server.</div></div>
</div>
</div>
</div>
</div>
<a data-name="-1864717394%2FFunctions%2F769193423" anchor-label="pluginKey" id="-1864717394%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="plugin-key.html">pluginKey</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1864717394%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 <a href="plugin-key.html">pluginKey</a>(key: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>): <span data-unresolved-link="org.bukkit/NamespacedKey///PointingToDeclaration/">NamespacedKey</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>
<a data-name="-1864717394%2FFunctions%2F769193423" anchor-label="pluginKey" id="-1864717394%2FFunctions%2F769193423" data-filterable-set=":dokkaHtml/main"></a><div class="brief "><a data-name="-1864717394%2FFunctions%2F769193423" anchor-label="pluginKey" id="-1864717394%2FFunctions%2F769193423" data-filterable-set=":dokkaHtml/main"></a>Shortcut for creating a new <span data-unresolved-link="org.bukkit/NamespacedKey///PointingToDeclaration/">NamespacedKey</span></div></div>
</div>
</div>
</div>
</div>
</div>
<h2 class="">Properties</h2>
<div class="table" data-togglable="Properties"><a data-name="-1034842741%2FProperties%2F769193423" anchor-label="console" id="-1034842741%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="console.html">console</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1034842741%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="-1034842741%2FProperties%2F769193423" anchor-label="console" id="-1034842741%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><div class="symbol monospace">val <a href="console.html">console</a>: <span data-unresolved-link="org.bukkit.command/ConsoleCommandSender///PointingToDeclaration/">ConsoleCommandSender</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="-1034842741%2FProperties%2F769193423" anchor-label="console" id="-1034842741%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a>Shortcut to get the ConsoleSender.</div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-1918950333%2FProperties%2F769193423" anchor-label="onlinePlayers" id="-1918950333%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="online-players.html">onlinePlayers</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1918950333%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="-1918950333%2FProperties%2F769193423" anchor-label="onlinePlayers" id="-1918950333%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><div class="symbol monospace">val <a href="online-players.html">onlinePlayers</a>: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-collection/index.html">Collection</a>&lt;<span data-unresolved-link="org.bukkit.entity/Player///PointingToDeclaration/">Player</span>&gt;<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="-1918950333%2FProperties%2F769193423" anchor-label="onlinePlayers" id="-1918950333%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a>Shortcut to get all online players.</div></div></div>
</div>
</div>
</div>
</div>
<a data-name="956916375%2FProperties%2F769193423" anchor-label="onlineSenders" id="956916375%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="online-senders.html">onlineSenders</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="956916375%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="956916375%2FProperties%2F769193423" anchor-label="onlineSenders" id="956916375%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><div class="symbol monospace">val <a href="online-senders.html">onlineSenders</a>: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-collection/index.html">Collection</a>&lt;<span data-unresolved-link="org.bukkit.command/CommandSender///PointingToDeclaration/">CommandSender</span>&gt;<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="956916375%2FProperties%2F769193423" anchor-label="onlineSenders" id="956916375%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a>Shortcut to get a collection of all online players plus the console command sender.</div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-327078008%2FProperties%2F769193423" anchor-label="pluginManager" id="-327078008%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="plugin-manager.html">pluginManager</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-327078008%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="-327078008%2FProperties%2F769193423" anchor-label="pluginManager" id="-327078008%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><div class="symbol monospace">val <a href="plugin-manager.html">pluginManager</a>: <span data-unresolved-link="org.bukkit.plugin/PluginManager///PointingToDeclaration/">PluginManager</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="-327078008%2FProperties%2F769193423" anchor-label="pluginManager" id="-327078008%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a>Shortcut to get the PluginManager.</div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-1022252555%2FProperties%2F769193423" anchor-label="server" id="-1022252555%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="server.html">server</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1022252555%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="-1022252555%2FProperties%2F769193423" anchor-label="server" id="-1022252555%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><div class="symbol monospace">val <a href="server.html">server</a>: <span data-unresolved-link="org.bukkit/Server///PointingToDeclaration/">Server</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="-1022252555%2FProperties%2F769193423" anchor-label="server" id="-1022252555%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a>Shortcut to get the Server.</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>