hytopia/docs/server.sceneuioptions.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; [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>
<tr><td>

[viewDistance?](./server.sceneuioptions.viewdistance.md)


</td><td>


</td><td>

number


</td><td>

_(Optional)_ The maximum view distance the SceneUI will be visible to the player


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