Skip to content

Commit ee2bedb

Browse files
author
Retype GitHub Action
committed
Refreshes Retype-generated documentation.
Process triggered by Grabsky.
1 parent 75332e3 commit ee2bedb

11 files changed

Lines changed: 109 additions & 100 deletions

File tree

‎404.html‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<head>
44
<meta charset="UTF-8">
55
<meta name="viewport" content="width=device-width,initial-scale=1">
6-
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="3.7.0.797539453036">
6+
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="3.7.0.797543019182">
77

88
<!-- See retype.com -->
99
<meta name="generator" content="Retype 3.7.0">
@@ -28,11 +28,11 @@
2828
<script data-cfasync="false">(function () { var el = document.documentElement, m = localStorage.getItem("doc_theme"), wm = window.matchMedia; if (m === "dark" || (!m && wm && wm("(prefers-color-scheme: dark)").matches)) { el.classList.add("dark") } else { el.classList.remove("dark") } })();</script>
2929

3030
<link href="/assets/favicon.png" rel="icon">
31-
<link href="/resources/css/retype.css?v=3.7.0.797539453036" rel="stylesheet">
31+
<link href="/resources/css/retype.css?v=3.7.0.797543019182" rel="stylesheet">
3232

33-
<script data-cfasync="false" src="/resources/js/config.js?v=3.7.0.797539453036" data-turbo-eval="false" defer></script>
33+
<script data-cfasync="false" src="/resources/js/config.js?v=3.7.0.797543019182" data-turbo-eval="false" defer></script>
3434
<script data-cfasync="false" src="/resources/js/retype.js?v=3.7.0" data-turbo-eval="false" defer></script>
35-
<script id="lunr-js" data-cfasync="false" src="/resources/js/lunr.js?v=3.7.0.797539453036" data-turbo-eval="false" defer></script>
35+
<script id="lunr-js" data-cfasync="false" src="/resources/js/lunr.js?v=3.7.0.797543019182" data-turbo-eval="false" defer></script>
3636

3737
<style>
3838

‎assets/lua.svg‎

Lines changed: 0 additions & 1 deletion
This file was deleted.

‎commands/index.html‎

Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,15 @@
33
<head>
44
<meta charset="UTF-8">
55
<meta name="viewport" content="width=device-width,initial-scale=1">
6-
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="3.7.0.797539453036">
6+
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="3.7.0.797543019182">
77

88
<!-- See retype.com -->
99
<meta name="generator" content="Retype 3.7.0">
1010

1111
<!-- Primary Meta Tags -->
1212
<title>Commands</title>
1313
<meta name="title" content="Commands">
14-
<meta name="description" content="List of commands provided by LuaLink.">
14+
<meta name="description" content="List of all commands and permissions provided by LuaLink.">
1515

1616
<!-- Canonical -->
1717
<link rel="canonical" href="/commands/">
@@ -20,22 +20,22 @@
2020
<meta property="og:type" content="website">
2121
<meta property="og:url" content="/commands/">
2222
<meta property="og:title" content="Commands">
23-
<meta property="og:description" content="List of commands provided by LuaLink.">
23+
<meta property="og:description" content="List of all commands and permissions provided by LuaLink.">
2424

2525
<!-- Twitter -->
2626
<meta property="twitter:card" content="summary_large_image">
2727
<meta property="twitter:url" content="/commands/">
2828
<meta property="twitter:title" content="Commands">
29-
<meta property="twitter:description" content="List of commands provided by LuaLink.">
29+
<meta property="twitter:description" content="List of all commands and permissions provided by LuaLink.">
3030

3131
<script data-cfasync="false">(function () { var el = document.documentElement, m = localStorage.getItem("doc_theme"), wm = window.matchMedia; if (m === "dark" || (!m && wm && wm("(prefers-color-scheme: dark)").matches)) { el.classList.add("dark") } else { el.classList.remove("dark") } })();</script>
3232

3333
<link href="../assets/favicon.png" rel="icon">
34-
<link href="../resources/css/retype.css?v=3.7.0.797539453036" rel="stylesheet">
34+
<link href="../resources/css/retype.css?v=3.7.0.797543019182" rel="stylesheet">
3535

