npm - hytopia - Versions diffs - 0.1.44 → 0.1.45 - Mend

hytopia 0.1.44 → 0.1.45

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

package/docs/server.hytopia.audio.md DELETED Viewed

@@ -1,591 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [server](./server.md) &gt; [HYTOPIA](./server.hytopia.md) &gt; [Audio](./server.hytopia.audio.md)
-## HYTOPIA.Audio class
-Represents a audio playback in a world.
-**Signature:**
-```typescript
-export default class Audio implements protocol.Serializable
-```
-**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.
-## Example
-```typescript
-(new Audio({
-  uri: 'music/song.mp3', // relative to the server's assets directory in the project root, resolves to assets/music/song.mp3
-  loop: true,
-  volume: 0.5,
-})).play(world);
-```
-## Constructors
-<table><thead><tr><th>
-Constructor
-</th><th>
-Modifiers
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[(constructor)(options)](./server.hytopia.audio._constructor_.md)
-</td><td>
-</td><td>
-Constructs a new instance of the `Audio` class
-</td></tr>
-</tbody></table>
-## Properties
-<table><thead><tr><th>
-Property
-</th><th>
-Modifiers
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[attachedToEntity](./server.hytopia.audio.attachedtoentity.md)
-</td><td>
-`readonly`
-</td><td>
-[Entity](./server.entity.md) \| undefined
-</td><td>
-The entity to which the audio is attached if explicitly set.
-</td></tr>
-<tr><td>
-[detune](./server.hytopia.audio.detune.md)
-</td><td>
-`readonly`
-</td><td>
-number \| undefined
-</td><td>
-The detune of the audio in cents if explicitly set.
-</td></tr>
-<tr><td>
-[distortion](./server.hytopia.audio.distortion.md)
-</td><td>
-`readonly`
-</td><td>
-number \| undefined
-</td><td>
-The amount of distortion to apply to the audio if explicitly set.
-</td></tr>
-<tr><td>
-[duration](./server.hytopia.audio.duration.md)
-</td><td>
-`readonly`
-</td><td>
-number \| undefined
-</td><td>
-The duration of the audio in seconds if explicitly set.
-</td></tr>
-<tr><td>
-[id](./server.hytopia.audio.id.md)
-</td><td>
-`readonly`
-</td><td>
-number \| undefined
-</td><td>
-The unique identifier for the audio.
-</td></tr>
-<tr><td>
-[isLoaded](./server.hytopia.audio.isloaded.md)
-</td><td>
-`readonly`
-</td><td>
-boolean
-</td><td>
-Whether the audio has loaded into the world. Audio is loaded the first time play() is called.
-</td></tr>
-<tr><td>
-[isPlaying](./server.hytopia.audio.isplaying.md)
-</td><td>
-`readonly`
-</td><td>
-boolean
-</td><td>
-Whether the audio is currently playing.
-</td></tr>
-<tr><td>
-[isPositional](./server.hytopia.audio.ispositional.md)
-</td><td>
-`readonly`
-</td><td>
-boolean
-</td><td>
-Whether the audio is positional (Entity or position attached).
-</td></tr>
-<tr><td>
-[loop](./server.hytopia.audio.loop.md)
-</td><td>
-`readonly`
-</td><td>
-boolean
-</td><td>
-Whether the audio is looped.
-</td></tr>
-<tr><td>
-[offset](./server.hytopia.audio.offset.md)
-</td><td>
-`readonly`
-</td><td>
-number \| undefined
-</td><td>
-The offset time in seconds from which the audio should start playing if explicitly set.
-</td></tr>
-<tr><td>
-[playbackRate](./server.hytopia.audio.playbackrate.md)
-</td><td>
-`readonly`
-</td><td>
-number \| undefined
-</td><td>
-The playback rate of the audio if explicitly set.
-</td></tr>
-<tr><td>
-[position](./server.hytopia.audio.position.md)
-</td><td>
-`readonly`
-</td><td>
-[Vector3Like](./server.vector3like.md) \| undefined
-</td><td>
-The position of the audio in the world if explicitly set.
-</td></tr>
-<tr><td>
-[referenceDistance](./server.hytopia.audio.referencedistance.md)
-</td><td>
-`readonly`
-</td><td>
-number \| undefined
-</td><td>
-The reference distance of the audio if explicitly set.
-</td></tr>
-<tr><td>
-[startTick](./server.hytopia.audio.starttick.md)
-</td><td>
-`readonly`
-</td><td>
-number \| undefined
-</td><td>
-The server tick at which the audio started playing.
-</td></tr>
-<tr><td>
-[uri](./server.hytopia.audio.uri.md)
-</td><td>
-`readonly`
-</td><td>
-string
-</td><td>
-The URI of the audio asset.
-</td></tr>
-<tr><td>
-[volume](./server.hytopia.audio.volume.md)
-</td><td>
-`readonly`
-</td><td>
-number \| undefined
-</td><td>
-The volume of the audio if explicitly set.
-</td></tr>
-<tr><td>
-[world](./server.hytopia.audio.world.md)
-</td><td>
-`readonly`
-</td><td>
-[World](./server.world.md) \| undefined
-</td><td>
-The world the audio is in if already loaded.
-</td></tr>
-</tbody></table>
-## Methods
-<table><thead><tr><th>
-Method
-</th><th>
-Modifiers
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[pause()](./server.hytopia.audio.pause.md)
-</td><td>
-</td><td>
-Pauses the audio.
-</td></tr>
-<tr><td>
-[play(world, restart)](./server.hytopia.audio.play.md)
-</td><td>
-</td><td>
-Plays or resumes the audio.
-</td></tr>
-<tr><td>
-[setAttachedToEntity(entity)](./server.hytopia.audio.setattachedtoentity.md)
-</td><td>
-</td><td>
-Sets the entity to which the audio is attached, following its position.
-</td></tr>
-<tr><td>
-[setDetune(detune)](./server.hytopia.audio.setdetune.md)
-</td><td>
-</td><td>
-Sets the detune of the audio.
-</td></tr>
-<tr><td>
-[setDistortion(distortion)](./server.hytopia.audio.setdistortion.md)
-</td><td>
-</td><td>
-Sets the distortion of the audio.
-</td></tr>
-<tr><td>
-[setPlaybackRate(playbackRate)](./server.hytopia.audio.setplaybackrate.md)
-</td><td>
-</td><td>
-Sets the playback rate of the audio.
-</td></tr>
-<tr><td>
-[setPosition(position)](./server.hytopia.audio.setposition.md)
-</td><td>
-</td><td>
-Sets the position of the audio. Will detach from entity if attached.
-</td></tr>
-<tr><td>
-[setReferenceDistance(referenceDistance)](./server.hytopia.audio.setreferencedistance.md)
-</td><td>
-</td><td>
-Sets the reference distance of the audio.
-</td></tr>
-<tr><td>
-[setVolume(volume)](./server.hytopia.audio.setvolume.md)
-</td><td>
-</td><td>
-Sets the volume of the audio.
-</td></tr>
-</tbody></table>

