hytopia 0.1.44 → 0.1.46

package/docs/server.hytopia.audiooptions.md

@@ -1,247 +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; [AudioOptions](./server.hytopia.audiooptions.md)
-
-## HYTOPIA.AudioOptions interface
-
-Options for creating an Audio instance.
-
-**Signature:**
-
-```typescript
-export interface AudioOptions 
-```
-
-## Properties
-
-<table><thead><tr><th>
-
-Property
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[attachedToEntity?](./server.hytopia.audiooptions.attachedtoentity.md)
-
-
-</td><td>
-
-
-</td><td>
-
-[Entity](./server.entity.md)
-
-
-</td><td>
-
-_(Optional)_ If set, audio playback will follow the entity's position.
-
-
-</td></tr>
-<tr><td>
-
-[detune?](./server.hytopia.audiooptions.detune.md)
-
-
-</td><td>
-
-
-</td><td>
-
-number
-
-
-</td><td>
-
-_(Optional)_ The detuning of the audio in cents.
-
-
-</td></tr>
-<tr><td>
-
-[distortion?](./server.hytopia.audiooptions.distortion.md)
-
-
-</td><td>
-
-
-</td><td>
-
-number
-
-
-</td><td>
-
-_(Optional)_ The amount of distortion to apply to the audio.
-
-
-</td></tr>
-<tr><td>
-
-[duration?](./server.hytopia.audiooptions.duration.md)
-
-
-</td><td>
-
-
-</td><td>
-
-number
-
-
-</td><td>
-
-_(Optional)_ The duration of the audio in seconds. Defaults to full duration.
-
-
-</td></tr>
-<tr><td>
-
-[loop?](./server.hytopia.audiooptions.loop.md)
-
-
-</td><td>
-
-
-</td><td>
-
-boolean
-
-
-</td><td>
-
-_(Optional)_ Whether the audio should loop when it reaches the end. Defaults to false.
-
-
-</td></tr>
-<tr><td>
-
-[offset?](./server.hytopia.audiooptions.offset.md)
-
-
-</td><td>
-
-
-</td><td>
-
-number
-
-
-</td><td>
-
-_(Optional)_ The offset time in seconds from which the audio should start playing.
-
-
-</td></tr>
-<tr><td>
-
-[playbackRate?](./server.hytopia.audiooptions.playbackrate.md)
-
-
-</td><td>
-
-
-</td><td>
-
-number
-
-
-</td><td>
-
-_(Optional)_ The playback speed of the audio. Defaults to 1.
-
-
-</td></tr>
-<tr><td>
-
-[position?](./server.hytopia.audiooptions.position.md)
-
-
-</td><td>
-
-
-</td><td>
-
-[Vector3Like](./server.vector3like.md)
-
-
-</td><td>
-
-_(Optional)_ The position in the world where the audio is played.
-
-
-</td></tr>
-<tr><td>
-
-[referenceDistance?](./server.hytopia.audiooptions.referencedistance.md)
-
-
-</td><td>
-
-
-</td><td>
-
-number
-
-
-</td><td>
-
-_(Optional)_ The reference distance for reducing volume as the audio source moves away from the listener.
-
-
-</td></tr>
-<tr><td>
-
-[uri](./server.hytopia.audiooptions.uri.md)
-
-
-</td><td>
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-The URI or path to the audio asset to be played.
-
-
-</td></tr>
-<tr><td>
-
-[volume?](./server.hytopia.audiooptions.volume.md)
-
-
-</td><td>
-
-
-</td><td>
-
-number
-
-
-</td><td>
-
-_(Optional)_ The volume level of the audio. Defaults to 0.5.
-
-
-</td></tr>
-</tbody></table>

package/docs/server.hytopia.audiooptions.offset.md

@@ -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; [AudioOptions](./server.hytopia.audiooptions.md) &gt; [offset](./server.hytopia.audiooptions.offset.md)
-
-## HYTOPIA.AudioOptions.offset property
-
-The offset time in seconds from which the audio should start playing.
-
-**Signature:**
-
-```typescript
-offset?: number;
-```

package/docs/server.hytopia.audiooptions.playbackrate.md

