<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [server](./server.md) &gt; [PlayerUIEventPayloads](./server.playeruieventpayloads.md) &gt; ["PLAYER\_UI.LOCK\_POINTER"](./server.playeruieventpayloads._player_ui.lock_pointer_.md)

## PlayerUIEventPayloads."PLAYER\_UI.LOCK\_POINTER" property

Emitted when the player's mouse pointer is locked or unlocked.

**Signature:**

```typescript
[PlayerUIEvent.LOCK_POINTER]: {
        playerUI: PlayerUI;
        lock: boolean;
    };
```