hytopia 0.1.58 → 0.1.60

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
+

package/docs/server.sceneui.setposition.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; [setPosition](./server.sceneui.setposition.md)
+
+## SceneUI.setPosition() method
+
+Sets the position of the SceneUI. Will detach from entity if attached.
+
+**Signature:**
+
+```typescript
+setPosition(position: Vector3Like): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+position
+
+
+</td><td>
+
+[Vector3Like](./server.vector3like.md)
+
+
+</td><td>
+
+The position in the world.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

package/docs/server.sceneui.setstate.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; [setState](./server.sceneui.setstate.md)
+
+## SceneUI.setState() method
+
+Sets the state of the SceneUI by performing a shallow merge with existing state.
+
+**Signature:**
+
+```typescript
+setState(state: object): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+state
+
+
+</td><td>
+
+object
+
+
+</td><td>
+
+The state to set.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

package/docs/server.sceneui.state.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; [state](./server.sceneui.state.md)
+
+## SceneUI.state property
+
+**Signature:**
+
+```typescript
+get state(): Readonly<object>;
+```

package/docs/server.sceneui.templateid.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; [templateId](./server.sceneui.templateid.md)
+
+## SceneUI.templateId property
+
+**Signature:**
+
+```typescript
+get templateId(): string;
+```

package/docs/server.sceneui.unload.md

@@ -0,0 +1,17 @@
+<!-- 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; [unload](./server.sceneui.unload.md)
+
+## SceneUI.unload() method
+
+Unloads the SceneUI from the world.
+
+**Signature:**
+
+```typescript
+unload(): void;
+```
+**Returns:**
+
+void
+

package/docs/server.sceneui.world.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; [world](./server.sceneui.world.md)
+
+## SceneUI.world property
+
+**Signature:**
+
+```typescript
+get world(): World | undefined;
+```

package/docs/server.sceneuimanager.getallentityattachedsceneuis.md

@@ -0,0 +1,55 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [SceneUIManager](./server.sceneuimanager.md) &gt; [getAllEntityAttachedSceneUIs](./server.sceneuimanager.getallentityattachedsceneuis.md)
+
+## SceneUIManager.getAllEntityAttachedSceneUIs() method
+
+Retrieves all loaded SceneUI instances attached to a specific entity.
+
+**Signature:**
+
+```typescript
+getAllEntityAttachedSceneUIs(entity: Entity): SceneUI[];
+```
+
+## 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 get attached SceneUI instances for.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+[SceneUI](./server.sceneui.md)<!-- -->\[\]
+
+An array of SceneUI instances.
+

package/docs/server.sceneuimanager.getallsceneuis.md

@@ -0,0 +1,19 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [SceneUIManager](./server.sceneuimanager.md) &gt; [getAllSceneUIs](./server.sceneuimanager.getallsceneuis.md)
+
+## SceneUIManager.getAllSceneUIs() method
+
+Retrieves all loaded SceneUI instances for the world.
+
+**Signature:**
+
+```typescript
+getAllSceneUIs(): SceneUI[];
+```
+**Returns:**
+
+[SceneUI](./server.sceneui.md)<!-- -->\[\]
+
+An array of SceneUI instances.
+