hytopia 0.8.6-dev4 → 0.8.6-dev6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (56) hide show
  1. package/bun-server.mjs +164 -166
  2. package/docs/server.array3number.md +13 -0
  3. package/docs/server.array4number.md +13 -0
  4. package/docs/server.audiomanager.getallaudios.md +38 -1
  5. package/docs/server.audiomanager.getallentityattachedaudios.md +1 -1
  6. package/docs/server.audiomanager.md +1 -1
  7. package/docs/server.blocktype._constructor_.md +15 -1
  8. package/docs/server.blocktype.blocktyperegistry.md +13 -0
  9. package/docs/server.blocktype.md +22 -1
  10. package/docs/server.blocktyperegistry.getallblocktypes.md +38 -1
  11. package/docs/server.blocktyperegistry.md +1 -1
  12. package/docs/server.chunk._constructor_.md +15 -1
  13. package/docs/server.chunk.chunklattice.md +13 -0
  14. package/docs/server.chunk.md +22 -1
  15. package/docs/server.chunklattice.getallchunks.md +38 -1
  16. package/docs/server.chunklattice.md +22 -1
  17. package/docs/server.chunklattice.world.md +13 -0
  18. package/docs/server.chunklatticeevent.md +0 -14
  19. package/docs/server.chunklatticeeventpayloads.md +0 -19
  20. package/docs/server.entitymanager.getallentities.md +38 -1
  21. package/docs/server.entitymanager.md +1 -1
  22. package/docs/server.lightmanager.getalllights.md +38 -1
  23. package/docs/server.lightmanager.md +1 -1
  24. package/docs/server.md +25 -25
  25. package/docs/server.particleemitter.md +0 -14
  26. package/docs/server.particleemitterevent.md +0 -14
  27. package/docs/server.particleemittereventpayloads.md +0 -19
  28. package/docs/server.particleemittermanager.getallparticleemitters.md +38 -1
  29. package/docs/server.particleemittermanager.md +1 -1
  30. package/docs/server.rgbcolor.md +1 -1
  31. package/docs/server.sceneuimanager.getallsceneuis.md +38 -1
  32. package/docs/server.sceneuimanager.md +1 -1
  33. package/docs/server.tickallocator.getarray.md +72 -0
  34. package/docs/server.tickallocator.getarray3number.md +56 -0
  35. package/docs/server.tickallocator.getarray4number.md +56 -0
  36. package/docs/server.tickallocator.getobject.md +72 -0
  37. package/docs/server.tickallocator.getset.md +72 -0
  38. package/docs/server.tickallocator.map.md +72 -0
  39. package/docs/server.tickallocator.md +149 -0
  40. package/docs/server.tickallocator.reset.md +17 -0
  41. package/docs/server.world.md +21 -0
  42. package/docs/server.world.tickallocator.md +13 -0
  43. package/node-server.mjs +170 -172
  44. package/package.json +1 -1
  45. package/server.api.json +737 -670
  46. package/server.d.ts +145 -153
  47. package/docs/server.chunklatticeeventpayloads._chunk_lattice.add_chunk_.md +0 -16
  48. package/docs/server.particleemitter.burst.md +0 -54
  49. package/docs/server.particleemittereventpayloads._particle_emitter.burst_.md +0 -16
  50. package/docs/server.telemetry.getprocessstats.md +0 -56
  51. package/docs/server.telemetry.initializesentry.md +0 -74
  52. package/docs/server.telemetry.md +0 -126
  53. package/docs/server.telemetry.sentry.md +0 -23
  54. package/docs/server.telemetry.startspan.md +0 -91
  55. package/docs/server.telemetryspanoperation.md +0 -244
  56. package/docs/server.telemetryspanoptions.md +0 -18
