Skip to content

Commit 87097ab

Browse files
committed
Optimize networking by using pipes instead of tcp.
Add MeshDisplay (WIP, broken rn). Add documentation for the internals of events, execution, lifecycle, and serialization - Introduced `events_internal.md` detailing event subscription, dispatch flow, cancellation, and command registration. - Created `execution.md` covering call dispatch, threading model, timing, and batching mechanisms. - Added `lifecycle.md` explaining the startup, shutdown, and hot reload processes for scripts. - Documented `meshdisplay.md` for 3D triangle mesh rendering, including constructor parameters and methods. - Developed `serialization.md` outlining object handles, type serialization, and proxy class behavior.
1 parent ed2a711 commit 87097ab

Some content is hidden

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

81 files changed

+6679
-684
lines changed

docs/build.py

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,14 @@
9090
("chat", "Chat"),
9191
("reflect", "Reflect"),
9292
]),
93+
("Internals", [
94+
("bridge", "Bridge"),
95+
("events_internal", "Events"),
96+
("execution", "Execution"),
97+
("serialization", "Serialization"),
98+
("lifecycle", "Lifecycle"),
99+
("debugging", "Debugging")
100+
]),
93101
]
94102

95103
# ── Frontmatter parser ──────────────────────────────────────────────────────
@@ -254,10 +262,12 @@ def build_toc_sidebar(toc_tokens, current_slug):
254262
]
255263
for token in toc_tokens:
256264
toc_parts.append(f' <li><a href="#{token["id"]}">{token["name"]}</a></li>')
257-
toc_parts.extend(
258-
f' <li><a href="#{child["id"]}" style="padding-left:40px;font-size:.8rem">{child["name"]}</a></li>'
259-
for child in token.get("children", [])
260-
)
265+
children = token.get("children", [])
266+
if children:
267+
toc_parts.append(f' <li><ul class="toc-sub" data-parent="{token["id"]}">')
268+
for child in children:
269+
toc_parts.append(f' <li><a href="#{child["id"]}">{child["name"]}</a></li>')
270+
toc_parts.append(' </ul></li>')
261271
toc_parts.extend((' </ul>', '</div>'))
262272

263273
# Insert TOC right after the search box (first </div>)

docs/site/actionbardisplay.html

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -46,9 +46,11 @@
4646
<ul class="sidebar-links">
4747
<li><a href="#constructor">Constructor</a></li>
4848
<li><a href="#player-access">Player Access</a></li>
49-
<li><a href="#set-text" style="padding-left:40px;font-size:.8rem">Set text</a></li>
50-
<li><a href="#get-text" style="padding-left:40px;font-size:.8rem">Get text</a></li>
51-
<li><a href="#remove" style="padding-left:40px;font-size:.8rem">Remove</a></li>
49+
<li><ul class="toc-sub" data-parent="player-access">
50+
<li><a href="#set-text">Set text</a></li>
51+
<li><a href="#get-text">Get text</a></li>
52+
<li><a href="#remove">Remove</a></li>
53+
</ul></li>
5254
<li><a href="#example-status-bar">Example: Status bar</a></li>
5355
<li><a href="#example-ability-cooldown-indicator">Example: Ability cooldown indicator</a></li>
5456
</ul>
@@ -137,6 +139,17 @@
137139
<li><a href="chat.html">Chat</a></li>
138140
<li><a href="reflect.html">Reflect</a></li>
139141
</ul>
142+
</div>
143+
<div class="sidebar-section">
144+
<div class="sidebar-heading collapsed" data-section="internals">Internals</div>
145+
<ul class="sidebar-links">
146+
<li><a href="bridge.html">Bridge</a></li>
147+
<li><a href="events_internal.html">Events</a></li>
148+
<li><a href="execution.html">Execution</a></li>
149+
<li><a href="serialization.html">Serialization</a></li>
150+
<li><a href="lifecycle.html">Lifecycle</a></li>
151+
<li><a href="debugging.html">Debugging</a></li>
152+
</ul>
140153
</div>
141154
</aside>
142155
<div class="sidebar-overlay"></div>

docs/site/advancement.html