@@ -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; [AudioOptions](./server.hytopia.audiooptions.md) &gt; [playbackRate](./server.hytopia.audiooptions.playbackrate.md)
-
-## HYTOPIA.AudioOptions.playbackRate property
-
-The playback speed of the audio. Defaults to 1.
-
-**Signature:**
-
-```typescript
-playbackRate?: number;
-```

package/docs/server.hytopia.audiooptions.position.md

@@ -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; [AudioOptions](./server.hytopia.audiooptions.md) &gt; [position](./server.hytopia.audiooptions.position.md)
-
-## HYTOPIA.AudioOptions.position property
-
-The position in the world where the audio is played.
-
-**Signature:**
-
-```typescript
-position?: Vector3Like;
-```

package/docs/server.hytopia.audiooptions.referencedistance.md

@@ -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; [AudioOptions](./server.hytopia.audiooptions.md) &gt; [referenceDistance](./server.hytopia.audiooptions.referencedistance.md)
-
-## HYTOPIA.AudioOptions.referenceDistance property
-
-The reference distance for reducing volume as the audio source moves away from the listener.
-
-**Signature:**
-
-```typescript
-referenceDistance?: number;
-```

package/docs/server.hytopia.audiooptions.uri.md

@@ -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; [AudioOptions](./server.hytopia.audiooptions.md) &gt; [uri](./server.hytopia.audiooptions.uri.md)
-
-## HYTOPIA.AudioOptions.uri property
-
-The URI or path to the audio asset to be played.
-
-**Signature:**
-
-```typescript
-uri: string;
-```

package/docs/server.hytopia.audiooptions.volume.md

@@ -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; [AudioOptions](./server.hytopia.audiooptions.md) &gt; [volume](./server.hytopia.audiooptions.volume.md)
-
-## HYTOPIA.AudioOptions.volume property
-
-The volume level of the audio. Defaults to 0.5.
-
-**Signature:**
-
-```typescript
-volume?: number;
-```

package/docs/server.hytopia.basecharactercontroller._constructor_.md

