star/KSpigot
1
0
Fork 0
Code Pull Requests Packages Activity

Updated documentation to R14

Browse Source
This commit is contained in:
bluefireoly
2020-10-22 19:26:16 +02:00
parent 99ffe08258
commit 8a0a49e63d
1097 changed files with 64786 additions and 24939 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
docs/-k-spigot/net.axay.kspigot.runnables/task.html
View File

@@ -3,12 +3,15 @@
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>task</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/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>
<script>var pathToRoot = "../../";</script>
</head>
<body>
@@ -23,22 +26,21 @@
<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.runnables//task/#kotlin.Boolean#kotlin.Long#kotlin.Long?#kotlin.Long?#kotlin.Boolean#kotlin.Function0[kotlin.Unit]?#kotlin.Function1[net.axay.kspigot.runnables.KSpigotRunnable,kotlin.Unit]?/PointingToDeclaration/">
<div id="content" pageIds="net.axay.kspigot.runnables//task/#kotlin.Boolean#kotlin.Long#kotlin.Long?#kotlin.Long?#kotlin.Boolean#kotlin.Function0[kotlin.Unit]?#kotlin.Function1[net.axay.kspigot.runnables.KSpigotRunnable,kotlin.Unit]?/PointingToDeclaration//-1614831900">
<div class="breadcrumbs"><a href="../index.html">KSpigot</a>/<a href="index.html">net.axay.kspigot.runnables</a>/<a href="task.html">task</a></div>
<div class="cover ">
<h1 class="cover"><a data-name="task"></a><span>task</span></h1>
<h1 class="cover"><span>task</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">Starts a new BukkitRunnable.</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.runnables//task/#kotlin.Boolean#kotlin.Long#kotlin.Long?#kotlin.Long?#kotlin.Boolean#kotlin.Function0[kotlin.Unit]?#kotlin.Function1[net.axay.kspigot.runnables.KSpigotRunnable,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>delay</div><div class="title"><div data-togglable="Parameters"><p class="paragraph">the delay (in ticks) until the first execution of the task</p></div></div></div></div><a data-name="net.axay.kspigot.runnables//task/#kotlin.Boolean#kotlin.Long#kotlin.Long?#kotlin.Long?#kotlin.Boolean#kotlin.Function0[kotlin.Unit]?#kotlin.Function1[net.axay.kspigot.runnables.KSpigotRunnable,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>endCallback</div><div class="title"><div data-togglable="Parameters"><p class="paragraph">code that should always be executed when the runnable ends</p></div></div></div></div><a data-name="net.axay.kspigot.runnables//task/#kotlin.Boolean#kotlin.Long#kotlin.Long?#kotlin.Long?#kotlin.Boolean#kotlin.Function0[kotlin.Unit]?#kotlin.Function1[net.axay.kspigot.runnables.KSpigotRunnable,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>howOften</div><div class="title"><div data-togglable="Parameters"><p class="paragraph">how many times the task should be executed - null for infinite execution</p></div></div></div></div><a data-name="net.axay.kspigot.runnables//task/#kotlin.Boolean#kotlin.Long#kotlin.Long?#kotlin.Long?#kotlin.Boolean#kotlin.Function0[kotlin.Unit]?#kotlin.Function1[net.axay.kspigot.runnables.KSpigotRunnable,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>period</div><div class="title"><div data-togglable="Parameters"><p class="paragraph">at which interval (in ticks) the task should be repeated</p></div></div></div></div><a data-name="net.axay.kspigot.runnables//task/#kotlin.Boolean#kotlin.Long#kotlin.Long?#kotlin.Long?#kotlin.Boolean#kotlin.Function0[kotlin.Unit]?#kotlin.Function1[net.axay.kspigot.runnables.KSpigotRunnable,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>runnable</div><div class="title"><div data-togglable="Parameters"><p class="paragraph">the runnable which should be executed each repetition</p></div></div></div></div><a data-name="net.axay.kspigot.runnables//task/#kotlin.Boolean#kotlin.Long#kotlin.Long?#kotlin.Long?#kotlin.Boolean#kotlin.Function0[kotlin.Unit]?#kotlin.Function1[net.axay.kspigot.runnables.KSpigotRunnable,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>safe</div><div class="title"><div data-togglable="Parameters"><p class="paragraph">if the endCallback of the runnable should always be executed, even if the server shuts down or the runnable ends prematurely</p></div></div></div></div><a data-name="net.axay.kspigot.runnables//task/#kotlin.Boolean#kotlin.Long#kotlin.Long?#kotlin.Long?#kotlin.Boolean#kotlin.Function0[kotlin.Unit]?#kotlin.Function1[net.axay.kspigot.runnables.KSpigotRunnable,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>sync</div><div class="title"><div data-togglable="Parameters"><p class="paragraph">if the runnable should run sync (true) or async (false)</p></div></div></div></div></div></div></div></div></div></div>
<span class="pull-right"></span></div>
<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 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 <a href="task.html">task</a>(sync: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a>, delay: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a>, period: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a>?, howOften: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a>?, safe: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a>, endCallback: () -&gt; <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a>?, runnable: (<a href="-k-spigot-runnable/index.html">KSpigotRunnable</a>) -&gt; <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">
<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="task.html">task</a>(sync: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a> = true, delay: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a> = 0, period: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a>? = null, howOften: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a>? = null, safe: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a> = false, endCallback: () -&gt; <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a>? = null, runnable: (<a href="-k-spigot-runnable/index.html">KSpigotRunnable</a>) -&gt; <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a>? = null)<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>
</svg><span>Content copied to clipboard</span></div></span></div></div></div>
</div>
</div>
<p class="paragraph">Starts a new BukkitRunnable.</p><h2 class="">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"><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex">delay</span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">the delay (in ticks) until the first execution of the task</p></div></div></div></div></div><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex">endCallback</span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">code that should always be executed when the runnable ends</p></div></div></div></div></div><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex">howOften</span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">how many times the task should be executed - null for infinite execution</p></div></div></div></div></div><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex">period</span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">at which interval (in ticks) the task should be repeated</p></div></div></div></div></div><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex">runnable</span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">the runnable which should be executed each repetition</p></div></div></div></div></div><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex">safe</span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">if the endCallback of the runnable should always be executed, even if the server shuts down or the runnable ends prematurely</p></div></div></div></div></div><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex">sync</span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">if the runnable should run sync (true) or async (false)</p></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"/>