Lines changed: 22 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -45,13 +45,19 @@
4545
<div class="sidebar-heading" data-section="on-this-page">On This Page</div>
4646
<ul class="sidebar-links">
4747
<li><a href="#class-methods">Class Methods</a></li>
48-
<li><a href="#grant" style="padding-left:40px;font-size:.8rem">grant</a></li>
49-
<li><a href="#revoke" style="padding-left:40px;font-size:.8rem">revoke</a></li>
48+
<li><ul class="toc-sub" data-parent="class-methods">
49+
<li><a href="#grant">grant</a></li>
50+
<li><a href="#revoke">revoke</a></li>
51+
</ul></li>
5052
<li><a href="#attributes">Attributes</a></li>
51-
<li><a href="#key" style="padding-left:40px;font-size:.8rem">key</a></li>
53+
<li><ul class="toc-sub" data-parent="attributes">
54+
<li><a href="#key">key</a></li>
55+
</ul></li>
5256
<li><a href="#advancementprogress">AdvancementProgress</a></li>
53-
<li><a href="#attributes_1" style="padding-left:40px;font-size:.8rem">Attributes</a></li>
54-
<li><a href="#methods" style="padding-left:40px;font-size:.8rem">Methods</a></li>
57+
<li><ul class="toc-sub" data-parent="advancementprogress">
58+
<li><a href="#attributes_1">Attributes</a></li>
59+
<li><a href="#methods">Methods</a></li>
60+
</ul></li>
5561
<li><a href="#common-advancement-keys">Common Advancement Keys</a></li>
5662
</ul>
5763
</div>
@@ -139,6 +145,17 @@
139145
<li><a href="chat.html">Chat</a></li>
140146
<li><a href="reflect.html">Reflect</a></li>
141147
</ul>
148+
</div>
149+
<div class="sidebar-section">
150+
<div class="sidebar-heading collapsed" data-section="internals">Internals</div>
151+
<ul class="sidebar-links">
152+
<li><a href="bridge.html">Bridge</a></li>
153+
<li><a href="events_internal.html">Events</a></li>
154+
<li><a href="execution.html">Execution</a></li>
155+
<li><a href="serialization.html">Serialization</a></li>
156+
<li><a href="lifecycle.html">Lifecycle</a></li>
157+
<li><a href="debugging.html">Debugging</a></li>
158+
</ul>
142159
</div>
143160
</aside>
144161
<div class="sidebar-overlay"></div>

docs/site/attribute.html

Lines changed: 22 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -45,13 +45,19 @@
4545
<div class="sidebar-heading" data-section="on-this-page">On This Page</div>
4646
<ul class="sidebar-links">
4747
<li><a href="#class-methods">Class Methods</a></li>
48-
<li><a href="#apply" style="padding-left:40px;font-size:.8rem">apply</a></li>
48+
<li><ul class="toc-sub" data-parent="class-methods">
49+
<li><a href="#apply">apply</a></li>
50+
</ul></li>
4951
<li><a href="#attributes">Attributes</a></li>
50-
<li><a href="#attribute_type" style="padding-left:40px;font-size:.8rem">attribute_type</a></li>
51-
<li><a href="#value" style="padding-left:40px;font-size:.8rem">value</a></li>
52-
<li><a href="#base_value" style="padding-left:40px;font-size:.8rem">base_value</a></li>
52+
<li><ul class="toc-sub" data-parent="attributes">
53+
<li><a href="#attribute_type">attribute_type</a></li>
54+
<li><a href="#value">value</a></li>
55+
<li><a href="#base_value">base_value</a></li>
56+
</ul></li>
5357
<li><a href="#methods">Methods</a></li>
54-
<li><a href="#set_base_value" style="padding-left:40px;font-size:.8rem">set_base_value</a></li>
58+
<li><ul class="toc-sub" data-parent="methods">
59+
<li><a href="#set_base_value">set_base_value</a></li>
60+
</ul></li>
5561
<li><a href="#common-attribute-types">Common Attribute Types</a></li>
5662
</ul>
5763
</div>
@@ -139,6 +145,17 @@
139145
<li><a href="chat.html">Chat</a></li>
140146
<li><a href="reflect.html">Reflect</a></li>
141147
</ul>
148+
</div>
149+
<div class="sidebar-section">
150+
<div class="sidebar-heading collapsed" data-section="internals">Internals</div>
151+
<ul class="sidebar-links">
152+
<li><a href="bridge.html">Bridge</a></li>
153+
<li><a href="events_internal.html">Events</a></li>
154+
<li><a href="execution.html">Execution</a></li>
155+
<li><a href="serialization.html">Serialization</a></li>
156+
<li><a href="lifecycle.html">Lifecycle</a></li>
157+
<li><a href="debugging.html">Debugging</a></li>
158+
</ul>
142159
</div>
143160
</aside>
144161
<div class="sidebar-overlay"></div>

