hytopia 0.1.59 → 0.1.60

package/docs/server.audio._constructor_.md

@@ -42,6 +42,8 @@ options
 
 </td><td>
 
+The options for the Audio instance.
+
 
 </td></tr>
 </tbody></table>

package/docs/server.audio.setattachedtoentity.md

@@ -42,7 +42,7 @@ entity
 
 </td><td>
 
-The entity to attach the audio to.
+The entity to attach the Audio to.
 
 
 </td></tr>

package/docs/server.audiomanager.unregisteraudio.md

@@ -42,7 +42,7 @@ audio
 
 </td><td>
 
-The audio instance to unregister.
+The audio instance to pause and unregister.
 
 
 </td></tr>

package/docs/server.audiomanager.unregisterentityattachedaudios.md

@@ -42,7 +42,7 @@ entity
 
 </td><td>
 
-The entity to unregister audio instances for.
+The entity to pause and unregister audio instances for.
 
 
 </td></tr>

package/docs/server.md

@@ -258,6 +258,28 @@ Represents a quaternion.
 Represents a rigid body in a world's physics simulation.
 
 
+</td></tr>
+<tr><td>
+
+[SceneUI](./server.sceneui.md)
+
+
+</td><td>
+
+UI rendered within the 3D space of a world's game scene.
+
+
+</td></tr>
+<tr><td>
+
+[SceneUIManager](./server.sceneuimanager.md)
+
+
+</td><td>
+
+Manages SceneUI instances in a world.
+
+
 </td></tr>
 <tr><td>
 
@@ -670,6 +692,17 @@ A RGB color.
 Options for creating a RigidBody instance.
 
 
+</td></tr>
+<tr><td>
+
+[SceneUIOptions](./server.sceneuioptions.md)
+
+
+</td><td>
+
+Options for creating a SceneUI instance.
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.sceneui._constructor_.md

@@ -0,0 +1,49 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [SceneUI](./server.sceneui.md) &gt; [(constructor)](./server.sceneui._constructor_.md)
+
+## SceneUI.(constructor)
+
+Constructs a new instance of the `SceneUI` class
+
+**Signature:**
+
+```typescript
+constructor(options: SceneUIOptions);
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+options
+
+
+</td><td>
+
+[SceneUIOptions](./server.sceneuioptions.md)
+
+
+</td><td>
+
+The options for the SceneUI instance.
+
+
+</td></tr>
+</tbody></table>

package/docs/server.sceneui.attachedtoentity.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [SceneUI](./server.sceneui.md) &gt; [attachedToEntity](./server.sceneui.attachedtoentity.md)
+
+## SceneUI.attachedToEntity property
+
+**Signature:**
+
+```typescript
+get attachedToEntity(): Entity | undefined;
+```

package/docs/server.sceneui.id.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [SceneUI](./server.sceneui.md) &gt; [id](./server.sceneui.id.md)
+
+## SceneUI.id property
+
+**Signature:**
+
+```typescript
+get id(): number | undefined;
+```

package/docs/server.sceneui.isloaded.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [SceneUI](./server.sceneui.md) &gt; [isLoaded](./server.sceneui.isloaded.md)
+
+## SceneUI.isLoaded property
+
+**Signature:**
+
+```typescript
+get isLoaded(): boolean;
+```

package/docs/server.sceneui.load.md

@@ -0,0 +1,53 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [SceneUI](./server.sceneui.md) &gt; [load](./server.sceneui.load.md)
+
+## SceneUI.load() method
+
+Loads the SceneUI into the world.
+
+**Signature:**
+
+```typescript
+load(world: World): 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 load the SceneUI into.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

package/docs/server.sceneui.md

