npm - hytopia - Versions diffs - 0.14.52 → 0.14.53 - Mend

hytopia 0.14.52 → 0.14.53

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 (701) hide show

package/docs/server.assetslibrary.assetslibrarypath.md CHANGED Viewed

@@ -6,6 +6,8 @@
 The path to the assets library package. Null if assets library is not available.
+\*\*Category:\*\* Assets
 **Signature:**
 ```typescript

package/docs/server.assetslibrary.instance.md CHANGED Viewed

@@ -6,6 +6,8 @@
 The global AssetsLibrary instance as a singleton.
+\*\*Category:\*\* Assets
 **Signature:**
 ```typescript

package/docs/server.assetslibrary.md CHANGED Viewed

@@ -6,6 +6,8 @@
 Manages the assets library and synchronization of assets to the local assets directory in development.
+When to use: pulling assets from the shared library during local development. Do NOT use for: production asset loading; the library is disabled in production.
 **Signature:**
 ```typescript
@@ -14,9 +16,9 @@ export default class AssetsLibrary
 ## Remarks
-The AssetsLibrary is created internally as a global singletone accessible with the static property `AssetsLibrary.instance`<!-- -->.
+The AssetsLibrary is created internally as a global singleton accessible via `AssetsLibrary.instance`<!-- -->.
-Please note: Assets will automatically sync to local assets in development mode the first time an asset in the library is requested by the client. This means you do not need to explicitly handle calling syncAsset() yourself unless you have a specific reason to.
+Assets automatically sync to local assets in development mode the first time an asset in the library is requested by the client. You generally do not need to call `AssetsLibrary.syncAsset` unless you have a specific reason to.
 ## Example
@@ -27,6 +29,7 @@ import { AssetsLibrary } from 'hytopia';
 const assetsLibrary = AssetsLibrary.instance;
 assetsLibrary.syncAsset('assets/models/player.gltf');
 ```
+\*\*Category:\*\* Assets
 ## Properties
@@ -72,6 +75,8 @@ string \| null
 The path to the assets library package. Null if assets library is not available.
+\*\*Category:\*\* Assets
 </td></tr>
 <tr><td>
@@ -95,6 +100,8 @@ The path to the assets library package. Null if assets library is not available.
 The global AssetsLibrary instance as a singleton.
+\*\*Category:\*\* Assets
 </td></tr>
 </tbody></table>

package/docs/server.assetslibrary.syncasset.md CHANGED Viewed

@@ -44,6 +44,12 @@ string
 The path of the asset to copy to local assets.
+\*\*Requires:\*\* Assets library must be available (development only).
+\*\*Side effects:\*\* Writes files into the local `assets/` directory.
+\*\*Category:\*\* Assets
 </td></tr>
 </tbody></table>

package/docs/server.audio.md CHANGED Viewed

@@ -17,11 +17,11 @@ export default class Audio extends EventRouter implements protocol.Serializable
 ## Remarks
-Audio instances are created directly as instances. They support a variety of configuration options through the [AudioOptions](./server.audiooptions.md) constructor argument.
+Audio instances are created directly as instances. They support a variety of configuration options through the `AudioOptions` constructor argument.
 <h2>Events</h2>
-This class is an EventRouter, and instances of it emit events with payloads listed under [AudioEventPayloads](./server.audioeventpayloads.md)
+This class is an EventRouter, and instances of it emit events with payloads listed under `AudioEventPayloads`
 ## Example
@@ -33,6 +33,7 @@ This class is an EventRouter, and instances of it emit events with payloads list
   volume: 0.5,
 })).play(world);
 ```
+\*\*Category:\*\* Audio
 ## Constructors

package/docs/server.audioevent.md CHANGED Viewed

@@ -4,7 +4,11 @@
 ## AudioEvent enum
-Event types an Audio instance can emit. See [AudioEventPayloads](./server.audioeventpayloads.md) for the payloads.
+Event types an Audio instance can emit.
+See `AudioEventPayloads` for the payloads.
+\*\*Category:\*\* Events
 **Signature:**

package/docs/server.audioeventpayloads.md CHANGED Viewed

@@ -6,6 +6,8 @@
 Event payloads for Audio emitted events.
+\*\*Category:\*\* Events
 **Signature:**
 ```typescript

package/docs/server.audiomanager.getallaudios.md CHANGED Viewed

@@ -17,3 +17,5 @@ getAllAudios(): Audio[];
 An array of audio instances.
+\*\*Category:\*\* Audio

package/docs/server.audiomanager.getallentityattachedaudios.md CHANGED Viewed

