[Home](./index.md) > [server](./server.md) > [PlayerUI](./server.playerui.md) ## PlayerUI class The UI for a player. When to use: showing overlays, HUDs, menus, and custom UI for a specific player. Do NOT use for: world-level UI shared by all players; use scene UI systems instead. **Signature:** ```typescript export default class PlayerUI extends EventRouter ``` **Extends:** [EventRouter](./server.eventrouter.md) ## Remarks UI is driven by HTML, CSS, and JavaScript files in your `assets` folder.

Events

This class is an EventRouter, and instances of it emit events with payloads listed under `PlayerUIEventPayloads`. \*\*Category:\*\* Players The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `PlayerUI` class. ## Properties
Property Modifiers Type Description
[player](./server.playerui.player.md) `readonly` [Player](./server.player.md) The player that the UI belongs to. \*\*Category:\*\* Players
## Methods
Method Modifiers Description
[append(htmlUri)](./server.playerui.append.md) Appends UI HTML to the player's existing client UI. Use for: incremental overlays (notifications, tooltips, modal layers). Do NOT use for: replacing the entire UI; use `PlayerUI.load`.
[freezePointerLock(freeze)](./server.playerui.freezepointerlock.md) Freezes or unfreezes the player's pointer lock state. Use for: menus or cutscenes that should not alter pointer lock.
[load(htmlUri)](./server.playerui.load.md) Loads client UI for the player, replacing any existing UI. Use for: switching to a new UI screen or resetting the UI. Do NOT use for: incremental overlays; use `PlayerUI.append`.
[lockPointer(lock)](./server.playerui.lockpointer.md) Locks or unlocks the player's mouse pointer on desktop. Use for: controlling when mouse input is captured. Do NOT use for: mobile devices (pointer lock has no effect).
[sendData(data)](./server.playerui.senddata.md) Sends data to the player's client UI. Use for: pushing state updates to your UI scripts.