package/docs/server.hytopia.audio.offset.md DELETED Viewed

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [server](./server.md) &gt; [HYTOPIA](./server.hytopia.md) &gt; [Audio](./server.hytopia.audio.md) &gt; [offset](./server.hytopia.audio.offset.md)
-## HYTOPIA.Audio.offset property
-The offset time in seconds from which the audio should start playing if explicitly set.
-**Signature:**
-```typescript
-get offset(): number | undefined;
-```

package/docs/server.hytopia.audio.pause.md DELETED Viewed

@@ -1,17 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [server](./server.md) &gt; [HYTOPIA](./server.hytopia.md) &gt; [Audio](./server.hytopia.audio.md) &gt; [pause](./server.hytopia.audio.pause.md)
-## HYTOPIA.Audio.pause() method
-Pauses the audio.
-**Signature:**
-```typescript
-pause(): void;
-```
-**Returns:**
-void

package/docs/server.hytopia.audio.play.md DELETED Viewed

@@ -1,69 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [server](./server.md) &gt; [HYTOPIA](./server.hytopia.md) &gt; [Audio](./server.hytopia.audio.md) &gt; [play](./server.hytopia.audio.play.md)
-## HYTOPIA.Audio.play() method
-Plays or resumes the audio.
-**Signature:**
-```typescript
-play(world: World, restart?: boolean): void;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-world
-</td><td>
-[World](./server.world.md)
-</td><td>
-The world to play the audio in.
-</td></tr>
-<tr><td>
-restart
-</td><td>
-boolean
-</td><td>
-_(Optional)_ If true, the audio will restart from the beginning if it is already playing.
-</td></tr>
-</tbody></table>
-**Returns:**
-void

package/docs/server.hytopia.audio.playbackrate.md DELETED Viewed

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [server](./server.md) &gt; [HYTOPIA](./server.hytopia.md) &gt; [Audio](./server.hytopia.audio.md) &gt; [playbackRate](./server.hytopia.audio.playbackrate.md)
-## HYTOPIA.Audio.playbackRate property
-The playback rate of the audio if explicitly set.
-**Signature:**
-```typescript
-get playbackRate(): number | undefined;
-```

package/docs/server.hytopia.audio.position.md DELETED Viewed

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [server](./server.md) &gt; [HYTOPIA](./server.hytopia.md) &gt; [Audio](./server.hytopia.audio.md) &gt; [position](./server.hytopia.audio.position.md)
-## HYTOPIA.Audio.position property
-The position of the audio in the world if explicitly set.
-**Signature:**
-```typescript
-get position(): Vector3Like | undefined;
-```

package/docs/server.hytopia.audio.referencedistance.md DELETED Viewed

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [server](./server.md) &gt; [HYTOPIA](./server.hytopia.md) &gt; [Audio](./server.hytopia.audio.md) &gt; [referenceDistance](./server.hytopia.audio.referencedistance.md)
-## HYTOPIA.Audio.referenceDistance property
-The reference distance of the audio if explicitly set.
-**Signature:**
-```typescript
-get referenceDistance(): number | undefined;
-```