@@ -6,6 +6,8 @@
 Retrieves all loaded audio instances attached to a specific entity.
+Use for: cleanup when despawning an entity with positional audio.
 **Signature:**
 ```typescript
@@ -53,3 +55,5 @@ The entity to get attached audio instances for.
 An array of audio instances.
+\*\*Requires:\*\* Entity should belong to this world for meaningful results.

package/docs/server.audiomanager.md CHANGED Viewed

@@ -6,6 +6,8 @@
 Manages audio instances in a world.
+When to use: querying or bulk-controlling audio in a specific world. Do NOT use for: individual playback configuration; use `Audio` instances.
 **Signature:**
 ```typescript
@@ -14,7 +16,7 @@ export default class AudioManager
 ## Remarks
-The AudioManager is created internally as a singleton for each [World](./server.world.md) instance in a game server. It allows retrieval of all loaded audio, entity attached audio, looped audio, and more.
+The AudioManager is created internally per `World` instance. Audio is loaded on first `Audio.play`<!-- -->; this manager tracks loaded instances. Pattern: call `AudioManager.unregisterEntityAttachedAudios` when despawning entities with positional audio.
 The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `AudioManager` class.
@@ -24,8 +26,9 @@ The constructor for this class is marked as internal. Third-party code should no
 ```typescript
 // Stop all audio in the world
 const audioManager = world.audioManager;
-audioManager.getAllAudios().map(audio => audio.pause());
+audioManager.getAllAudios().forEach(audio => audio.pause());
 ```
+\*\*Category:\*\* Audio
 ## Properties
@@ -69,6 +72,8 @@ Description
 The world the audio manager is for.
+\*\*Category:\*\* Audio
 </td></tr>
 </tbody></table>
@@ -117,6 +122,8 @@ Retrieves all loaded audio instances for the world.
 Retrieves all loaded audio instances attached to a specific entity.
+Use for: cleanup when despawning an entity with positional audio.
 </td></tr>
 <tr><td>
@@ -159,6 +166,8 @@ Retrieves all oneshot (non-looped) audio instances for the world.
 Unregisters and stops an audio instance from the audio manager.
+Use for: explicit cleanup of one-shot or temporary sounds. Do NOT use for: pausing/resuming; use `Audio.pause` or `Audio.play` instead.
 </td></tr>
 <tr><td>
@@ -173,6 +182,8 @@ Unregisters and stops an audio instance from the audio manager.
 Unregisters and stops all audio instances attached to a specific entity.
+Use for: entity despawn or cleanup scenarios.
 </td></tr>
 </tbody></table>

package/docs/server.audiomanager.unregisteraudio.md CHANGED Viewed

@@ -6,6 +6,8 @@
 Unregisters and stops an audio instance from the audio manager.
+Use for: explicit cleanup of one-shot or temporary sounds. Do NOT use for: pausing/resuming; use `Audio.pause` or `Audio.play` instead.
 **Signature:**
 ```typescript
@@ -44,6 +46,10 @@ audio
 The audio instance to pause and unregister.
+\*\*Requires:\*\* Audio must be loaded (have an id) or an error is logged.
+\*\*Side effects:\*\* Pauses the audio and removes it from manager tracking.
 </td></tr>
 </tbody></table>

package/docs/server.audiomanager.unregisterentityattachedaudios.md CHANGED Viewed

@@ -6,6 +6,8 @@
 Unregisters and stops all audio instances attached to a specific entity.
+Use for: entity despawn or cleanup scenarios.
 **Signature:**
 ```typescript
@@ -44,6 +46,10 @@ entity
 The entity to pause and unregister audio instances for.
+\*\*Requires:\*\* Entity should belong to this world for meaningful results.
+\*\*Side effects:\*\* Pauses and unregisters any attached audio instances.
 </td></tr>
 </tbody></table>
@@ -53,5 +59,5 @@ void
 ## Remarks
-\*\*Pauses all:\*\* Calls `unregisterAudio()` for each attached audio, which pauses them.
+\*\*Pauses all:\*\* Calls `AudioManager.unregisterAudio` for each attached audio, which pauses them.

package/docs/server.audiomanager.world.md CHANGED Viewed

@@ -6,6 +6,8 @@
 The world the audio manager is for.
+\*\*Category:\*\* Audio
 **Signature:**
 ```typescript

package/docs/server.audiooptions.md CHANGED Viewed

@@ -6,6 +6,12 @@
 Options for creating an Audio instance.
+Positional audio can be configured via `AudioOptions.attachedToEntity` or `AudioOptions.position`<!-- -->.
+Use for: configuring audio before calling `Audio.play`<!-- -->. Do NOT use for: runtime updates after playback starts; use `Audio.set*` methods.
+\*\*Category:\*\* Audio
 **Signature:**
 ```typescript

