Skip to content

Commit 9681314

Browse files
ModerockyModerocky
committed
Fix APIDocs pages.
1 parent aa314a1 commit 9681314

File tree

91 files changed

+10726
-11
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

91 files changed

+10726
-11
lines changed

‎docs/index.html

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

‎docs/org/byteskript/index.html

Lines changed: 45 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/org/byteskript/skript/api/Deletable.html

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="UTF-8">
5+
<meta name="viewport" content="width=device-width, initial-scale=1">
6+
<meta name="description" content="Documentation for this class and its members.">
7+
<meta name="keywords" content="Deletable, org.byteskript.skript.api.Deletable, org.byteskript.skript.api">
8+
<title>Deletable</title>
9+
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.4.0/styles/github-dark.min.css" crossorigin="anonymous">
10+
<link href="https://cdn.jsdelivr.net/npm/bootstrap@5.1.3/dist/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-1BmE4kWBq78iYhFldvKuhfTAU6auU8tT94WrHftjDbrCEXSU1oBoqyl2QvZ6jIW3" crossorigin="anonymous">
11+
<link href="https://cdnjs.cloudflare.com/ajax/libs/github-markdown-css/4.0.0/github-markdown.min.css" rel="stylesheet" crossorigin="anonymous">
12+
</head>
13+
<body>
14+
<main id="body" class="container">
15+
<div class="row"><div class="col-lg-12"><div class="col-lg-12 flex-md-row mt-4 mb-4 p-4 border rounded shadow-sm h-md-250 position-relative"><div class="row"><div class="col-md-8 col-sm-12"><a class="navbar-brand text-dark mr-4" href="../../../../">ByteSkript</a><div class="navbar-collapse offcanvas-collapse"><nav class="navbar navbar-expand-lg"><ol class="breadcrumb navbar-nav me-auto mb-2 mb-lg-0"><li class="breadcrumb-item"><a href="../../../../org/">org</a></li><li class="breadcrumb-item"><a href="../../../../org/byteskript/">byteskript</a></li><li class="breadcrumb-item"><a href="../../../../org/byteskript/skript/">skript</a></li><li class="breadcrumb-item"><a href="../../../../org/byteskript/skript/api/">api</a></li><li class="breadcrumb-item active" aria-current="page">Deletable</li></ol></nav></div></div><div class="col-md-4 col-sm-12"></div></div></div></div></div>
16+
<section id="class:Deletable"><div class="row mb-2">
17+
<div class="col-lg-8 col-md-12 col-sm-12">
18+
<div class="row g-0 border rounded flex-md-row mb-4 shadow-sm h-md-250 position-relative">
19+
<div class="col bg-light col-lg-12 pt-4 px-4 pb-0 m-0">
20+
<h3 class="mb-0">Deletable</h3><p><strong class="d-inline-block mb-2 text-success"data-bs-toggle="tooltip" data-bs-placement="right" title="An abstract template to be implemented.">Interface</strong></p></div>
21+
<div class="col col-lg-8 col-sm-12 pt-1 pb-4 px-4 d-flex flex-column position-static"><div class="row p-2"></div><p>Something that can be deleted, and should be compiled as normal to handle the effect.</p>
22+
23+
</div>
24+
<div class="col-lg-4 col-md-12 card-deck"><div class="card m-2 mx-3 bg-body rounded shadow-sm"><div class="card-header">Modifiers</div><div class="card-body"><p class="pb-3 mb-0 small lh-sm"><span class="badge bg-primary" data-bs-toggle="tooltip" data-bs-placement="right" title="Accessible from anywhere.">public</span> <span class="badge bg-info" data-bs-toggle="tooltip" data-bs-placement="right" title="Must be overridden by another class.">abstract</span> </p></div></div></div>
25+
</div>
26+
</div><div class="col col-lg-4 col-sm-12 col-md-12"></div>
27+
</div>
28+
</section>
29+
</main>
30+
31+
<script src="https://cdn.jsdelivr.net/npm/@popperjs/core@2.10.2/dist/umd/popper.min.js" integrity="sha384-7+zCNj/IqJ95wo16oMtfsKbZ9ccEh31eOz1HGyDuCQ6wgnyJNSYdrPa03rtR1zdB" crossorigin="anonymous"></script>
32+
<script src="https://cdn.jsdelivr.net/npm/bootstrap@5.1.3/dist/js/bootstrap.min.js" integrity="sha384-QJHtvGhmr9XOIpI6YVutG+2QOK9T+ZnN4kzFN1RtK3zEFEIsxhlmWl5/YESvpZ13" crossorigin="anonymous"></script>
33+
<script src="https://use.fontawesome.com/releases/v5.13.1/js/all.js" type="text/javascript" crossorigin="anonymous"></script>
34+
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.4.0/highlight.min.js" crossorigin="anonymous"></script>
35+
<script>
36+
var tooltipTriggerList = [].slice.call(document.querySelectorAll('[data-bs-toggle="tooltip"]'))
37+
var tooltipList = tooltipTriggerList.map(function (tooltipTriggerEl) {
38+
return new bootstrap.Tooltip(tooltipTriggerEl)
39+
})
40+
document.addEventListener('DOMContentLoaded', (event) => {
41+
document.querySelectorAll('pre code').forEach((el) => {
42+
hljs.highlightElement(el);
43+
el.parentElement.classList.add('rounded');
44+
el.classList.add('rounded');
45+
});
46+
});
47+
</script>
48+
</body>
49+
</html>

