[Home](./index.md) > [server](./server.md) > [SceneUI](./server.sceneui.md) ## SceneUI class UI rendered within the 3D space of a world's game scene. **Signature:** ```typescript export default class SceneUI extends EventRouter implements protocol.Serializable ``` **Extends:** [EventRouter](./server.eventrouter.md) **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.

Events

This class is an EventRouter, and instances of it emit events with payloads listed under [SceneUIEventPayloads](./server.sceneuieventpayloads.md) ## Example ```typescript const sceneUI = new SceneUI({ templateId: 'player-health-bar', attachedToEntity: playerEntity, offset: { x: 0, y: 1, z: 0 }, }); ``` ## Constructors
Constructor Modifiers Description
[(constructor)(options)](./server.sceneui._constructor_.md) Constructs a new instance of the `SceneUI` class
## Properties
Property Modifiers Type Description
[attachedToEntity](./server.sceneui.attachedtoentity.md) `readonly` [Entity](./server.entity.md) \| undefined The entity to which the SceneUI is attached if explicitly set.
[id](./server.sceneui.id.md) `readonly` number \| undefined The unique identifier for the SceneUI.
[isLoaded](./server.sceneui.isloaded.md) `readonly` boolean Whether the SceneUI is loaded into the world.
[offset](./server.sceneui.offset.md) `readonly` [Vector3Like](./server.vector3like.md) \| undefined The offset of the SceneUI from the attached entity or position.
[position](./server.sceneui.position.md) `readonly` [Vector3Like](./server.vector3like.md) \| undefined The position of the SceneUI in the world if explicitly set.
[state](./server.sceneui.state.md) `readonly` Readonly<object> The state of the SceneUI.
[templateId](./server.sceneui.templateid.md) `readonly` string The template ID of the SceneUI.
[viewDistance](./server.sceneui.viewdistance.md) `readonly` number \| undefined The maximum view distance the SceneUI will be visible to the player.
[world](./server.sceneui.world.md) `readonly` [World](./server.world.md) \| undefined The world the SceneUI is loaded into.
## Methods
Method Modifiers Description
[load(world)](./server.sceneui.load.md) Loads the SceneUI into the world.
[setAttachedToEntity(entity)](./server.sceneui.setattachedtoentity.md) Sets the entity to which the SceneUI is attached, following its position.
[setOffset(offset)](./server.sceneui.setoffset.md) Sets the spatial offset of the SceneUI relative to the attached entity or position.
[setPosition(position)](./server.sceneui.setposition.md) Sets the position of the SceneUI. Will detach from entity if attached.
[setState(state)](./server.sceneui.setstate.md) Sets the state of the SceneUI by performing a shallow merge with existing state.
[setViewDistance(viewDistance)](./server.sceneui.setviewdistance.md) Sets the view distance of the SceneUI.
[unload()](./server.sceneui.unload.md) Unloads the SceneUI from the world.