hytopia 0.1.59 → 0.1.61

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.
+

package/docs/server.sceneuimanager.md

@@ -0,0 +1,127 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [SceneUIManager](./server.sceneuimanager.md)
+
+## SceneUIManager class
+
+Manages SceneUI instances in a world.
+
+**Signature:**
+
+```typescript
+export default class SceneUIManager 
+```
+
+## Remarks
+
+The SceneUIManager is created internally as a singleton for each [World](./server.world.md) instance in a game server. It allows retrieval of all loaded SceneUI instances, entity attached SceneUI instances, and more.
+
+The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `SceneUIManager` class.
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[world](./server.sceneuimanager.world.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+[World](./server.world.md)
+
+
+</td><td>
+
+The world the SceneUIManager is for.
+
+
+</td></tr>
+</tbody></table>
+
+## Methods
+
+<table><thead><tr><th>
+
+Method
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[getAllEntityAttachedSceneUIs(entity)](./server.sceneuimanager.getallentityattachedsceneuis.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Retrieves all loaded SceneUI instances attached to a specific entity.
+
+
+</td></tr>
+<tr><td>
+
+[getAllSceneUIs()](./server.sceneuimanager.getallsceneuis.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Retrieves all loaded SceneUI instances for the world.
+
+
+</td></tr>
+<tr><td>
+
+[unloadEntityAttachedSceneUIs(entity)](./server.sceneuimanager.unloadentityattachedsceneuis.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Unloads and unregisters all SceneUI instances attached to a specific entity.
+
+
+</td></tr>
+</tbody></table>

package/docs/server.sceneuimanager.unloadentityattachedsceneuis.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; [SceneUIManager](./server.sceneuimanager.md) &gt; [unloadEntityAttachedSceneUIs](./server.sceneuimanager.unloadentityattachedsceneuis.md)
+
+## SceneUIManager.unloadEntityAttachedSceneUIs() method
+
+Unloads and unregisters all SceneUI instances attached to a specific entity.
+
+**Signature:**
+
+```typescript
+unloadEntityAttachedSceneUIs(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 unload and unregister SceneUI instances for.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

package/docs/server.sceneuimanager.world.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; [SceneUIManager](./server.sceneuimanager.md) &gt; [world](./server.sceneuimanager.world.md)
+
+## SceneUIManager.world property
+
+The world the SceneUIManager is for.
+
+**Signature:**
+
+```typescript
+get world(): World;
+```

package/docs/server.sceneuioptions.attachedtoentity.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; [SceneUIOptions](./server.sceneuioptions.md) &gt; [attachedToEntity](./server.sceneuioptions.attachedtoentity.md)
+
+## SceneUIOptions.attachedToEntity property
+
+If set, SceneUI will follow the entity's position
+
+**Signature:**
+
+```typescript
+attachedToEntity?: Entity;
+```

package/docs/server.sceneuioptions.md

@@ -0,0 +1,133 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [SceneUIOptions](./server.sceneuioptions.md)
+
+## SceneUIOptions interface
+
+Options for creating a SceneUI instance.
+
+**Signature:**
+
+```typescript
+export interface SceneUIOptions 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[attachedToEntity?](./server.sceneuioptions.attachedtoentity.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[Entity](./server.entity.md)
+
+
+</td><td>
+
+_(Optional)_ If set, SceneUI will follow the entity's position
+
+
+</td></tr>
+<tr><td>
+
+[offset?](./server.sceneuioptions.offset.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[Vector3Like](./server.vector3like.md)
+
+
+</td><td>
+
+_(Optional)_ The offset of the SceneUI from the attached entity or position
+
+
+</td></tr>
+<tr><td>
+
+[position?](./server.sceneuioptions.position.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[Vector3Like](./server.vector3like.md)
+
+
+</td><td>
+
+_(Optional)_ If set, SceneUI will be attached at this position
+
+
+</td></tr>
+<tr><td>
+
+[state?](./server.sceneuioptions.state.md)
+
+
+</td><td>
+
+
+</td><td>
+
+object
+
+
+</td><td>
+
+_(Optional)_ The state of the SceneUI
+
+
+</td></tr>
+<tr><td>
+
+[templateId](./server.sceneuioptions.templateid.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+The template ID to use for this SceneUI
+
+
+</td></tr>
+</tbody></table>

package/docs/server.sceneuioptions.offset.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; [SceneUIOptions](./server.sceneuioptions.md) &gt; [offset](./server.sceneuioptions.offset.md)
+
+## SceneUIOptions.offset property
+
+The offset of the SceneUI from the attached entity or position
+
+**Signature:**
+
+```typescript
+offset?: Vector3Like;
+```

package/docs/server.sceneuioptions.position.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; [SceneUIOptions](./server.sceneuioptions.md) &gt; [position](./server.sceneuioptions.position.md)
+
+## SceneUIOptions.position property
+
+If set, SceneUI will be attached at this position
+
+**Signature:**
+
+```typescript
+position?: Vector3Like;
+```

package/docs/server.sceneuioptions.state.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; [SceneUIOptions](./server.sceneuioptions.md) &gt; [state](./server.sceneuioptions.state.md)
+
+## SceneUIOptions.state property
+
+The state of the SceneUI
+
+**Signature:**
+
+```typescript
+state?: object;
+```

package/docs/server.sceneuioptions.templateid.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; [SceneUIOptions](./server.sceneuioptions.md) &gt; [templateId](./server.sceneuioptions.templateid.md)
+
+## SceneUIOptions.templateId property
+
+The template ID to use for this SceneUI
+
+**Signature:**
+
+```typescript
+templateId: string;
+```

package/docs/server.world.md

@@ -311,6 +311,27 @@ _(Optional)_ A function that is called when a player joins the world.
 _(Optional)_ A function that is called when a player leaves the world.
 
 
+</td></tr>
+<tr><td>
+
+[sceneUIManager](./server.world.sceneuimanager.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+[SceneUIManager](./server.sceneuimanager.md)
+
+
+</td><td>
+
+The scene UI manager for the world.
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.world.sceneuimanager.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; [World](./server.world.md) &gt; [sceneUIManager](./server.world.sceneuimanager.md)
+
+## World.sceneUIManager property
+
+The scene UI manager for the world.
+
+**Signature:**
+
+```typescript
+get sceneUIManager(): SceneUIManager;
+```