hytopia 0.3.27 → 0.3.29

package/docs/server.audio.cutoffdistance.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [Audio](./server.audio.md) &gt; [cutoffDistance](./server.audio.cutoffdistance.md)
+
+## Audio.cutoffDistance property
+
+The cutoff distance where the audio will be reduced to 0 volume.
+
+**Signature:**
+
+```typescript
+get cutoffDistance(): number;
+```

package/docs/server.audio.md

@@ -111,6 +111,27 @@ Description
 The entity to which the audio is attached if explicitly set.
 
 
+</td></tr>
+<tr><td>
+
+[cutoffDistance](./server.audio.cutoffdistance.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+The cutoff distance where the audio will be reduced to 0 volume.
+
+
 </td></tr>
 <tr><td>
 
@@ -509,6 +530,20 @@ Plays or resumes the audio.
 Sets the entity to which the audio is attached, following its position.
 
 
+</td></tr>
+<tr><td>
+
+[setCutoffDistance(cutoffDistance)](./server.audio.setcutoffdistance.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Sets the cutoff distance of the audio.
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.audio.setcutoffdistance.md

@@ -0,0 +1,57 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [Audio](./server.audio.md) &gt; [setCutoffDistance](./server.audio.setcutoffdistance.md)
+
+## Audio.setCutoffDistance() method
+
+Sets the cutoff distance of the audio.
+
+**Signature:**
+
+```typescript
+setCutoffDistance(cutoffDistance: number): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+cutoffDistance
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+The cutoff distance.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+
+## Remarks
+
+The cutoff distance defines the maximum range at which the audio can be heard. Beyond this distance, the audio volume becomes zero. As the listener moves from the reference distance toward the cutoff distance, the volume decreases linearly, providing a natural spatial audio experience with smooth volume falloff based on distance.
+

package/docs/server.audio.setreferencedistance.md

@@ -51,3 +51,7 @@ The reference distance.
 
 void
 
+## Remarks
+
+The reference distance defines the range within which the audio plays at full volume. When a listener is within this distance from the audio source, they will hear the sound at its maximum volume. Beyond this distance, the volume decreases linearly until reaching the cutoff distance, where the sound becomes inaudible. This creates a natural spatial audio experience with smooth volume falloff based on distance.
+

package/docs/server.audioevent.md

@@ -85,6 +85,20 @@ SET\_ATTACHED\_TO\_ENTITY
 </td><td>
 
 
+</td></tr>
+<tr><td>
+
+SET\_CUTOFF\_DISTANCE
+
+
+</td><td>
+
+`"AUDIO.SET_CUTOFF_DISTANCE"`
+
+
+</td><td>
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.audioeventpayloads._audio.set_cutoff_distance_.md

@@ -0,0 +1,16 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [AudioEventPayloads](./server.audioeventpayloads.md) &gt; ["AUDIO.SET\_CUTOFF\_DISTANCE"](./server.audioeventpayloads._audio.set_cutoff_distance_.md)
+
+## AudioEventPayloads."AUDIO.SET\_CUTOFF\_DISTANCE" property
+
+Emitted when the audio's cutoff distance is set.
+
+**Signature:**
+
+```typescript
+[AudioEvent.SET_CUTOFF_DISTANCE]: {
+        audio: Audio;
+        cutoffDistance: number;
+    };
+```

package/docs/server.audioeventpayloads.md

@@ -110,6 +110,25 @@ Emitted when the audio is played.
 Emitted when the audio is attached to an entity.
 
 
+</td></tr>
+<tr><td>
+
+["AUDIO.SET\_CUTOFF\_DISTANCE"](./server.audioeventpayloads._audio.set_cutoff_distance_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ audio: [Audio](./server.audio.md)<!-- -->; cutoffDistance: number; }
+
+
+</td><td>
+
+Emitted when the audio's cutoff distance is set.
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.audiooptions.cutoffdistance.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [AudioOptions](./server.audiooptions.md) &gt; [cutoffDistance](./server.audiooptions.cutoffdistance.md)
+
+## AudioOptions.cutoffDistance property
+
+The cutoff distance between the audio source and the listener where the audio will be reduced to 0 volume. Must be greater than reference distance. Defaults to reference distance + 10.
+
+**Signature:**
+
+```typescript
+cutoffDistance?: number;
+```

package/docs/server.audiooptions.md

@@ -53,6 +53,25 @@ Description
 _(Optional)_ If set, audio playback will follow the entity's position.
 
 
+</td></tr>
+<tr><td>
+
+[cutoffDistance?](./server.audiooptions.cutoffdistance.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+_(Optional)_ The cutoff distance between the audio source and the listener where the audio will be reduced to 0 volume. Must be greater than reference distance. Defaults to reference distance + 10.
+
+
 </td></tr>
 <tr><td>
 
@@ -202,7 +221,7 @@ number
 
 </td><td>
 
-_(Optional)_ The reference distance for reducing volume as the audio source moves away from the listener.
+_(Optional)_ The maximum reference distance between the audio source and the listener where the audio will still be max volume. Defaults to 10.
 
 
 </td></tr>

package/docs/server.audiooptions.referencedistance.md

@@ -4,7 +4,7 @@
 
 ## AudioOptions.referenceDistance property
 
-The reference distance for reducing volume as the audio source moves away from the listener.
+The maximum reference distance between the audio source and the listener where the audio will still be max volume. Defaults to 10.
 
 **Signature:**