docs/site/block.html

Lines changed: 32 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -46,23 +46,29 @@
4646
<ul class="sidebar-links">
4747
<li><a href="#constructor">Constructor</a></li>
4848
<li><a href="#class-methods">Class Methods</a></li>
49-
<li><a href="#create" style="padding-left:40px;font-size:.8rem">create</a></li>
49+
<li><ul class="toc-sub" data-parent="class-methods">
50+
<li><a href="#create">create</a></li>
51+
</ul></li>
5052
<li><a href="#attributes">Attributes</a></li>
51-
<li><a href="#x" style="padding-left:40px;font-size:.8rem">x</a></li>
52-
<li><a href="#y" style="padding-left:40px;font-size:.8rem">y</a></li>
53-
<li><a href="#z" style="padding-left:40px;font-size:.8rem">z</a></li>
54-
<li><a href="#type" style="padding-left:40px;font-size:.8rem">type</a></li>
55-
<li><a href="#location" style="padding-left:40px;font-size:.8rem">location</a></li>
56-
<li><a href="#world" style="padding-left:40px;font-size:.8rem">world</a></li>
57-
<li><a href="#is_solid" style="padding-left:40px;font-size:.8rem">is_solid</a></li>
58-
<li><a href="#data" style="padding-left:40px;font-size:.8rem">data</a></li>
59-
<li><a href="#light_level" style="padding-left:40px;font-size:.8rem">light_level</a></li>
60-
<li><a href="#biome" style="padding-left:40px;font-size:.8rem">biome</a></li>
53+
<li><ul class="toc-sub" data-parent="attributes">
54+
<li><a href="#x">x</a></li>
55+
<li><a href="#y">y</a></li>
56+
<li><a href="#z">z</a></li>
57+
<li><a href="#type">type</a></li>
58+
<li><a href="#location">location</a></li>
59+
<li><a href="#world">world</a></li>
60+
<li><a href="#is_solid">is_solid</a></li>
61+
<li><a href="#data">data</a></li>
62+
<li><a href="#light_level">light_level</a></li>
63+
<li><a href="#biome">biome</a></li>
64+
</ul></li>
6165
<li><a href="#methods">Methods</a></li>
62-
<li><a href="#break_naturally" style="padding-left:40px;font-size:.8rem">break_naturally</a></li>
63-
<li><a href="#set_type" style="padding-left:40px;font-size:.8rem">set_type</a></li>
64-
<li><a href="#set_data" style="padding-left:40px;font-size:.8rem">set_data</a></li>
65-
<li><a href="#set_biome" style="padding-left:40px;font-size:.8rem">set_biome</a></li>
66+
<li><ul class="toc-sub" data-parent="methods">
67+
<li><a href="#break_naturally">break_naturally</a></li>
68+
<li><a href="#set_type">set_type</a></li>
69+
<li><a href="#set_data">set_data</a></li>
70+
<li><a href="#set_biome">set_biome</a></li>
71+
</ul></li>
6672
</ul>
6773
</div>
6874

@@ -149,6 +155,17 @@
149155
<li><a href="chat.html">Chat</a></li>
150156
<li><a href="reflect.html">Reflect</a></li>
151157
</ul>
158+
</div>
159+
<div class="sidebar-section">
160+
<div class="sidebar-heading collapsed" data-section="internals">Internals</div>
161+
<ul class="sidebar-links">
162+
<li><a href="bridge.html">Bridge</a></li>
163+
<li><a href="events_internal.html">Events</a></li>
164+
<li><a href="execution.html">Execution</a></li>
165+
<li><a href="serialization.html">Serialization</a></li>
166+
<li><a href="lifecycle.html">Lifecycle</a></li>
167+
<li><a href="debugging.html">Debugging</a></li>
168+
</ul>
152169
</div>
153170
</aside>
154171
<div class="sidebar-overlay"></div>