36-
<script data-cfasync="false" src="../resources/js/config.js?v=3.7.0.797539453036" data-turbo-eval="false" defer></script>
36+
<script data-cfasync="false" src="../resources/js/config.js?v=3.7.0.797543019182" data-turbo-eval="false" defer></script>
3737
<script data-cfasync="false" src="../resources/js/retype.js?v=3.7.0" data-turbo-eval="false" defer></script>
38-
<script id="lunr-js" data-cfasync="false" src="../resources/js/lunr.js?v=3.7.0.797539453036" data-turbo-eval="false" defer></script>
38+
<script id="lunr-js" data-cfasync="false" src="../resources/js/lunr.js?v=3.7.0.797543019182" data-turbo-eval="false" defer></script>
3939

4040
<style>
4141

@@ -244,40 +244,41 @@ <h1>
244244
<span>Commands</span>
245245
</h1>
246246
</doc-anchor-target>
247-
<p>List of commands provided by LuaLink.</p>
247+
<p>List of all commands and permissions provided by LuaLink.</p>
248248
<div class="table-wrapper scrollbar overflow-hidden">
249-
<table class="compact">
249+
<table class="comfortable">
250250
<thead>
251251
<tr>
252252
<th>Command</th>
253253
<th>Permission</th>
254-
<th>Description </th>
254+
<th>Description</th>
255255
</tr>
256256
</thead>
257257
<tbody>
258258
<tr>
259-
<td><code v-pre>/lualink load &lt;script&gt;</code></td>
260-
<td>lualink.command.lualink.load</td>
259+
<td><code v-pre>/lualink load (script)</code></td>
260+
<td>lualink.command.load</td>
261261
<td>Loads specified Lua script.</td>
262262
</tr>
263263
<tr>
264-
<td><code v-pre>/lualink unload &lt;script&gt;</code></td>
265-
<td>lualink.command.lualink.unload</td>
264+
<td><code v-pre>/lualink unload (script)</code></td>
265+
<td>lualink.command.unload</td>
266266
<td>Unloads specified Lua script.</td>
267267
</tr>
268268
<tr>
269-
<td><code v-pre>/lualink reload &lt;script&gt;</code></td>
270-
<td>lualink.command.lualink.reload</td>
269+
<td><code v-pre>/lualink reload (script)</code></td>
270+
<td>lualink.command.reload</td>
271271
<td>Reloads specified Lua script.</td>
272272
</tr>
273273
<tr>
274274
<td><code v-pre>/lualink list</code></td>
275-
<td>lualink.command.lualink.list</td>
275+
<td>lualink.command.list</td>
276276
<td>Lists all loaded Lua scripts.</td>
277277
</tr>
278278
</tbody>
279279
</table>
280280
</div>
281+
<p>Please be cautious and give access to these commands only to people you trust.</p>
281282

282283

283284
<!-- Required only on API pages -->

‎dependencies/index.html‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,15 @@
33
<head>
44
<meta charset="UTF-8">
55
<meta name="viewport" content="width=device-width,initial-scale=1">
6-
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="3.7.0.797539453036">
6+
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="3.7.0.797543019182">
77

88
<!-- See retype.com -->
99
<meta name="generator" content="Retype 3.7.0">
1010

1111
<!-- Primary Meta Tags -->
1212
<title>Dependencies</title>
1313
<meta name="title" content="Dependencies">
14+
<meta name="description" content="TO-DO">
1415

1516
<!-- Canonical -->
1617
<link rel="canonical" href="/dependencies/">
@@ -19,20 +20,22 @@
1920
<meta property="og:type" content="website">
2021
<meta property="og:url" content="/dependencies/">
2122
<meta property="og:title" content="Dependencies">
23+
<meta property="og:description" content="TO-DO">
2224

2325
<!-- Twitter -->
2426
<meta property="twitter:card" content="summary_large_image">
2527
<meta property="twitter:url" content="/dependencies/">
2628
<meta property="twitter:title" content="Dependencies">
29+
<meta property="twitter:description" content="TO-DO">
2730