@@ -0,0 +1,344 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [SceneUI](./server.sceneui.md)
+
+## SceneUI class
+
+UI rendered within the 3D space of a world's game scene.
+
+**Signature:**
+
+```typescript
+export default class SceneUI implements protocol.Serializable 
+```
+**Implements:** protocol.Serializable
+
+## Remarks
+
+SceneUI instances are created directly as instances. They support a variety of configuration options through the [SceneUIOptions](./server.sceneuioptions.md) constructor argument.
+
+## Example
+
+
+```typescript
+const sceneUI = new SceneUI({
+  templateId: 'player-health-bar',
+  attachedToEntity: playerEntity,
+  offset: { x: 0, y: 1, z: 0 },
+});
+```
+
+## Constructors
+
+<table><thead><tr><th>
+
+Constructor
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[(constructor)(options)](./server.sceneui._constructor_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Constructs a new instance of the `SceneUI` 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.sceneui.attachedtoentity.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+[Entity](./server.entity.md) \| undefined
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[id](./server.sceneui.id.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+number \| undefined
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[isLoaded](./server.sceneui.isloaded.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[offset](./server.sceneui.offset.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+[Vector3Like](./server.vector3like.md) \| undefined
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[position](./server.sceneui.position.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+[Vector3Like](./server.vector3like.md) \| undefined
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[state](./server.sceneui.state.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+Readonly&lt;object&gt;
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[templateId](./server.sceneui.templateid.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[world](./server.sceneui.world.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+[World](./server.world.md) \| undefined
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+
+## Methods
+
+<table><thead><tr><th>
+
+Method
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[load(world)](./server.sceneui.load.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Loads the SceneUI into the world.
+
+
+</td></tr>
+<tr><td>
+
+[setAttachedToEntity(entity)](./server.sceneui.setattachedtoentity.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Sets the entity to which the SceneUI is attached, following its position.
+
+
+</td></tr>
+<tr><td>
+
+[setOffset(offset)](./server.sceneui.setoffset.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Sets the spatial offset of the SceneUI relative to the attached entity or position.
+
+
+</td></tr>
+<tr><td>
+
+[setPosition(position)](./server.sceneui.setposition.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Sets the position of the SceneUI. Will detach from entity if attached.
+
+
+</td></tr>
+<tr><td>
+
+[setState(state)](./server.sceneui.setstate.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Sets the state of the SceneUI by performing a shallow merge with existing state.
+
+
+</td></tr>
+<tr><td>
+
+[unload()](./server.sceneui.unload.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Unloads the SceneUI from the world.
+
+
+</td></tr>
+</tbody></table>

package/docs/server.sceneui.offset.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [SceneUI](./server.sceneui.md) &gt; [offset](./server.sceneui.offset.md)
+
+## SceneUI.offset property
+
+**Signature:**
+
+```typescript
+get offset(): Vector3Like | undefined;
+```

package/docs/server.sceneui.position.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [SceneUI](./server.sceneui.md) &gt; [position](./server.sceneui.position.md)
+
+## SceneUI.position property
+
+**Signature:**
+
+```typescript
+get position(): Vector3Like | undefined;
+```

package/docs/server.sceneui.setattachedtoentity.md

@@ -0,0 +1,53 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [SceneUI](./server.sceneui.md) &gt; [setAttachedToEntity](./server.sceneui.setattachedtoentity.md)
+
+## SceneUI.setAttachedToEntity() method
+
+Sets the entity to which the SceneUI is attached, following its position.
+
+**Signature:**
+
+```typescript
+setAttachedToEntity(entity: Entity): void;
+```
+
+## 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 to attach the SceneUI to.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

package/docs/server.sceneui.setoffset.md

@@ -0,0 +1,53 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [SceneUI](./server.sceneui.md) &gt; [setOffset](./server.sceneui.setoffset.md)
+
+## SceneUI.setOffset() method
+
+Sets the spatial offset of the SceneUI relative to the attached entity or position.
+
+**Signature:**
+
+```typescript
+setOffset(offset: Vector3Like): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+offset
+
+
+</td><td>
+
+[Vector3Like](./server.vector3like.md)
+
+
+</td><td>
+
+The offset in the world.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+