docs/site/blockdisplay.html

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -46,10 +46,14 @@
4646
<ul class="sidebar-links">
4747
<li><a href="#constructor">Constructor</a></li>
4848
<li><a href="#attributes">Attributes</a></li>
49-
<li><a href="#billboard" style="padding-left:40px;font-size:.8rem">billboard</a></li>
49+
<li><ul class="toc-sub" data-parent="attributes">
50+
<li><a href="#billboard">billboard</a></li>
51+
</ul></li>
5052
<li><a href="#methods">Methods</a></li>
51-
<li><a href="#teleport" style="padding-left:40px;font-size:.8rem">teleport</a></li>
52-
<li><a href="#remove" style="padding-left:40px;font-size:.8rem">remove</a></li>
53+
<li><ul class="toc-sub" data-parent="methods">
54+
<li><a href="#teleport">teleport</a></li>
55+
<li><a href="#remove">remove</a></li>
56+
</ul></li>
5357
<li><a href="#example-floating-block-marker">Example: Floating block marker</a></li>
5458
</ul>
5559
</div>
@@ -137,6 +141,17 @@
137141
<li><a href="chat.html">Chat</a></li>
138142
<li><a href="reflect.html">Reflect</a></li>
139143
</ul>
144+
</div>
145+
<div class="sidebar-section">
146+
<div class="sidebar-heading collapsed" data-section="internals">Internals</div>
147+
<ul class="sidebar-links">
148+
<li><a href="bridge.html">Bridge</a></li>
149+
<li><a href="events_internal.html">Events</a></li>
150+
<li><a href="execution.html">Execution</a></li>
151+
<li><a href="serialization.html">Serialization</a></li>
152+
<li><a href="lifecycle.html">Lifecycle</a></li>
153+
<li><a href="debugging.html">Debugging</a></li>
154+
</ul>
140155
</div>
141156
</aside>
142157
<div class="sidebar-overlay"></div>

docs/site/bossbar.html

Lines changed: 30 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -45,21 +45,27 @@
4545
<div class="sidebar-heading" data-section="on-this-page">On This Page</div>
4646
<ul class="sidebar-links">
4747
<li><a href="#class-methods">Class Methods</a></li>
48-
<li><a href="#create" style="padding-left:40px;font-size:.8rem">create</a></li>
48+
<li><ul class="toc-sub" data-parent="class-methods">
49+
<li><a href="#create">create</a></li>
50+
</ul></li>
4951
<li><a href="#attributes">Attributes</a></li>
50-
<li><a href="#title" style="padding-left:40px;font-size:.8rem">title</a></li>
51-
<li><a href="#progress" style="padding-left:40px;font-size:.8rem">progress</a></li>
52-
<li><a href="#color" style="padding-left:40px;font-size:.8rem">color</a></li>
53-
<li><a href="#style" style="padding-left:40px;font-size:.8rem">style</a></li>
54-
<li><a href="#visible" style="padding-left:40px;font-size:.8rem">visible</a></li>
52+
<li><ul class="toc-sub" data-parent="attributes">
53+
<li><a href="#title">title</a></li>
54+
<li><a href="#progress">progress</a></li>
55+
<li><a href="#color">color</a></li>
56+
<li><a href="#style">style</a></li>
57+
<li><a href="#visible">visible</a></li>
58+
</ul></li>
5559
<li><a href="#methods">Methods</a></li>
56-
<li><a href="#add_player" style="padding-left:40px;font-size:.8rem">add_player</a></li>
57-
<li><a href="#remove_player" style="padding-left:40px;font-size:.8rem">remove_player</a></li>
58-
<li><a href="#set_title" style="padding-left:40px;font-size:.8rem">set_title</a></li>
59-
<li><a href="#set_progress" style="padding-left:40px;font-size:.8rem">set_progress</a></li>
60-
<li><a href="#set_color" style="padding-left:40px;font-size:.8rem">set_color</a></li>
61-
<li><a href="#set_style" style="padding-left:40px;font-size:.8rem">set_style</a></li>
62-
<li><a href="#set_visible" style="padding-left:40px;font-size:.8rem">set_visible</a></li>
60+
<li><ul class="toc-sub" data-parent="methods">
61+
<li><a href="#add_player">add_player</a></li>
62+
<li><a href="#remove_player">remove_player</a></li>
63+
<li><a href="#set_title">set_title</a></li>
64+
<li><a href="#set_progress">set_progress</a></li>
65+
<li><a href="#set_color">set_color</a></li>
66+
<li><a href="#set_style">set_style</a></li>
67+
<li><a href="#set_visible">set_visible</a></li>
68+
</ul></li>
6369
<li><a href="#barcolor-options">BarColor Options</a></li>
6470
<li><a href="#barstyle-options">BarStyle Options</a></li>
6571
<li><a href="#example-health-bar-for-a-boss-fight">Example: Health bar for a boss fight</a></li>
@@ -149,6 +155,17 @@
149155
<li><a href="chat.html">Chat</a></li>
150156
<li><a href="reflect.html">Reflect</a></li>
151157
</ul>
158+
</div>
159+
<div class="sidebar-section">
160+
<div class="sidebar-heading collapsed" data-section="internals">Internals</div>
161+
<ul class="sidebar-links">
162+
<li><a href="bridge.html">Bridge</a></li>
163+
<li><a href="events_internal.html">Events</a></li>
164+
<li><a href="execution.html">Execution</a></li>
165+
<li><a href="serialization.html">Serialization</a></li>
166+
<li><a href="lifecycle.html">Lifecycle</a></li>
167+
<li><a href="debugging.html">Debugging</a></li>
168+
</ul>
152169
</div>
153170
</aside>
154171
<div class="sidebar-overlay"></div>