package/docs/server.ballcollideroptions.md CHANGED Viewed

@@ -6,6 +6,10 @@
 The options for a ball collider.
+Use for: sphere-shaped colliders. Do NOT use for: other shapes; use the matching collider option type.
+\*\*Category:\*\* Physics
 **Signature:**
 ```typescript
@@ -53,6 +57,8 @@ number
 _(Optional)_ The radius of the ball collider.
+\*\*Category:\*\* Physics
 </td></tr>
 <tr><td>

package/docs/server.ballcollideroptions.radius.md CHANGED Viewed

@@ -6,6 +6,8 @@
 The radius of the ball collider.
+\*\*Category:\*\* Physics
 **Signature:**
 ```typescript

package/docs/server.basecollideroptions.bounciness.md CHANGED Viewed

@@ -6,6 +6,8 @@
 The bounciness of the collider.
+\*\*Category:\*\* Physics
 **Signature:**
 ```typescript

package/docs/server.basecollideroptions.bouncinesscombinerule.md CHANGED Viewed

@@ -6,6 +6,8 @@
 The bounciness combine rule of the collider.
+\*\*Category:\*\* Physics
 **Signature:**
 ```typescript

package/docs/server.basecollideroptions.collisiongroups.md CHANGED Viewed

@@ -6,6 +6,8 @@
 The collision groups the collider belongs to.
+\*\*Category:\*\* Physics
 **Signature:**
 ```typescript

package/docs/server.basecollideroptions.enabled.md CHANGED Viewed

@@ -6,6 +6,8 @@
 Whether the collider is enabled.
+\*\*Category:\*\* Physics
 **Signature:**
 ```typescript

package/docs/server.basecollideroptions.flags.md CHANGED Viewed

@@ -6,6 +6,8 @@
 The flags of the collider if the shape is a trimesh
+\*\*Category:\*\* Physics
 **Signature:**
 ```typescript

package/docs/server.basecollideroptions.friction.md CHANGED Viewed

@@ -6,6 +6,8 @@
 The friction of the collider.
+\*\*Category:\*\* Physics
 **Signature:**
 ```typescript

package/docs/server.basecollideroptions.frictioncombinerule.md CHANGED Viewed

@@ -6,6 +6,8 @@
 The friction combine rule of the collider.
+\*\*Category:\*\* Physics
 **Signature:**
 ```typescript

package/docs/server.basecollideroptions.issensor.md CHANGED Viewed

@@ -6,6 +6,8 @@
 Whether the collider is a sensor.
+\*\*Category:\*\* Physics
 **Signature:**
 ```typescript

package/docs/server.basecollideroptions.mass.md CHANGED Viewed

@@ -6,6 +6,8 @@
 The mass of the collider.
+\*\*Category:\*\* Physics
 **Signature:**
 ```typescript

package/docs/server.basecollideroptions.md CHANGED Viewed

@@ -6,6 +6,10 @@
 The base options for a collider.
+Use for: configuring colliders when creating entities or rigid bodies. Do NOT use for: runtime changes; use `Collider` methods instead.
+\*\*Category:\*\* Physics
 **Signature:**
 ```typescript
@@ -52,6 +56,8 @@ number
 _(Optional)_ The bounciness of the collider.
+\*\*Category:\*\* Physics
 </td></tr>
 <tr><td>
@@ -71,6 +77,8 @@ _(Optional)_ The bounciness of the collider.
 _(Optional)_ The bounciness combine rule of the collider.
+\*\*Category:\*\* Physics
 </td></tr>
 <tr><td>
@@ -90,6 +98,8 @@ _(Optional)_ The bounciness combine rule of the collider.
 _(Optional)_ The collision groups the collider belongs to.
+\*\*Category:\*\* Physics
 </td></tr>
 <tr><td>
@@ -109,6 +119,8 @@ boolean
 _(Optional)_ Whether the collider is enabled.
+\*\*Category:\*\* Physics
 </td></tr>
 <tr><td>
@@ -128,6 +140,8 @@ number
 _(Optional)_ The flags of the collider if the shape is a trimesh
+\*\*Category:\*\* Physics
 </td></tr>
 <tr><td>
@@ -147,6 +161,8 @@ number
 _(Optional)_ The friction of the collider.
+\*\*Category:\*\* Physics
 </td></tr>
 <tr><td>
@@ -166,6 +182,8 @@ _(Optional)_ The friction of the collider.
 _(Optional)_ The friction combine rule of the collider.
