hytopia 0.8.6-dev3 → 0.8.6-dev5

package/server.d.ts

@@ -5,12 +5,11 @@ import http from 'http';
 import type { IncomingMessage } from 'http';
 import type { InputSchema } from '@hytopia.com/server-protocol';
 import type { LobbyMembershipDto } from '@hytopia.com/creative-lib/dist/impl/getSession';
+import mediasoup from 'mediasoup';
 import protocol from '@hytopia.com/server-protocol';
 import RAPIER from '@dimforge/rapier3d-simd-compat';
 import { SdpMatrix3 } from '@dimforge/rapier3d-simd-compat';
-import * as Sentry from '@sentry/node';
 import type { Socket } from 'net';
-import type { types } from 'mediasoup';
 import { WebSocket as WebSocket_2 } from 'ws';
 
 /**
@@ -280,8 +279,6 @@ export declare class AudioManager {
      * Retrieves all loaded audio instances attached to a specific entity.
      *
      * @param entity - The entity to get attached audio instances for.
-     * the allocated array at the end of the current tick. false by default.
-
      * @returns An array of audio instances.
      */
     getAllEntityAttachedAudios(entity: Entity): Audio[];
@@ -998,18 +995,12 @@ export declare class ChunkLattice extends EventRouter {
 
 /** Event types a ChunkLattice instance can emit. See {@link ChunkLatticeEventPayloads} for the payloads. @public */
 export declare enum ChunkLatticeEvent {
-    ADD_CHUNK = "CHUNK_LATTICE.ADD_CHUNK",
     REMOVE_CHUNK = "CHUNK_LATTICE.REMOVE_CHUNK",
     SET_BLOCK = "CHUNK_LATTICE.SET_BLOCK"
 }
 
 /** Event payloads for ChunkLattice emitted events. @public */
 export declare interface ChunkLatticeEventPayloads {
-    /** Emitted when a chunk is added to the lattice. */
-    [ChunkLatticeEvent.ADD_CHUNK]: {
-        chunkLattice: ChunkLattice;
-        chunk: Chunk;
-    };
     /** Emitted when a chunk is removed from the lattice. */
     [ChunkLatticeEvent.REMOVE_CHUNK]: {
         chunkLattice: ChunkLattice;
@@ -3870,12 +3861,6 @@ export declare class ParticleEmitter extends EventRouter implements protocol.Ser
      * @param velocityVariance - The velocity variance of an emitted particle.
      */
     setVelocityVariance(velocityVariance: Vector3Like): void;
-    /**
-     * Creates a burst of particles, regardless of pause state.
-     *
-     * @param count - The number of particles to burst.
-     */
-    burst(count: number): void;
     /**
      * Despawns the ParticleEmitter from the world.
      */
@@ -3899,7 +3884,6 @@ export declare class ParticleEmitter extends EventRouter implements protocol.Ser
 
 /** Event types a ParticleEmitter instance can emit. See {@link ParticleEmitterEventPayloads} @public */
 export declare enum ParticleEmitterEvent {
-    BURST = "PARTICLE_EMITTER.BURST",
     DESPAWN = "PARTICLE_EMITTER.DESPAWN",
     SET_ALPHA_TEST = "PARTICLE_EMITTER.SET_ALPHA_TEST",
     SET_ATTACHED_TO_ENTITY = "PARTICLE_EMITTER.SET_ATTACHED_TO_ENTITY",
@@ -3935,11 +3919,6 @@ export declare enum ParticleEmitterEvent {
 
 /** Event payloads for ParticleEmitter emitted events. @public */
 export declare interface ParticleEmitterEventPayloads {
-    /** Emitted when a ParticleEmitter bursts the specified number of particles. */
-    [ParticleEmitterEvent.BURST]: {
-        particleEmitter: ParticleEmitter;
-        count: number;
-    };
     /** Emitted when a ParticleEmitter is despawned. */
     [ParticleEmitterEvent.DESPAWN]: {
         particleEmitter: ParticleEmitter;
@@ -5213,7 +5192,7 @@ export declare type RaycastOptions = {
     solidMode?: boolean;
 } & FilterOptions;
 
-/** A RGB color. r, g and b expect a value between 0 and 255. @public */
+/** A RGB color. @public */
 export declare interface RgbColor {
     r: number;
     g: number;
@@ -6092,130 +6071,6 @@ export declare function startServer(init: ((() => void) | ((world: World) => voi
 /** The input keys that are included in the PlayerInput. @public */
 export declare const SUPPORTED_INPUT_KEYS: readonly ["w", "a", "s", "d", "sp", "sh", "tb", "ml", "mr", "q", "e", "r", "f", "z", "x", "c", "v", "u", "i", "o", "j", "k", "l", "n", "m", "1", "2", "3", "4", "5", "6", "7", "8", "9", "0"];
 
-/**
- * Manages performance telemetry and error tracking through your Sentry.io account.
- *
- * @remarks
- * 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.
- *
- * @example
- * ```typescript
- * // Initialize Sentry for production telemetry
- * Telemetry.initializeSentry('MY_SENTRY_PROJECT_DSN');
- *
- * // Wrap performance-critical code in spans
- * Telemetry.startSpan({
- *   operation: TelemetrySpanOperation.CUSTOM_OPERATION,
- *   attributes: { // any arbitrary attributes you want to attach to the span
- *     playerCount: world.playerManager.connectedPlayers.length,
- *     entityCount: world.entityManager.entityCount,
- *   },
- * }, () => {
- *   // Your performance-critical code here
- *   performExpensiveOperation();
- * });
- *
- * // Get current process statistics
- * const stats = Telemetry.getProcessStats();
- * console.log(`Heap usage: ${stats.jsHeapUsagePercent * 100}%`);
- * ```
- *
- * @public
- */
-export declare class Telemetry {
-    /**
-     * Gets current process memory and performance statistics.
-     *
-     * @param asMeasurement - Whether to return data in Sentry measurement format with units.
-     * @returns Process statistics including heap usage, RSS memory, and capacity metrics.
-     */
-    static getProcessStats(asMeasurement?: boolean): Record<string, any>;
-    /**
-     * Initializes Sentry telemetry with the provided DSN.
-     *
-     * @remarks
-     * 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.
-     *
-     * @param sentryDsn - The Sentry Data Source Name (DSN) for your project.
-     * @param tickTimeMsThreshold - The tick duration that must be exceeded to
-     * send a performance span to Sentry for a given tick. Defaults to 50ms.
-     */
-    static initializeSentry(sentryDsn: string, tickTimeMsThreshold?: number): void;
-    /**
-     * Executes a callback function within a performance monitoring span.
-     *
-     * @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.
-     *
-     * @param options - Configuration for the telemetry span including operation type and attributes.
-     * @param callback - The function to execute within the performance span.
-     * @returns The return value of the callback function.
-     *
-     * @example
-     * ```typescript
-     * const result = Telemetry.startSpan({
-     *   operation: TelemetrySpanOperation.ENTITIES_TICK,
-     *   attributes: {
-     *     entityCount: entities.length,
-     *     worldId: world.id,
-     *   },
-     * }, () => {
-     *   return processEntities(entities);
-     * });
-     * ```
-     */
-    static startSpan<T>(options: TelemetrySpanOptions, callback: (span?: Sentry.Span) => T): T;
-    /**
-     * Gets the Sentry SDK instance for advanced telemetry operations.
-     *
-     * @remarks
-     * 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.
-     *
-     * @returns The Sentry SDK instance.
-     */
-    static sentry(): typeof Sentry;
-}
-
-/** Performance telemetry span operation types. @public */
-export declare enum TelemetrySpanOperation {
-    BUILD_PACKETS = "build_packets",
-    ENTITIES_EMIT_UPDATES = "entities_emit_updates",
-    ENTITIES_TICK = "entities_tick",
-    NETWORK_SYNCHRONIZE = "network_synchronize",
-    NETWORK_SYNCHRONIZE_CLEANUP = "network_synchronize_cleanup",
-    PHYSICS_CLEANUP = "physics_cleanup",
-    PHYSICS_STEP = "physics_step",
-    SEND_ALL_PACKETS = "send_all_packets",
-    SEND_PACKETS = "send_packets",
-    SERIALIZE_FREE_BUFFERS = "serialize_free_buffers",
-    SERIALIZE_PACKETS = "serialize_packets",
-    SERIALIZE_PACKETS_ENCODE = "serialize_packets_encode",
-    SIMULATION_STEP = "simulation_step",
-    TICKER_TICK = "ticker_tick",
-    WORLD_TICK = "world_tick"
-}
-
-/** Options for creating a telemetry span. @public */
-export declare type TelemetrySpanOptions = {
-    /** The operation being measured. */
-    operation: TelemetrySpanOperation | string;
-    /** Additional attributes to attach to the span for context. */
-    attributes?: Record<string, string | number>;
-};
-
 /** The options for a trimesh collider. @public */
 export declare interface TrimeshColliderOptions extends BaseColliderOptions {
     shape: ColliderShape.TRIMESH;

package/docs/server.chunklatticeeventpayloads._chunk_lattice.add_chunk_.md

@@ -1,16 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [server](./server.md) &gt; [ChunkLatticeEventPayloads](./server.chunklatticeeventpayloads.md) &gt; ["CHUNK\_LATTICE.ADD\_CHUNK"](./server.chunklatticeeventpayloads._chunk_lattice.add_chunk_.md)
-
-## ChunkLatticeEventPayloads."CHUNK\_LATTICE.ADD\_CHUNK" property
-
-Emitted when a chunk is added to the lattice.
-
-**Signature:**
-
-```typescript
-[ChunkLatticeEvent.ADD_CHUNK]: {
-        chunkLattice: ChunkLattice;
-        chunk: Chunk;
-    };
-```

package/docs/server.particleemitter.burst.md

@@ -1,54 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [server](./server.md) &gt; [ParticleEmitter](./server.particleemitter.md) &gt; [burst](./server.particleemitter.burst.md)
-
-## ParticleEmitter.burst() method
-
-Creates a burst of particles, regardless of pause state.
-
-**Signature:**
-
-```typescript
-burst(count: number): void;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-count
-
-
-</td><td>
-
-number
-
-
-</td><td>
-
-The number of particles to burst.
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-void
-

package/docs/server.particleemittereventpayloads._particle_emitter.burst_.md

@@ -1,16 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [server](./server.md) &gt; [ParticleEmitterEventPayloads](./server.particleemittereventpayloads.md) &gt; ["PARTICLE\_EMITTER.BURST"](./server.particleemittereventpayloads._particle_emitter.burst_.md)
-
-## ParticleEmitterEventPayloads."PARTICLE\_EMITTER.BURST" property
-
-Emitted when a ParticleEmitter bursts the specified number of particles.
-
-**Signature:**
-
-```typescript
-[ParticleEmitterEvent.BURST]: {
-        particleEmitter: ParticleEmitter;
-        count: number;
-    };
-```

package/docs/server.telemetry.getprocessstats.md

@@ -1,56 +0,0 @@
-<!-- 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; [getProcessStats](./server.telemetry.getprocessstats.md)
-
-## Telemetry.getProcessStats() method
-
-Gets current process memory and performance statistics.
-
-**Signature:**
-
-```typescript
-static getProcessStats(asMeasurement?: boolean): Record<string, any>;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-asMeasurement
-
-
-</td><td>
-
-boolean
-
-
-</td><td>
-
-_(Optional)_ Whether to return data in Sentry measurement format with units.
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-Record&lt;string, any&gt;
-
-Process statistics including heap usage, RSS memory, and capacity metrics.
-

package/docs/server.telemetry.initializesentry.md

@@ -1,74 +0,0 @@
-<!-- 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; [initializeSentry](./server.telemetry.initializesentry.md)
-
-## Telemetry.initializeSentry() method
-
-Initializes Sentry telemetry with the provided DSN.
-
-**Signature:**
-
-```typescript
-static initializeSentry(sentryDsn: string, tickTimeMsThreshold?: number): void;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-sentryDsn
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-The Sentry Data Source Name (DSN) for your project.
-
-
-</td></tr>
-<tr><td>
-
-tickTimeMsThreshold
-
-
-</td><td>
-
-number
-
-
-</td><td>
-
-_(Optional)_ The tick duration that must be exceeded to send a performance span to Sentry for a given tick. Defaults to 50ms.
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-void
-
-## Remarks
-
-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.
-

package/docs/server.telemetry.md

@@ -1,126 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [server](./server.md) &gt; [Telemetry](./server.telemetry.md)
-
-## Telemetry class
-
-Manages performance telemetry and error tracking through your Sentry.io account.
-
-**Signature:**
-
-```typescript
-export default class Telemetry 
-```
-
-## Remarks
-
-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.
-
-## Example
-
-
-```typescript
-// Initialize Sentry for production telemetry
-Telemetry.initializeSentry('MY_SENTRY_PROJECT_DSN');
-
-// Wrap performance-critical code in spans
-Telemetry.startSpan({
-  operation: TelemetrySpanOperation.CUSTOM_OPERATION,
-  attributes: { // any arbitrary attributes you want to attach to the span
-    playerCount: world.playerManager.connectedPlayers.length,
-    entityCount: world.entityManager.entityCount,
-  },
-}, () => {
-  // Your performance-critical code here
-  performExpensiveOperation();
-});
-
-// Get current process statistics
-const stats = Telemetry.getProcessStats();
-console.log(`Heap usage: ${stats.jsHeapUsagePercent * 100}%`);
-```
-
-## Methods
-
-<table><thead><tr><th>
-
-Method
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[getProcessStats(asMeasurement)](./server.telemetry.getprocessstats.md)
-
-
-</td><td>
-
-`static`
-
-
-</td><td>
-
-Gets current process memory and performance statistics.
-
-
-</td></tr>
-<tr><td>
-
-[initializeSentry(sentryDsn, tickTimeMsThreshold)](./server.telemetry.initializesentry.md)
-
-
-</td><td>
-
-`static`
-
-
-</td><td>
-
-Initializes Sentry telemetry with the provided DSN.
-
-
-</td></tr>
-<tr><td>
-
-[sentry()](./server.telemetry.sentry.md)
-
-
-</td><td>
-
-`static`
-
-
-</td><td>
-
-Gets the Sentry SDK instance for advanced telemetry operations.
-
-
-</td></tr>
-<tr><td>
-
-[startSpan(options, callback)](./server.telemetry.startspan.md)
-
-
-</td><td>
-
-`static`
-
-
-</td><td>
-
-Executes a callback function within a performance monitoring span.
-
-
-</td></tr>
-</tbody></table>
-

package/docs/server.telemetry.sentry.md

@@ -1,23 +0,0 @@
-<!-- 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; [sentry](./server.telemetry.sentry.md)
-
-## Telemetry.sentry() method
-
-Gets the Sentry SDK instance for advanced telemetry operations.
-
-**Signature:**
-
-```typescript
-static sentry(): typeof Sentry;
-```
-**Returns:**
-
-typeof Sentry
-
-The Sentry SDK instance.
-
-## Remarks
-
-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.
-

package/docs/server.telemetry.startspan.md

@@ -1,91 +0,0 @@
-<!-- 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);
-});
-```
-