docs/site/bossbardisplay.html

Lines changed: 25 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -46,17 +46,21 @@
4646
<ul class="sidebar-links">
4747
<li><a href="#constructor">Constructor</a></li>
4848
<li><a href="#attributes">Attributes</a></li>
49-
<li><a href="#text" style="padding-left:40px;font-size:.8rem">text</a></li>
50-
<li><a href="#color" style="padding-left:40px;font-size:.8rem">color</a></li>
51-
<li><a href="#style" style="padding-left:40px;font-size:.8rem">style</a></li>
52-
<li><a href="#value" style="padding-left:40px;font-size:.8rem">value</a></li>
53-
<li><a href="#max" style="padding-left:40px;font-size:.8rem">max</a></li>
54-
<li><a href="#progress" style="padding-left:40px;font-size:.8rem">progress</a></li>
55-
<li><a href="#visible" style="padding-left:40px;font-size:.8rem">visible</a></li>
49+
<li><ul class="toc-sub" data-parent="attributes">
50+
<li><a href="#text">text</a></li>
51+
<li><a href="#color">color</a></li>
52+
<li><a href="#style">style</a></li>
53+
<li><a href="#value">value</a></li>
54+
<li><a href="#max">max</a></li>
55+
<li><a href="#progress">progress</a></li>
56+
<li><a href="#visible">visible</a></li>
57+
</ul></li>
5658
<li><a href="#methods">Methods</a></li>
57-
<li><a href="#show" style="padding-left:40px;font-size:.8rem">show</a></li>
58-
<li><a href="#hide" style="padding-left:40px;font-size:.8rem">hide</a></li>
59-
<li><a href="#link_cooldown" style="padding-left:40px;font-size:.8rem">link_cooldown</a></li>
59+
<li><ul class="toc-sub" data-parent="methods">
60+
<li><a href="#show">show</a></li>
61+
<li><a href="#hide">hide</a></li>
62+
<li><a href="#link_cooldown">link_cooldown</a></li>
63+
</ul></li>
6064
<li><a href="#example-ability-cooldown-bar">Example: Ability cooldown bar</a></li>
6165
<li><a href="#example-multiple-ability-bars">Example: Multiple ability bars</a></li>
6266
</ul>
@@ -145,6 +149,17 @@
145149
<li><a href="chat.html">Chat</a></li>
146150
<li><a href="reflect.html">Reflect</a></li>
147151
</ul>
152+
</div>
153+
<div class="sidebar-section">
154+
<div class="sidebar-heading collapsed" data-section="internals">Internals</div>
155+
<ul class="sidebar-links">
156+
<li><a href="bridge.html">Bridge</a></li>
157+
<li><a href="events_internal.html">Events</a></li>
158+
<li><a href="execution.html">Execution</a></li>
159+
<li><a href="serialization.html">Serialization</a></li>
160+
<li><a href="lifecycle.html">Lifecycle</a></li>
161+
<li><a href="debugging.html">Debugging</a></li>
162+
</ul>
148163
</div>
149164
</aside>
150165
<div class="sidebar-overlay"></div>

0 commit comments

Comments
 (0)