hytopia/docs/server.sceneuieventpayloads.md

The HYTOPIA SDK makes it easy for developers to create massively multiplayer games using JavaScript or TypeScript.

<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [server](./server.md) &gt; [SceneUIEventPayloads](./server.sceneuieventpayloads.md)

## SceneUIEventPayloads interface

Event payloads for SceneUI emitted events.

**Signature:**

```typescript
export interface SceneUIEventPayloads 
```

## Properties

<table><thead><tr><th>

Property


</th><th>

Modifiers


</th><th>

Type


</th><th>

Description


</th></tr></thead>
<tbody><tr><td>

["SCENE\_UI.LOAD"](./server.sceneuieventpayloads._scene_ui.load_.md)


</td><td>


</td><td>

{ sceneUI: [SceneUI](./server.sceneui.md)<!-- -->; }


</td><td>

Emitted when a SceneUI is loaded into the world.


</td></tr>
<tr><td>

["SCENE\_UI.SET\_ATTACHED\_TO\_ENTITY"](./server.sceneuieventpayloads._scene_ui.set_attached_to_entity_.md)


</td><td>


</td><td>

{ sceneUI: [SceneUI](./server.sceneui.md)<!-- -->; entity: [Entity](./server.entity.md)<!-- -->; }


</td><td>

Emitted when a SceneUI is attached to an entity.


</td></tr>
<tr><td>

["SCENE\_UI.SET\_OFFSET"](./server.sceneuieventpayloads._scene_ui.set_offset_.md)


</td><td>


</td><td>

{ sceneUI: [SceneUI](./server.sceneui.md)<!-- -->; offset: [Vector3Like](./server.vector3like.md)<!-- -->; }


</td><td>

Emitted when the offset of a SceneUI is set.


</td></tr>
<tr><td>

["SCENE\_UI.SET\_POSITION"](./server.sceneuieventpayloads._scene_ui.set_position_.md)


</td><td>


</td><td>

{ sceneUI: [SceneUI](./server.sceneui.md)<!-- -->; position: [Vector3Like](./server.vector3like.md)<!-- -->; }


</td><td>

Emitted when the position of a SceneUI is set.


</td></tr>
<tr><td>

["SCENE\_UI.SET\_STATE"](./server.sceneuieventpayloads._scene_ui.set_state_.md)


</td><td>


</td><td>

{ sceneUI: [SceneUI](./server.sceneui.md)<!-- -->; state: object; }


</td><td>

Emitted when the state of a SceneUI is set.


</td></tr>
<tr><td>

["SCENE\_UI.SET\_VIEW\_DISTANCE"](./server.sceneuieventpayloads._scene_ui.set_view_distance_.md)


</td><td>


</td><td>

{ sceneUI: [SceneUI](./server.sceneui.md)<!-- -->; viewDistance: number; }


</td><td>

Emitted when the view distance of a SceneUI is set.


</td></tr>
<tr><td>

["SCENE\_UI.UNLOAD"](./server.sceneuieventpayloads._scene_ui.unload_.md)


</td><td>


</td><td>

{ sceneUI: [SceneUI](./server.sceneui.md)<!-- -->; }


</td><td>

Emitted when a SceneUI is unloaded from the world.


</td></tr>
</tbody></table>