hytopia/docs/server.playeruieventpayloads.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; [PlayerUIEventPayloads](./server.playeruieventpayloads.md)

## PlayerUIEventPayloads interface

Event payloads for PlayerUI emitted events.

\*\*Category:\*\* Events

**Signature:**

```typescript
export interface PlayerUIEventPayloads 
```

## Properties

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

Property


</th><th>

Modifiers


</th><th>

Type


</th><th>

Description


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

["PLAYER\_UI.APPEND"](./server.playeruieventpayloads._player_ui.append_.md)


</td><td>


</td><td>

{ playerUI: [PlayerUI](./server.playerui.md)<!-- -->; htmlUri: string; }


</td><td>

Emitted when UI HTML is appended to the player's existing client UI.


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

["PLAYER\_UI.DATA"](./server.playeruieventpayloads._player_ui.data_.md)


</td><td>


</td><td>

{ playerUI: [PlayerUI](./server.playerui.md)<!-- -->; data: Record&lt;string, any&gt;; }


</td><td>

Emitted when data is received by the server from the player's client UI.


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

["PLAYER\_UI.FREEZE\_POINTER\_LOCK"](./server.playeruieventpayloads._player_ui.freeze_pointer_lock_.md)


</td><td>


</td><td>

{ playerUI: [PlayerUI](./server.playerui.md)<!-- -->; freeze: boolean; }


</td><td>

Emitted when the player's pointer lock is frozen or unfrozen.


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

["PLAYER\_UI.LOAD"](./server.playeruieventpayloads._player_ui.load_.md)


</td><td>


</td><td>

{ playerUI: [PlayerUI](./server.playerui.md)<!-- -->; htmlUri: string; }


</td><td>

Emitted when the player's client UI is loaded.


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

["PLAYER\_UI.LOCK\_POINTER"](./server.playeruieventpayloads._player_ui.lock_pointer_.md)


</td><td>


</td><td>

{ playerUI: [PlayerUI](./server.playerui.md)<!-- -->; lock: boolean; }


</td><td>

Emitted when the player's mouse pointer is locked or unlocked.


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

["PLAYER\_UI.SEND\_DATA"](./server.playeruieventpayloads._player_ui.send_data_.md)


</td><td>


</td><td>

{ playerUI: [PlayerUI](./server.playerui.md)<!-- -->; data: Record&lt;string, any&gt;; }


</td><td>

Emitted when data is sent from the server to the player's client UI.


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