‎docs/org/byteskript/skript/api/Document.html

Lines changed: 136 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/org/byteskript/skript/api/Event.html

Lines changed: 115 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,115 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="UTF-8">
5+
<meta name="viewport" content="width=device-width, initial-scale=1">
6+
<meta name="description" content="Documentation for this class and its members.">
7+
<meta name="keywords" content="Event, org.byteskript.skript.api.Event, org.byteskript.skript.api">
8+
<title>Event</title>
9+
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.4.0/styles/github-dark.min.css" crossorigin="anonymous">
10+
<link href="https://cdn.jsdelivr.net/npm/bootstrap@5.1.3/dist/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-1BmE4kWBq78iYhFldvKuhfTAU6auU8tT94WrHftjDbrCEXSU1oBoqyl2QvZ6jIW3" crossorigin="anonymous">
11+
<link href="https://cdnjs.cloudflare.com/ajax/libs/github-markdown-css/4.0.0/github-markdown.min.css" rel="stylesheet" crossorigin="anonymous">
12+
</head>
13+
<body>
14+
<main id="body" class="container">
15+
<div class="row"><div class="col-lg-12"><div class="col-lg-12 flex-md-row mt-4 mb-4 p-4 border rounded shadow-sm h-md-250 position-relative"><div class="row"><div class="col-md-8 col-sm-12"><a class="navbar-brand text-dark mr-4" href="../../../../">ByteSkript</a><div class="navbar-collapse offcanvas-collapse"><nav class="navbar navbar-expand-lg"><ol class="breadcrumb navbar-nav me-auto mb-2 mb-lg-0"><li class="breadcrumb-item"><a href="../../../../org/">org</a></li><li class="breadcrumb-item"><a href="../../../../org/byteskript/">byteskript</a></li><li class="breadcrumb-item"><a href="../../../../org/byteskript/skript/">skript</a></li><li class="breadcrumb-item"><a href="../../../../org/byteskript/skript/api/">api</a></li><li class="breadcrumb-item active" aria-current="page">Event</li></ol></nav></div></div><div class="col-md-4 col-sm-12">
16+
<div class="dropdown m-1 d-inline">
17+
<button class="btn btn-primary dropdown-toggle" type="button" id="constructorMenu" data-bs-toggle="dropdown" aria-expanded="false">Constructors</button>
18+
<ul class="dropdown-menu" aria-labelledby="constructorMenu"><li><a class="dropdown-item" href="#constructor:Event(0)">new Event(0)</a></li>
19+
</ul>
20+
</div>
21+
<div class="dropdown m-1 d-inline">
22+
<button class="btn btn-primary dropdown-toggle" type="button" id="methodMenu" data-bs-toggle="dropdown" aria-expanded="false">Methods</button>
23+
<ul class="dropdown-menu" aria-labelledby="methodMenu"><li><a class="dropdown-item" href="#method:run(1)">run</a></li><li><a class="dropdown-item" href="#method:isAsync(0)">isAsync</a></li>
24+
</ul>
25+
</div></div></div></div></div></div>
26+
<section id="class:Event"><div class="row mb-2">
27+
<div class="col-lg-8 col-md-12 col-sm-12">
28+
<div class="row g-0 border rounded flex-md-row mb-4 shadow-sm h-md-250 position-relative">
29+
<div class="col bg-light col-lg-12 pt-4 px-4 pb-0 m-0">
30+
<h3 class="mb-0">Event</h3><p><strong class="d-inline-block mb-2 text-primary"data-bs-toggle="tooltip" data-bs-placement="right" title="An abstract class to be extended.">Abstract Class</strong></p></div>
31+
<div class="col col-lg-8 col-sm-12 pt-1 pb-4 px-4 d-flex flex-column position-static"><div class="row p-2"></div><p>Custom events must extend this class.</p>
32+
<p>The extending version should add any supported event values, and must be registered with the owning library.
33+
New instances of the event are created each time the event needs to be triggered.</p>
34+
35+
</div>
36+
<div class="col-lg-4 col-md-12 card-deck"><div class="card m-2 mx-3 bg-body rounded shadow-sm"><div class="card-header">Extends</div><div class="card-body"><p class="pb-3 mb-0 small lh-sm"><strong class="d-block text-primary"data-bs-toggle="tooltip" data-bs-placement="left" title="java.lang.Object">Object</strong></p></div></div><div class="card m-2 mx-3 bg-body rounded shadow-sm"><div class="card-header">Modifiers</div><div class="card-body"><p class="pb-3 mb-0 small lh-sm"><span class="badge bg-primary" data-bs-toggle="tooltip" data-bs-placement="right" title="Accessible from anywhere.">public</span> <span class="badge bg-info" data-bs-toggle="tooltip" data-bs-placement="right" title="Must be overridden by another class.">abstract</span> </p></div></div></div>
37+
</div>
38+
</div><div class="col col-lg-8 col-sm-12 col-md-12"><div class="rounded bg-dark text-light"><pre><code class="language-java">public class MyEvent extends Event {
39+
40+
public MyEvent() {
41+
}
42+
43+
@EventValue(&quot;blob&quot;) // event-blob
44+
public String getBlob() {
45+
return &quot;blob&quot;;
46+
}
47+
48+
@EventValue(&quot;lettuce&quot;) // event-lettuce
49+
public Object getLettuce() {
50+
return null;
51+
}
52+
53+
</code></pre>
54+
</div><div class="rounded bg-dark text-light"><pre><code class="language-java">final MyEvent event = new MyEvent();
55+
// these two are both valid ways to trigger the event
56+
event.run(skript);
57+
skript.runEvent(event);
58+
// for triggering handlers in only one script
59+
skript.runEvent(event, script);
60+
61+
</code></pre>
62+
</div></div>
63+
</div>
64+
</section><h2 class="border-bottom pb-2 mb-0">Constructors</h2><br /><section id="constructor:Event(0)"><div class="row mb-2">
65+
<div class="col-lg-8 col-md-12 col-sm-12">
66+
<div class="row g-0 border rounded flex-md-row mb-4 shadow-sm h-md-250 position-relative">
67+
<div class="col bg-light col-lg-12 pt-4 px-4 pb-0 m-0"><h3 class="mb-0"><span class="text-secondary">new </span>Event<span class="text-secondary"> ()</span></h3><strong class="d-inline-block mb-2 text-primary"data-bs-toggle="tooltip" data-bs-placement="right" title="Creates an instance of this class.">Constructor</strong></div>
68+
<div class="col col-lg-8 col-sm-12 pt-1 pb-4 px-4 d-flex flex-column position-static">No description is available for this element.</div><div class="col-md-4 d-none d-lg-block"><div class="card m-2 mx-3 bg-body rounded shadow-sm"><div class="card-header">Return Type</div><div class="card-body"><p class="pb-3 mb-0 small lh-sm"><strong class="d-block text-primary"data-bs-toggle="tooltip" data-bs-placement="left" title="org.byteskript.skript.api.Event">Event</strong></p></div></div><div class="card m-2 mx-3 bg-body rounded shadow-sm"><div class="card-header">Modifiers</div><div class="card-body"><p class="pb-3 mb-0 small lh-sm"><span class="badge bg-primary" data-bs-toggle="tooltip" data-bs-placement="right" title="Accessible from anywhere.">public</span> </p></div></div></div></div>
69+
</div><div class="col col-lg-4 col-sm-12 col-md-12"></div></div></section><br /><h2 class="border-bottom pb-2 mb-0">Methods</h2><br /><section id="method:run(1)"><div class="row mb-2">
70+
<div class="col-lg-8 col-md-12 col-sm-12">
71+
<div class="row g-0 border rounded flex-md-row mb-4 shadow-sm h-md-250 position-relative">
72+
<div class="col bg-light col-lg-12 pt-4 px-4 pb-0 m-0"><h3 class="mb-0">run<span class="text-secondary"> (Skript)</span></h3><strong class="d-inline-block mb-2 text-primary"data-bs-toggle="tooltip" data-bs-placement="right" title="A callable code trigger.">Method</strong></div>
73+
<div class="col col-lg-8 col-sm-12 pt-1 pb-4 px-4 d-flex flex-column position-static"><p>This is a simple helper method for triggering an event.</p>
74+
<div class="pt-2 col-sm-12"><button class="d-inline btn btn-outline-primary" type="button" data-bs-toggle="collapse" data-bs-target="#params1626877848" aria-expanded="false" aria-controls="params1626877848">Parameters</button><div class="collapse" id="params1626877848">
75+
<table class="table table-borderless">
76+
<thead><tr><th scope="col">Index</th><th scope="col">Type</th><th scope="col">Name</th>
77+
</tr></thead>
78+
<tbody>
79+
<tr><th scope="row">1</th><td>Skript</td><td>skript</td>
80+
</tr>
81+
</tbody>
82+
</table></div></div></div>
83+
<div class="col-lg-4 col-md-12 card-deck"><div class="card m-2 mx-3 bg-body rounded shadow-sm"><div class="card-header">Return Type</div><div class="card-body"><p class="pb-3 mb-0 small lh-sm"><strong class="d-block text-info"data-bs-toggle="tooltip" data-bs-placement="left" title="void">void</strong></p></div></div><div class="card m-2 mx-3 bg-body rounded shadow-sm"><div class="card-header">Modifiers</div><div class="card-body"><p class="pb-3 mb-0 small lh-sm"><span class="badge bg-primary" data-bs-toggle="tooltip" data-bs-placement="right" title="Accessible from anywhere.">public</span> <span class="badge bg-info" data-bs-toggle="tooltip" data-bs-placement="right" title="Cannot be overridden or modified.">final</span> </p></div></div></div></div>
84+
</div><div class="col col-lg-4 col-sm-12 col-md-12"></div></div></section><section id="method:isAsync(0)"><div class="row mb-2">
85+
<div class="col-lg-8 col-md-12 col-sm-12">
86+
<div class="row g-0 border rounded flex-md-row mb-4 shadow-sm h-md-250 position-relative">
87+
<div class="col bg-light col-lg-12 pt-4 px-4 pb-0 m-0"><h3 class="mb-0">isAsync<span class="text-secondary"> ()</span></h3><strong class="d-inline-block mb-2 text-primary"data-bs-toggle="tooltip" data-bs-placement="right" title="A callable code trigger.">Method</strong></div>
88+
<div class="col col-lg-8 col-sm-12 pt-1 pb-4 px-4 d-flex flex-column position-static"><p>This has no purpose currently - all event-handlers run on separate processes.</p>
89+
<p>In the future, this may be used to determine whether a thread
90+
should be reused for multiple handlers of the same event or not.</p>
91+
<p>For now, it can be ignored.</p>
92+
</div>
93+
<div class="col-lg-4 col-md-12 card-deck"><div class="card m-2 mx-3 bg-body rounded shadow-sm"><div class="card-header">Return Type</div><div class="card-body"><p class="pb-3 mb-0 small lh-sm"><strong class="d-block text-info"data-bs-toggle="tooltip" data-bs-placement="left" title="boolean">boolean</strong></p></div></div><div class="card m-2 mx-3 bg-body rounded shadow-sm"><div class="card-header">Modifiers</div><div class="card-body"><p class="pb-3 mb-0 small lh-sm"><span class="badge bg-primary" data-bs-toggle="tooltip" data-bs-placement="right" title="Accessible from anywhere.">public</span> </p></div></div></div></div>
94+
</div><div class="col col-lg-4 col-sm-12 col-md-12"></div></div></section><br />
95+
</main>
96+
97+
<script src="https://cdn.jsdelivr.net/npm/@popperjs/core@2.10.2/dist/umd/popper.min.js" integrity="sha384-7+zCNj/IqJ95wo16oMtfsKbZ9ccEh31eOz1HGyDuCQ6wgnyJNSYdrPa03rtR1zdB" crossorigin="anonymous"></script>
98+
<script src="https://cdn.jsdelivr.net/npm/bootstrap@5.1.3/dist/js/bootstrap.min.js" integrity="sha384-QJHtvGhmr9XOIpI6YVutG+2QOK9T+ZnN4kzFN1RtK3zEFEIsxhlmWl5/YESvpZ13" crossorigin="anonymous"></script>
99+
<script src="https://use.fontawesome.com/releases/v5.13.1/js/all.js" type="text/javascript" crossorigin="anonymous"></script>
100+
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.4.0/highlight.min.js" crossorigin="anonymous"></script>
101+
<script>
102+
var tooltipTriggerList = [].slice.call(document.querySelectorAll('[data-bs-toggle="tooltip"]'))
103+
var tooltipList = tooltipTriggerList.map(function (tooltipTriggerEl) {
104+
return new bootstrap.Tooltip(tooltipTriggerEl)
105+
})
106+
document.addEventListener('DOMContentLoaded', (event) => {
107+
document.querySelectorAll('pre code').forEach((el) => {
108+
hljs.highlightElement(el);
109+
el.parentElement.classList.add('rounded');
110+
el.classList.add('rounded');
111+
});
112+
});
113+
</script>
114+
</body>
115+
</html>

0 commit comments

Comments
 (0)