@@ -1,65 +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; [BaseCharacterController](./server.hytopia.basecharactercontroller.md) &gt; [(constructor)](./server.hytopia.basecharactercontroller._constructor_.md)
-
-## HYTOPIA.BaseCharacterController.(constructor)
-
-Constructs a new instance of the `BaseCharacterController` class
-
-**Signature:**
-
-```typescript
-constructor(entity: Entity, _options?: Record<string, unknown>);
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-entity
-
-
-</td><td>
-
-[Entity](./server.entity.md)
-
-
-</td><td>
-
-The entity the controller is for.
-
-
-</td></tr>
-<tr><td>
-
-\_options
-
-
-</td><td>
-
-Record&lt;string, unknown&gt;
-
-
-</td><td>
-
-_(Optional)_ Arbitrary options you may provide or omit for your controller implementation.
-
-
-</td></tr>
-</tbody></table>

package/docs/server.hytopia.basecharactercontroller.createcolliders.md

@@ -1,19 +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; [BaseCharacterController](./server.hytopia.basecharactercontroller.md) &gt; [createColliders](./server.hytopia.basecharactercontroller.createcolliders.md)
-
-## HYTOPIA.BaseCharacterController.createColliders() method
-
-Override this method to create controller specific colliders to be attached to the controlled entity when it spawns.
-
-**Signature:**
-
-```typescript
-createColliders(): Collider[];
-```
-**Returns:**
-
-[Collider](./server.collider.md)<!-- -->\[\]
-
-An array of colliders.
-

package/docs/server.hytopia.basecharactercontroller.entity.md

@@ -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; [BaseCharacterController](./server.hytopia.basecharactercontroller.md) &gt; [entity](./server.hytopia.basecharactercontroller.entity.md)
-
-## HYTOPIA.BaseCharacterController.entity property
-
-The entity the controller is for.
-
-**Signature:**
-
-```typescript
-readonly entity: Entity;
-```

package/docs/server.hytopia.basecharactercontroller.md

@@ -1,197 +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; [BaseCharacterController](./server.hytopia.basecharactercontroller.md)
-
-## HYTOPIA.BaseCharacterController class
-
-A base class for character controller implementations.
-
-**Signature:**
-
-```typescript
-export default abstract class BaseCharacterController 
-```
-
-## Remarks
-
-The BaseCharacterController should be extended by a more specific character controller that you or a plugin implements.
-
-## Constructors
-
-<table><thead><tr><th>
-
-Constructor
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[(constructor)(entity, \_options)](./server.hytopia.basecharactercontroller._constructor_.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Constructs a new instance of the `BaseCharacterController` 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>
-
-[entity](./server.hytopia.basecharactercontroller.entity.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-[Entity](./server.entity.md)
-
-
-</td><td>
-
-The entity the controller is for.
-
-
-</td></tr>
-<tr><td>
-
-[onTick?](./server.hytopia.basecharactercontroller.ontick.md)
-
-
-</td><td>
-
-
-</td><td>
-
-(deltaTimeMs: number) =&gt; void
-
-
-</td><td>
-
-_(Optional)_ A callback function for when the controller ticks.
-
-
-</td></tr>
-<tr><td>
-
-[onTickPlayerMovement?](./server.hytopia.basecharactercontroller.ontickplayermovement.md)
-
-
-</td><td>
-
-
-</td><td>
-
-(inputState: [PlayerInputState](./server.playerinputstate.md)<!-- -->, orientationState: [PlayerOrientationState](./server.playerorientationstate.md)<!-- -->, deltaTimeMs: number) =&gt; void
-
-
-</td><td>
-
-_(Optional)_ A callback function for when the controller ticks player movement.
-
-
-</td></tr>
-</tbody></table>
-
-## Methods
-
-<table><thead><tr><th>
-
-Method
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[createColliders()](./server.hytopia.basecharactercontroller.createcolliders.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Override this method to create controller specific colliders to be attached to the controlled entity when it spawns.
-
-
-</td></tr>
-<tr><td>
-
-[tick(deltaTimeMs)](./server.hytopia.basecharactercontroller.tick.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Override this method to handle entity movements based on your character controller.
-
-
-</td></tr>
-<tr><td>
-
-[tickPlayerMovement(inputState, orientationState, deltaTimeMs)](./server.hytopia.basecharactercontroller.tickplayermovement.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Override this method to handle entity movements based on player input for your character controller.
-
-
-</td></tr>
-</tbody></table>

package/docs/server.hytopia.basecharactercontroller.ontick.md

@@ -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; [BaseCharacterController](./server.hytopia.basecharactercontroller.md) &gt; [onTick](./server.hytopia.basecharactercontroller.ontick.md)
-
-## HYTOPIA.BaseCharacterController.onTick property
-
-A callback function for when the controller ticks.
-
-**Signature:**
-
-```typescript
-onTick?: (deltaTimeMs: number) => void;
-```

package/docs/server.hytopia.basecharactercontroller.ontickplayermovement.md

@@ -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; [BaseCharacterController](./server.hytopia.basecharactercontroller.md) &gt; [onTickPlayerMovement](./server.hytopia.basecharactercontroller.ontickplayermovement.md)
-
-## HYTOPIA.BaseCharacterController.onTickPlayerMovement property
-
-A callback function for when the controller ticks player movement.
-
-**Signature:**
-
-```typescript
-onTickPlayerMovement?: (inputState: PlayerInputState, orientationState: PlayerOrientationState, deltaTimeMs: number) => void;
-```

package/docs/server.hytopia.basecharactercontroller.tick.md

@@ -1,53 +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; [BaseCharacterController](./server.hytopia.basecharactercontroller.md) &gt; [tick](./server.hytopia.basecharactercontroller.tick.md)
-
-## HYTOPIA.BaseCharacterController.tick() method
-
-Override this method to handle entity movements based on your character controller.
-
-**Signature:**
-
-```typescript
-tick(deltaTimeMs: number): void;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-deltaTimeMs
-
-
-</td><td>
-
-number
-
-
-</td><td>
-
-The delta time in milliseconds since the last tick.
-
-
-</td></tr>
-</tbody></table>
-**Returns:**
-
-void
-