2831
<script data-cfasync="false">(function () { var el = document.documentElement, m = localStorage.getItem("doc_theme"), wm = window.matchMedia; if (m === "dark" || (!m && wm && wm("(prefers-color-scheme: dark)").matches)) { el.classList.add("dark") } else { el.classList.remove("dark") } })();</script>
2932

3033
<link href="../assets/favicon.png" rel="icon">
31-
<link href="../resources/css/retype.css?v=3.7.0.797539453036" rel="stylesheet">
34+
<link href="../resources/css/retype.css?v=3.7.0.797543019182" rel="stylesheet">
3235

33-
<script data-cfasync="false" src="../resources/js/config.js?v=3.7.0.797539453036" data-turbo-eval="false" defer></script>
36+
<script data-cfasync="false" src="../resources/js/config.js?v=3.7.0.797543019182" data-turbo-eval="false" defer></script>
3437
<script data-cfasync="false" src="../resources/js/retype.js?v=3.7.0" data-turbo-eval="false" defer></script>
35-
<script id="lunr-js" data-cfasync="false" src="../resources/js/lunr.js?v=3.7.0.797539453036" data-turbo-eval="false" defer></script>
38+
<script id="lunr-js" data-cfasync="false" src="../resources/js/lunr.js?v=3.7.0.797543019182" data-turbo-eval="false" defer></script>
3639

3740
<style>
3841

@@ -241,6 +244,7 @@ <h1>
241244
<span>Dependencies</span>
242245
</h1>
243246
</doc-anchor-target>
247+
<p>TO-DO</p>
244248

245249

246250
<!-- Required only on API pages -->

‎getting-started/index.html‎

Lines changed: 30 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<head>
44
<meta charset="UTF-8">
55
<meta name="viewport" content="width=device-width,initial-scale=1">
6-
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="3.7.0.797539453036">
6+
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="3.7.0.797543019182">
77

88
<!-- See retype.com -->
99
<meta name="generator" content="Retype 3.7.0">
@@ -31,12 +31,12 @@
3131
<script data-cfasync="false">(function () { var el = document.documentElement, m = localStorage.getItem("doc_theme"), wm = window.matchMedia; if (m === "dark" || (!m && wm && wm("(prefers-color-scheme: dark)").matches)) { el.classList.add("dark") } else { el.classList.remove("dark") } })();</script>
3232

3333
<link href="../assets/favicon.png" rel="icon">
34-
<link href="../resources/css/retype.css?v=3.7.0.797539453036" rel="stylesheet">
34+
<link href="../resources/css/retype.css?v=3.7.0.797543019182" rel="stylesheet">
3535

36-
<script data-cfasync="false" src="../resources/js/config.js?v=3.7.0.797539453036" data-turbo-eval="false" defer></script>
36+
<script data-cfasync="false" src="../resources/js/config.js?v=3.7.0.797543019182" data-turbo-eval="false" defer></script>
3737
<script data-cfasync="false" src="../resources/js/retype.js?v=3.7.0" data-turbo-eval="false" defer></script>
38-
<script id="lunr-js" data-cfasync="false" src="../resources/js/lunr.js?v=3.7.0.797539453036" data-turbo-eval="false" defer></script>
39-
<script id="prism-js" data-cfasync="false" src="../resources/js/prism.js?v=3.7.0.797539453036" defer></script>
38+
<script id="lunr-js" data-cfasync="false" src="../resources/js/lunr.js?v=3.7.0.797543019182" data-turbo-eval="false" defer></script>
39+
<script id="prism-js" data-cfasync="false" src="../resources/js/prism.js?v=3.7.0.797543019182" defer></script>
4040

4141
<style>
4242

