hytopia
Version:
The HYTOPIA SDK makes it easy for developers to create massively multiplayer games using JavaScript or TypeScript.
142 lines (64 loc) • 2.11 kB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) > [server](./server.md) > [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>
[getSceneUIById(id)](./server.sceneuimanager.getsceneuibyid.md)
</td><td>
</td><td>
Retrieves a SceneUI instance by its unique identifier (id).
</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>