hytopia 0.8.6-devtrace-1 → 0.8.6-devtrace-allocs

package/docs/server.telemetry.startspan.md

@@ -0,0 +1,91 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [Telemetry](./server.telemetry.md) &gt; [startSpan](./server.telemetry.startspan.md)
+
+## Telemetry.startSpan() method
+
+Executes a callback function within a performance monitoring span.
+
+**Signature:**
+
+```typescript
+static startSpan<T>(options: TelemetrySpanOptions, callback: (span?: Sentry.Span) => T): T;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+options
+
+
+</td><td>
+
+[TelemetrySpanOptions](./server.telemetryspanoptions.md)
+
+
+</td><td>
+
+Configuration for the telemetry span including operation type and attributes.
+
+
+</td></tr>
+<tr><td>
+
+callback
+
+
+</td><td>
+
+(span?: Sentry.Span) =&gt; T
+
+
+</td><td>
+
+The function to execute within the performance span.
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+T
+
+The return value of the callback function.
+
+## Remarks
+
+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.
+
+## Example
+
+
+```typescript
+const result = Telemetry.startSpan({
+  operation: TelemetrySpanOperation.ENTITIES_TICK,
+  attributes: {
+    entityCount: entities.length,
+    worldId: world.id,
+  },
+}, () => {
+  return processEntities(entities);
+});
+```
+

package/docs/server.telemetryspanoperation.md

@@ -0,0 +1,258 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [TelemetrySpanOperation](./server.telemetryspanoperation.md)
+
+## TelemetrySpanOperation enum
+
+Performance telemetry span operation types.
+
+**Signature:**
+
+```typescript
+export declare enum TelemetrySpanOperation 
+```
+
+## Enumeration Members
+
+<table><thead><tr><th>
+
+Member
+
+
+</th><th>
+
+Value
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+BUILD\_PACKETS
+
+
+</td><td>
+
+`"build_packets"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+ENTITIES\_EMIT\_UPDATES
+
+
+</td><td>
+
+`"entities_emit_updates"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+ENTITIES\_TICK
+
+
+</td><td>
+
+`"entities_tick"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+NETWORK\_SYNCHRONIZE
+
+
+</td><td>
+
+`"network_synchronize"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+NETWORK\_SYNCHRONIZE\_CLEANUP
+
+
+</td><td>
+
+`"network_synchronize_cleanup"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+PHYSICS\_CLEANUP
+
+
+</td><td>
+
+`"physics_cleanup"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+PHYSICS\_STEP
+
+
+</td><td>
+
+`"physics_step"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+RELEASE\_TICK\_ALLOCATION
+
+
+</td><td>
+
+`"release_tick_allocation"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+SEND\_ALL\_PACKETS
+
+
+</td><td>
+
+`"send_all_packets"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+SEND\_PACKETS
+
+
+</td><td>
+
+`"send_packets"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+SERIALIZE\_FREE\_BUFFERS
+
+
+</td><td>
+
+`"serialize_free_buffers"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+SERIALIZE\_PACKETS
+
+
+</td><td>
+
+`"serialize_packets"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+SERIALIZE\_PACKETS\_ENCODE
+
+
+</td><td>
+
+`"serialize_packets_encode"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+SIMULATION\_STEP
+
+
+</td><td>
+
+`"simulation_step"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+TICKER\_TICK
+
+
+</td><td>
+
+`"ticker_tick"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+WORLD\_TICK
+
+
+</td><td>
+
+`"world_tick"`
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+

package/docs/server.telemetryspanoptions.md

@@ -0,0 +1,18 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [TelemetrySpanOptions](./server.telemetryspanoptions.md)
+
+## TelemetrySpanOptions type
+
+Options for creating a telemetry span.
+
+**Signature:**
+
+```typescript
+export type TelemetrySpanOptions = {
+    operation: TelemetrySpanOperation | string;
+    attributes?: Record<string, string | number>;
+};
+```
+**References:** [TelemetrySpanOperation](./server.telemetryspanoperation.md)
+

package/docs/server.tickallocator.filter.md

@@ -0,0 +1,72 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [TickAllocator](./server.tickallocator.md) &gt; [filter](./server.tickallocator.filter.md)
+
+## TickAllocator.filter() method
+
+Filters an array using a callback function.
+
+**Signature:**
+
+```typescript
+filter<T>(array: T[], callback: (value: T, index: number, array: T[]) => boolean): T[];
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+array
+
+
+</td><td>
+
+T\[\]
+
+
+</td><td>
+
+The array to filter.
+
+
+</td></tr>
+<tr><td>
+
+callback
+
+
+</td><td>
+
+(value: T, index: number, array: T\[\]) =&gt; boolean
+
+
+</td><td>
+
+The callback function to filter the array.
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+T\[\]
+
+A new array with the filtered values.
+

package/docs/server.tickallocator.getarray.md

@@ -0,0 +1,72 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [TickAllocator](./server.tickallocator.md) &gt; [getArray](./server.tickallocator.getarray.md)
+
+## TickAllocator.getArray() method
+
+Gets a generic array from the pool. Array is reset to empty state and ready for use.
+
+**Signature:**
+
+```typescript
+getArray<T extends unknown[] = unknown[]>(copyFromA?: Iterable<unknown>, copyFromB?: Iterable<unknown>): T;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+copyFromA
+
+
+</td><td>
+
+Iterable&lt;unknown&gt;
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+<tr><td>
+
+copyFromB
+
+
+</td><td>
+
+Iterable&lt;unknown&gt;
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+T
+
+A reusable array.
+

package/docs/server.tickallocator.getarray3number.md

@@ -0,0 +1,56 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [TickAllocator](./server.tickallocator.md) &gt; [getArray3Number](./server.tickallocator.getarray3number.md)
+
+## TickAllocator.getArray3Number() method
+
+Gets a 3-element number array from the pool. Array is reset to \[0, 0, 0\] and ready for use.
+
+**Signature:**
+
+```typescript
+getArray3Number(copyFrom?: Array3Number | Set<number>): Array3Number;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+copyFrom
+
+
+</td><td>
+
+[Array3Number](./server.array3number.md) \| Set&lt;number&gt;
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+[Array3Number](./server.array3number.md)
+
+A reusable 3-element array.
+

package/docs/server.tickallocator.getarray4number.md

@@ -0,0 +1,56 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [TickAllocator](./server.tickallocator.md) &gt; [getArray4Number](./server.tickallocator.getarray4number.md)
+
+## TickAllocator.getArray4Number() method
+
+Gets a 4-element number array from the pool. Array is reset to \[0, 0, 0, 0\] and ready for use.
+
+**Signature:**
+
+```typescript
+getArray4Number(copyFrom?: Array4Number | Set<number>): Array4Number;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+copyFrom
+
+
+</td><td>
+
+[Array4Number](./server.array4number.md) \| Set&lt;number&gt;
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+[Array4Number](./server.array4number.md)
+
+A reusable 4-element array.
+

package/docs/server.tickallocator.getobject.md

@@ -0,0 +1,72 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [TickAllocator](./server.tickallocator.md) &gt; [getObject](./server.tickallocator.getobject.md)
+
+## TickAllocator.getObject() method
+
+Gets a plain object from the pool. Object is reset to empty state and ready for use.
+
+**Signature:**
+
+```typescript
+getObject<T extends Record<string, unknown> = Record<string, unknown>>(copyFromA?: T, copyFromB?: T): T;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+copyFromA
+
+
+</td><td>
+
+T
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+<tr><td>
+
+copyFromB
+
+
+</td><td>
+
+T
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+T
+
+A reusable plain object.
+