@@ -270,7 +270,7 @@ <h1>
270270
<td><doc-anchor-trigger to="#script-life-cycle">2. Script Life-cycle</doc-anchor-trigger></td>
271271
</tr>
272272
<tr>
273-
<td><doc-anchor-trigger to="#importing">3. Importing</doc-anchor-trigger></td>
273+
<td><doc-anchor-trigger to="#importing-and-requiring">3. Importing and Requiring</doc-anchor-trigger></td>
274274
</tr>
275275
<tr>
276276
<td><doc-anchor-trigger to="#constructors-and-instances">4. Constructors and Instances</doc-anchor-trigger></td>
@@ -296,12 +296,12 @@ <h3>
296296
</doc-anchor-target>
297297
<p>There are a couple of things to keep in mind when using LuaLink.</p>
298298
<ul>
299-
<li>Each script is stored in a separate folder inside the <code v-pre>plugins/LuaLink/scripts</code> directory, and libraries are stored in the <code v-pre>plugins/LuaLink/libs</code> directory.<br />
300-
<sup>More about libraries can be found on the <strong><a href="../libraries/">Libraries</a></strong> page.</sup></li>
301-
<li>Entry point of the script (or library) is a file named <code v-pre>main.lua</code> or <code v-pre>init.lua</code>.<br />
302-
<sup>It doesn&#x27;t matter which file you choose as the entry point, but you should be consistent with your naming convention.</sup></li>
303299
<li>Script life-cycle can be managed using <code v-pre>/lualink load</code>, <code v-pre>/lualink unload</code> and <code v-pre>/lualink reload</code> commands.<br />
304300
<sup>More on this can be found on the <strong><a href="../commands/">Commands</a></strong> page.</sup></li>
301+
<li>Each script is stored in a separate folder inside the <code v-pre>plugins/LuaLink/scripts</code> directory, and libraries are stored in the <code v-pre>plugins/LuaLink/libs</code> directory.<br />
302+
<sup>More about libraries can be found on the <strong><a href="../libraries/">Libraries</a></strong> page.</sup></li>
303+
<li>Entry point of the script (or library) is a file named <code v-pre>main.lua</code>.<br />
304+
<sup>More files can be created and loaded using the <code v-pre>require</code> keyword.</sup></li>
305305
</ul>
306306
<br />
307307
<doc-anchor-target id="script-life-cycle">
@@ -314,12 +314,12 @@ <h3>
314314
<div class="codeblock-wrapper"><doc-codeblock>
315315
<pre class="language-lua"><code v-pre class="language-lua">-- Called after the script has been successfully loaded.
316316
script:onLoad(function()
317-
script:logger:info(&quot;Script has been loaded.&quot;)
317+
script.logger:info(&quot;Script has been loaded.&quot;)
318318
end)
319319

320320
-- Called before the script is attempted to be unloaded.
321321
script:onUnload(function()
322-
script:logger:info(&quot;Script is about to be unloaded.&quot;)
322+
script.logger:info(&quot;Script is about to be unloaded.&quot;)
323323
end)</code></pre>
324324
</doc-codeblock></div>
325325
<br />
@@ -353,7 +353,8 @@ <h3>
353353
counter:increment()
354354
counter:increment()
355355
-- Printing current value of the counter to the console.
356-
script.logger.info(counter:get() ..</code></pre>
356+
script.logger:info(counter:get() .. &quot; is the current value of the counter.&quot;)
357+
end)</code></pre>
357358
</doc-codeblock></div>
358359
<br />
359360
<doc-anchor-target id="constructors-and-instances">
@@ -364,9 +365,9 @@ <h3>
364365
</doc-anchor-target>
365366
<p>New instances of Java classes can be created as follows.</p>
366367
<div class="codeblock-wrapper"><doc-codeblock>
367-
<pre class="language-lua"><code v-pre class="language-lua">local Bukkit = import &quot;org.bukkit.Bukkit&quot;
368-
local Keyed = import &quot;net.kyori.adventure.key.Keyed&quot;
369-
local NamespacedKey = import &quot;org.bukkit.NamespacedKey&quot;
368+
<pre class="language-lua"><code v-pre class="language-lua">local Bukkit = import(&quot;org.bukkit.Bukkit&quot;)
369+
local Keyed = import(&quot;net.kyori.adventure.key.Keyed&quot;)
370+
local NamespacedKey = import(&quot;org.bukkit.NamespacedKey&quot;)
370371