@@ -1,74 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [server](./server.md) &gt; [Telemetry](./server.telemetry.md) &gt; [initializeSentry](./server.telemetry.initializesentry.md)
4
-
5
- ## Telemetry.initializeSentry() method
6
-
7
- Initializes Sentry telemetry with the provided DSN.
8
-
9
- **Signature:**
10
-
11
- ```typescript
12
- static initializeSentry(sentryDsn: string, tickTimeMsThreshold?: number): void;
13
- ```
14
-
15
- ## Parameters
16
-
17
- <table><thead><tr><th>
18
-
19
- Parameter
20
-
21
-
22
- </th><th>
23
-
24
- Type
25
-
26
-
27
- </th><th>
28
-
29
- Description
30
-
31
-
32
- </th></tr></thead>
33
- <tbody><tr><td>
34
-
35
- sentryDsn
36
-
37
-
38
- </td><td>
39
-
40
- string
41
-
42
-
43
- </td><td>
44
-
45
- The Sentry Data Source Name (DSN) for your project.
46
-
47
-
48
- </td></tr>
49
- <tr><td>
50
-
51
- tickTimeMsThreshold
52
-
53
-
54
- </td><td>
55
-
56
- number
57
-
58
-
59
- </td><td>
60
-
61
- _(Optional)_ The tick duration that must be exceeded to send a performance span to Sentry for a given tick. Defaults to 50ms.
62
-
63
-
64
- </td></tr>
65
- </tbody></table>
66
-
67
- **Returns:**
68
-
69
- void
70
-
71
- ## Remarks
72
-
73
- This method configures Sentry for error tracking and performance monitoring. It sets up filtering to only send performance spans that exceed the provided threshold duration, reducing noise and costs. The initialization includes game-specific tags and process statistics attachment.
74
-
@@ -1,126 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [server](./server.md) &gt; [Telemetry](./server.telemetry.md)
4
-
5
- ## Telemetry class
6
-
7
- Manages performance telemetry and error tracking through your Sentry.io account.
8
-
9
- **Signature:**
10
-
11
- ```typescript
12
- export default class Telemetry
13
- ```
14
-
15
- ## Remarks
16
-
17
- The Telemetry class provides low-overhead performance monitoring and error tracking through Sentry (https://sentry.io) integration and your provided Sentry DSN. It automatically tracks critical game loop operations like physics simulation, entity updates, network synchronization, and more. The system only sends telemetry data when errors or slow-tick performance issues are detected, minimizing bandwidth and storage costs.
18
-
19
- ## Example
20
-
21
-
22
- ```typescript
23
- // Initialize Sentry for production telemetry
24
- Telemetry.initializeSentry('MY_SENTRY_PROJECT_DSN');
25
-
26
- // Wrap performance-critical code in spans
27
- Telemetry.startSpan({
28
- operation: TelemetrySpanOperation.CUSTOM_OPERATION,
29
- attributes: { // any arbitrary attributes you want to attach to the span
30
- playerCount: world.playerManager.connectedPlayers.length,
31
- entityCount: world.entityManager.entityCount,
32
- },
33
- }, () => {
34
- // Your performance-critical code here
35
- performExpensiveOperation();
36
- });
37
-
38
- // Get current process statistics
39
- const stats = Telemetry.getProcessStats();
40
- console.log(`Heap usage: ${stats.jsHeapUsagePercent * 100}%`);
41
- ```
42
-
43
- ## Methods
44
-
45
- <table><thead><tr><th>
46
-
47
- Method
48
-
49
-
50
- </th><th>
51
-
52
- Modifiers
53
-
54
-
55
- </th><th>
56
-
57
- Description
58
-
59
-
60
- </th></tr></thead>
61
- <tbody><tr><td>
62
-
63
- [getProcessStats(asMeasurement)](./server.telemetry.getprocessstats.md)
64
-
65
-
66
- </td><td>
67
-
68
- `static`
69
-
70
-
71
- </td><td>
72
-
73
- Gets current process memory and performance statistics.
74
-
75
-
76
- </td></tr>
77
- <tr><td>
78
-
79
- [initializeSentry(sentryDsn, tickTimeMsThreshold)](./server.telemetry.initializesentry.md)
80
-
81
-
82
- </td><td>
83
-
84
- `static`
85
-
86
-
87
- </td><td>
88
-
89
- Initializes Sentry telemetry with the provided DSN.
90
-
91
-
92
- </td></tr>
93
- <tr><td>
94
-
95
- [sentry()](./server.telemetry.sentry.md)
96
-
97
-
98
- </td><td>
99
-
100
- `static`
101
-
102
-
103
- </td><td>
104
-
105
- Gets the Sentry SDK instance for advanced telemetry operations.
106
-
107
-
108
- </td></tr>
109
- <tr><td>
110
-
111
- [startSpan(options, callback)](./server.telemetry.startspan.md)
112
-
113
-
114
- </td><td>
115
-
116
- `static`
117
-
118
-
119
- </td><td>
120
-
121
- Executes a callback function within a performance monitoring span.
122
-
123
-
124
- </td></tr>
125
- </tbody></table>
126
-
@@ -1,23 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [server](./server.md) &gt; [Telemetry](./server.telemetry.md) &gt; [sentry](./server.telemetry.sentry.md)
4
-
5
- ## Telemetry.sentry() method
6
-
7
- Gets the Sentry SDK instance for advanced telemetry operations.
8
-
9
- **Signature:**
10
-
11
- ```typescript
12
- static sentry(): typeof Sentry;
13
- ```
14
- **Returns:**
15
-
16
- typeof Sentry
17
-
18
- The Sentry SDK instance.
19
-
20
- ## Remarks
21
-
22
- This method provides direct access to the Sentry SDK for operations not covered by the Telemetry wrapper, such as custom error reporting, user context setting, or advanced span manipulation.
23
-
@@ -1,91 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [server](./server.md) &gt; [Telemetry](./server.telemetry.md) &gt; [startSpan](./server.telemetry.startspan.md)
4
-
5
- ## Telemetry.startSpan() method
6
-
7
- Executes a callback function within a performance monitoring span.
8
-
9
- **Signature:**
10
-
11
- ```typescript
12
- static startSpan<T>(options: TelemetrySpanOptions, callback: (span?: Sentry.Span) => T): T;
13
- ```
14
-
15
- ## Parameters
16
-
17
- <table><thead><tr><th>
18
-
19
- Parameter
20
-
21
-
22
- </th><th>
23
-
24
- Type
25
-
26
-
27
- </th><th>
28
-
29
- Description
30
-
31
-
32
- </th></tr></thead>
33
- <tbody><tr><td>
34
-
35
- options
36
-
37
-
38
- </td><td>
39
-
40
- [TelemetrySpanOptions](./server.telemetryspanoptions.md)
41
-
42
-
43
- </td><td>
44
-
45
- Configuration for the telemetry span including operation type and attributes.
46
-
47
-
48
- </td></tr>
49
- <tr><td>
50
-
51
- callback
52
-
53
-
54
- </td><td>
55
-
56
- (span?: Sentry.Span) =&gt; T
57
-
58
-
59
- </td><td>
60
-
61
- The function to execute within the performance span.
62
-
63
-
64
- </td></tr>
65
- </tbody></table>
66
-
67
- **Returns:**
68
-
69
- T
70
-
71
- The return value of the callback function.
72
-
73
- ## Remarks
74
-
75
- This method provides zero-overhead performance monitoring in development environments. In production with Sentry enabled and `SENTRY_ENABLE_TRACING=true`<!-- -->, it creates performance spans for monitoring. The span data is only transmitted to Sentry when performance issues are detected.
76
-
77
- ## Example
78
-
79
-
80
- ```typescript
81
- const result = Telemetry.startSpan({
82
- operation: TelemetrySpanOperation.ENTITIES_TICK,
83
- attributes: {
84
- entityCount: entities.length,
85
- worldId: world.id,
86
- },
87
- }, () => {
88
- return processEntities(entities);
89
- });
90
- ```
91
-
@@ -1,244 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [server](./server.md) &gt; [TelemetrySpanOperation](./server.telemetryspanoperation.md)
4
-
5
- ## TelemetrySpanOperation enum
6
-
7
- Performance telemetry span operation types.
8
-
9
- **Signature:**
10
-
11
- ```typescript
12
- export declare enum TelemetrySpanOperation
13
- ```
14
-
15
- ## Enumeration Members
16
-
17
- <table><thead><tr><th>
18
-
19
- Member
20
-
21
-
22
- </th><th>
23
-
24
- Value
25
-
26
-
27
- </th><th>
28
-
29
- Description
30
-
31
-
32
- </th></tr></thead>
33
- <tbody><tr><td>
34
-
35
- BUILD\_PACKETS
36
-
37
-
38
- </td><td>
39
-
40
- `"build_packets"`
41
-
42
-
43
- </td><td>
44
-
45
-
46
- </td></tr>
47
- <tr><td>
48
-
49
- ENTITIES\_EMIT\_UPDATES
50
-
51
-
52
- </td><td>
53
-
54
- `"entities_emit_updates"`
55
-
56
-
57
- </td><td>
58
-
59
-
60
- </td></tr>
61
- <tr><td>
62
-
63
- ENTITIES\_TICK
64
-
65
-
66
- </td><td>
67
-
68
- `"entities_tick"`
69
-
70
-
71
- </td><td>
72
-
73
-
74
- </td></tr>
75
- <tr><td>
76
-
77
- NETWORK\_SYNCHRONIZE
78
-
79
-
80
- </td><td>
81
-
82
- `"network_synchronize"`
83
-
84
-
85
- </td><td>
86
-
87
-
88
- </td></tr>
89
- <tr><td>
90
-
91
- NETWORK\_SYNCHRONIZE\_CLEANUP
92
-
93
-
94
- </td><td>
95
-
96
- `"network_synchronize_cleanup"`
97
-
98
-
99
- </td><td>
100
-
101
-
102
- </td></tr>
103
- <tr><td>
104
-
105
- PHYSICS\_CLEANUP
106
-
107
-
108
- </td><td>
109
-
110
- `"physics_cleanup"`
111
-
112
-
113
- </td><td>
114
-
115
-
116
- </td></tr>
117
- <tr><td>
118
-
119
- PHYSICS\_STEP
120
-
121
-
122
- </td><td>
123
-
124
- `"physics_step"`
125
-
126
-
127
- </td><td>
128
-
129
-
130
- </td></tr>
131
- <tr><td>
132
-
133
- SEND\_ALL\_PACKETS
134
-
135
-
136
- </td><td>
137
-
138
- `"send_all_packets"`
139
-
140
-
141
- </td><td>
142
-
143
-
144
- </td></tr>
145
- <tr><td>
146
-
147
- SEND\_PACKETS
148
-
149
-
150
- </td><td>
151
-
152
- `"send_packets"`
153
-
154
-
155
- </td><td>
156
-
157
-
158
- </td></tr>
159
- <tr><td>
160
-
161
- SERIALIZE\_FREE\_BUFFERS
162
-
163
-
164
- </td><td>
165
-
166
- `"serialize_free_buffers"`
167
-
168
-
169
- </td><td>
170
-
171
-
172
- </td></tr>
173
- <tr><td>
174
-
175
- SERIALIZE\_PACKETS
176
-
177
-
178
- </td><td>
179
-
180
- `"serialize_packets"`
181
-
182
-
183
- </td><td>
184
-
185
-
186
- </td></tr>
187
- <tr><td>
188
-
189
- SERIALIZE\_PACKETS\_ENCODE
190
-
191
-
192
- </td><td>
193
-
194
- `"serialize_packets_encode"`
195
-
196
-
197
- </td><td>
198
-
199
-
200
- </td></tr>
201
- <tr><td>
202
-
203
- SIMULATION\_STEP
204
-
205
-
206
- </td><td>
207
-
208
- `"simulation_step"`
209
-
210
-
211
- </td><td>
212
-
213
-
214
- </td></tr>
215
- <tr><td>
216
-
217
- TICKER\_TICK
218
-
219
-
220
- </td><td>
221
-
222
- `"ticker_tick"`
223
-
224
-
225
- </td><td>
226
-
227
-
228
- </td></tr>
229
- <tr><td>
230
-
231
- WORLD\_TICK
232
-
233
-
234
- </td><td>
235
-
236
- `"world_tick"`
237
-
238
-
239
- </td><td>
240
-
241
-
242
- </td></tr>
243
- </tbody></table>
244
-
@@ -1,18 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [server](./server.md) &gt; [TelemetrySpanOptions](./server.telemetryspanoptions.md)
4
-
5
- ## TelemetrySpanOptions type
6
-
7
- Options for creating a telemetry span.
8
-
9
- **Signature:**
10
-
11
- ```typescript
12
- export type TelemetrySpanOptions = {
13
- operation: TelemetrySpanOperation | string;
14
- attributes?: Record<string, string | number>;
15
- };
16
- ```
17
- **References:** [TelemetrySpanOperation](./server.telemetryspanoperation.md)
18
-