|
26 | 26 | <section id="class:Event"><div class="row mb-2">
|
27 | 27 | <div class="col-lg-8 col-md-12 col-sm-12">
|
28 | 28 | <div class="row g-0 border rounded flex-md-row mb-4 shadow-sm h-md-250 position-relative">
|
29 |
| -<div class="col col-lg-12 pt-4 px-4 pb-0 m-0"> |
| 29 | +<div class="col bg-light col-lg-12 pt-4 px-4 pb-0 m-0"> |
30 | 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>No description is available for this element. |
32 |
| -</div> |
33 |
| -<div class="col-lg-4 col-sm-12"><div class="col-md-6 col-lg-12 my-3 p-3 bg-body rounded shadow-sm"><h6 class="border-bottom pb-2 mb-0">Extends</h6><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 class="col-md-6 col-lg-12 my-3 p-3 bg-body rounded shadow-sm"><h6 class="border-bottom pb-2 mb-0">Modifiers</h6><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> |
| 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 | + |
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> |
35 | 37 | </div>
|
36 |
| -</div><div class="col col-lg-4 col-sm-12 col-md-12"></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("blob") // event-blob |
| 44 | + public String getBlob() { |
| 45 | + return "blob"; |
| 46 | + } |
| 47 | + |
| 48 | + @EventValue("lettuce") // 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> |
37 | 63 | </div>
|
38 | 64 | </section><h2 class="border-bottom pb-2 mb-0">Constructors</h2><br /><section id="constructor:Event(0)"><div class="row mb-2">
|
39 | 65 | <div class="col-lg-8 col-md-12 col-sm-12">
|
40 | 66 | <div class="row g-0 border rounded flex-md-row mb-4 shadow-sm h-md-250 position-relative">
|
41 |
| -<div class="col 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> |
42 |
| -<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="col-md-6 col-lg-12 my-3 p-3 bg-body rounded shadow-sm"><h6 class="border-bottom pb-2 mb-0">Return Type</h6><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 class="col-md-6 col-lg-12 my-3 p-3 bg-body rounded shadow-sm"><h6 class="border-bottom pb-2 mb-0">Modifiers</h6><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> |
| 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> |
43 | 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">
|
44 | 70 | <div class="col-lg-8 col-md-12 col-sm-12">
|
45 | 71 | <div class="row g-0 border rounded flex-md-row mb-4 shadow-sm h-md-250 position-relative">
|
46 |
| -<div class="col 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> |
47 |
| -<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 class="pt-2 col-sm-12"><button class="d-inline btn btn-outline-primary" type="button" data-bs-toggle="collapse" data-bs-target="#params934549121" aria-expanded="false" aria-controls="params934549121">Parameters</button><div class="collapse" id="params934549121"> |
| 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="#params2054798982" aria-expanded="false" aria-controls="params2054798982">Parameters</button><div class="collapse" id="params2054798982"> |
48 | 75 | <table class="table table-borderless">
|
49 | 76 | <thead><tr><th scope="col">Index</th><th scope="col">Type</th><th scope="col">Name</th>
|
50 | 77 | </tr></thead>
|
51 | 78 | <tbody>
|
52 | 79 | <tr><th scope="row">1</th><td>Skript</td><td>skript</td>
|
53 | 80 | </tr>
|
54 | 81 | </tbody>
|
55 |
| -</table></div></div></div><div class="col-md-4 d-none d-lg-block"><div class="col-md-6 col-lg-12 my-3 p-3 bg-body rounded shadow-sm"><h6 class="border-bottom pb-2 mb-0">Return Type</h6><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 class="col-md-6 col-lg-12 my-3 p-3 bg-body rounded shadow-sm"><h6 class="border-bottom pb-2 mb-0">Modifiers</h6><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> |
| 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> |
56 | 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">
|
57 | 85 | <div class="col-lg-8 col-md-12 col-sm-12">
|
58 | 86 | <div class="row g-0 border rounded flex-md-row mb-4 shadow-sm h-md-250 position-relative">
|
59 |
| -<div class="col 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> |
60 |
| -<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="col-md-6 col-lg-12 my-3 p-3 bg-body rounded shadow-sm"><h6 class="border-bottom pb-2 mb-0">Return Type</h6><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 class="col-md-6 col-lg-12 my-3 p-3 bg-body rounded shadow-sm"><h6 class="border-bottom pb-2 mb-0">Modifiers</h6><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> |
| 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> |
61 | 94 | </div><div class="col col-lg-4 col-sm-12 col-md-12"></div></div></section><br />
|
62 | 95 | </main>
|
63 | 96 |
|
|
0 commit comments