hytopia/docs/server.playerui.freezepointerlock.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; [PlayerUI](./server.playerui.md) &gt; [freezePointerLock](./server.playerui.freezepointerlock.md)

## PlayerUI.freezePointerLock() method

Freezes or unfreezes the player's pointer lock state.

Use for: menus or cutscenes that should not alter pointer lock.

**Signature:**

```typescript
freezePointerLock(freeze: boolean): void;
```

## Parameters

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

Parameter


</th><th>

Type


</th><th>

Description


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

freeze


</td><td>

boolean


</td><td>

True to freeze pointer lock, false to unfreeze it.

\*\*Requires:\*\* Player must be in a world.

\*\*Side effects:\*\* Emits `PlayerUIEvent.FREEZE_POINTER_LOCK`<!-- -->.

\*\*Category:\*\* Players


</td></tr>
</tbody></table>
**Returns:**

void