371372
script.onLoad(function()
372373
-- Creating new instance of NamespacedKey class.
@@ -376,7 +377,7 @@ <h3>
376377
-- Checking if World is instance of Keyed. (SPOILER: IT IS)
377378
if (Keyed.class:isInstance(world) == true) then
378379
-- Sending loaded chunks count to the console.
379-
script.logger.info(&quot;World &quot; .. world:key():asString() .. &quot; has &quot; .. world:getChunkCount() .. &quot; chunks loaded.&quot;)
380+
script.logger:info(&quot;World &quot; .. world:key():asString() .. &quot; has &quot; .. world:getChunkCount() .. &quot; chunks loaded.&quot;)
380381
end
381382
end)</code></pre>
382383
</doc-codeblock></div>
@@ -389,7 +390,7 @@ <h3>
389390
</doc-anchor-target>
390391
<p>Non-complex commands can be created with little effort using built-in API.</p>
391392
<div class="codeblock-wrapper"><doc-codeblock>
392-
<pre class="language-lua"><code v-pre class="language-lua">local Bukkit = import &quot;org.bukkit.Bukkit&quot;
393+
<pre class="language-lua"><code v-pre class="language-lua">local Bukkit = import(&quot;org.bukkit.Bukkit&quot;)
393394

394395
-- Function to handle command tab-completion.
395396
function onTabComplete(sender, alias, args)
@@ -441,29 +442,29 @@ <h3>
441442
</doc-anchor-target>
442443
<p>Scheduler can be used to register single-use, delayed or repeating tasks.</p>
443444
<div class="codeblock-wrapper"><doc-codeblock>
444-
<pre class="language-lua"><code v-pre class="language-lua">-- Schedules task to be run on the next tick.
445-
script.run(function()
445+
<pre class="language-lua"><code v-pre class="language-lua">-- Schedules a task to be run on the next tick.
446+
scheduler:run(function()
446447
-- Whatever belongs to the task goes here.
447448
end)
448449

449-
-- Schedules task to be run after 20 ticks has passed. Task function parameter can be omitted if not used.
450-
script.runDelayed(function(task)
450+
-- Schedules a task to be run after 20 ticks has passed.
451+
scheduler:runLater(function()
451452
-- Whatever belongs to the task goes here.
452453
end, 20)
453454

454-
-- Schedules task to be run after 20 ticks has passed, and repeated every 160 ticks. Task function parameter can be omitted if not used.
455-
script.runRepeating(function(task)
455+
-- Schedules a task to be run after 20 ticks has passed, and repeated every 160 ticks.
456+
scheduler:runRepeating(function()
456457
-- Whatever belongs to the task goes here.
457458
end, 20, 160)</code></pre>
458459
</doc-codeblock></div>
459460
<p>Tasks can also be run asynchronously, but please note that neither the Bukkit API nor the LuaLink API is guaranteed to be thread-safe.</p>
460461
<div class="codeblock-wrapper"><doc-codeblock>
461462
<pre class="language-lua"><code v-pre class="language-lua">-- Schedules asynchronous task to be run on the next tick.
462-
script.runAsync(callback: () -&gt; void): void
463-
-- Schedules asynchronous task to be run after {delay} ticks has passed. Task function parameter can be omitted if not used.
464-
script.runDelayedAsync(callback: (task: BukkitTask) -&gt; void, delay: number): BukkitTask
465-
-- Schedules task to be run after {delay} ticks has passed, and repeated every {period} ticks. Task function parameter can be omitted if not used.
466-
script.runRepeatingAsync(callback: (task: BukkitTask) -&gt; void, delay: number, period: number): BukkitTask</code></pre>
463+
scheduler:runAsync(handler: () -&gt; void): BukkitTask
464+
-- Schedules asynchronous task to be run after {delay} ticks has passed.
465+
scheduler:runLaterAsync(handler: () -&gt; void, delay: number): BukkitTask
466+
-- Schedules task to be run after {delay} ticks has passed, and repeated every {period} ticks.
467+
scheduler:runRepeatingAsync(handler: () -&gt; void, delay: number, period: number): BukkitTask</code></pre>
467468
</doc-codeblock></div>
468469

469470

0 commit comments

Comments
 (0)