+\*\*Category:\*\* Physics
 </td></tr>
 <tr><td>
@@ -185,6 +203,8 @@ boolean
 _(Optional)_ Whether the collider is a sensor.
+\*\*Category:\*\* Physics
 </td></tr>
 <tr><td>
@@ -204,6 +224,8 @@ number
 _(Optional)_ The mass of the collider.
+\*\*Category:\*\* Physics
 </td></tr>
 <tr><td>
@@ -223,6 +245,8 @@ _(Optional)_ The mass of the collider.
 _(Optional)_ The on collision callback for the collider.
+\*\*Category:\*\* Physics
 </td></tr>
 <tr><td>
@@ -242,6 +266,8 @@ _(Optional)_ The on collision callback for the collider.
 _(Optional)_ The parent rigid body of the collider.
+\*\*Category:\*\* Physics
 </td></tr>
 <tr><td>
@@ -261,6 +287,8 @@ _(Optional)_ The parent rigid body of the collider.
 _(Optional)_ The relative position of the collider. Relative to parent rigid body.
+\*\*Category:\*\* Physics
 </td></tr>
 <tr><td>
@@ -280,6 +308,8 @@ _(Optional)_ The relative position of the collider. Relative to parent rigid bod
 _(Optional)_ The relative rotation of the collider. Relative to parent rigid body.
+\*\*Category:\*\* Physics
 </td></tr>
 <tr><td>
@@ -299,6 +329,8 @@ _(Optional)_ The relative rotation of the collider. Relative to parent rigid bod
 The shape of the collider.
+\*\*Category:\*\* Physics
 </td></tr>
 <tr><td>
@@ -318,6 +350,8 @@ The shape of the collider.
 _(Optional)_ The simulation the collider is in, if provided the collider will automatically be added to the simulation.
+\*\*Category:\*\* Physics
 </td></tr>
 <tr><td>
@@ -337,6 +371,8 @@ string
 _(Optional)_ An arbitrary identifier tag of the collider. Useful for your own logic.
+\*\*Category:\*\* Physics
 </td></tr>
 </tbody></table>

package/docs/server.basecollideroptions.oncollision.md CHANGED Viewed

@@ -6,6 +6,8 @@
 The on collision callback for the collider.
+\*\*Category:\*\* Physics
 **Signature:**
 ```typescript

package/docs/server.basecollideroptions.parentrigidbody.md CHANGED Viewed

@@ -6,6 +6,8 @@
 The parent rigid body of the collider.
+\*\*Category:\*\* Physics
 **Signature:**
 ```typescript

package/docs/server.basecollideroptions.relativeposition.md CHANGED Viewed

@@ -6,6 +6,8 @@
 The relative position of the collider. Relative to parent rigid body.
+\*\*Category:\*\* Physics
 **Signature:**
 ```typescript

package/docs/server.basecollideroptions.relativerotation.md CHANGED Viewed

@@ -6,6 +6,8 @@
 The relative rotation of the collider. Relative to parent rigid body.
+\*\*Category:\*\* Physics
 **Signature:**
 ```typescript

package/docs/server.basecollideroptions.shape.md CHANGED Viewed

@@ -6,6 +6,8 @@
 The shape of the collider.
+\*\*Category:\*\* Physics
 **Signature:**
 ```typescript

package/docs/server.basecollideroptions.simulation.md CHANGED Viewed

@@ -6,6 +6,8 @@
 The simulation the collider is in, if provided the collider will automatically be added to the simulation.
+\*\*Category:\*\* Physics
 **Signature:**
 ```typescript

package/docs/server.basecollideroptions.tag.md CHANGED Viewed

@@ -6,6 +6,8 @@
 An arbitrary identifier tag of the collider. Useful for your own logic.
+\*\*Category:\*\* Physics
 **Signature:**
 ```typescript

package/docs/server.baseentitycontroller.attach.md CHANGED Viewed

@@ -44,6 +44,8 @@ entity
 The entity to attach the controller to.
+\*\*Category:\*\* Controllers
 </td></tr>
 </tbody></table>

package/docs/server.baseentitycontroller.despawn.md CHANGED Viewed

@@ -44,6 +44,8 @@ entity
 The entity being despawned.
+\*\*Category:\*\* Controllers
 </td></tr>
 </tbody></table>

package/docs/server.baseentitycontroller.detach.md CHANGED Viewed

@@ -44,6 +44,8 @@ entity
 The entity being detached.
+\*\*Category:\*\* Controllers
 </td></tr>
 </tbody></table>