hytopia 0.14.26 → 0.14.28

package/client-docs/client.hytopiaui.freezepointerlock.md

@@ -0,0 +1,54 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [client](./client.md) &gt; [HytopiaUI](./client.hytopiaui.md) &gt; [freezePointerLock](./client.hytopiaui.freezepointerlock.md)
+
+## HytopiaUI.freezePointerLock() method
+
+Freezes or unfreezes the pointer lock state. Preventing player inputs from automatically locking or unlocking the pointer. Esc key will still unlock the pointer - this is a system level feature that cannot be overriden. Pointer lock only affects Desktop devices.
+
+**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>
+
+When `true`<!-- -->, the pointer lock will be frozen in the current state, preventing changes until `false` is passed again or player.ui.freezePointerLock(false) is called by the server.
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+void
+

package/client-docs/client.hytopiaui.lockpointer.md

@@ -4,7 +4,7 @@
 
 ## HytopiaUI.lockPointer() method
 
-Controls pointer lock for your UI. When locked, the cursor is hidden and mouse movement controls the camera. Call with `true` when hiding your UI so players can control the camera, `false` when showing UI that needs cursor interaction.
+Controls pointer lock for your UI. When locked, the cursor is hidden and mouse movement controls the camera. Call with `true` when hiding your UI so players can control the camera, `false` when showing UI that needs cursor interaction. Pointer lock only affects Desktop devices.
 
 **Signature:**
 

package/client-docs/client.hytopiaui.md

@@ -201,6 +201,20 @@ Removes an arrow by its ID.
 Filters inappropriate language from text by replacing profanity with asterisks. Use this to sanitize user-generated content displayed in your UI (e.g., chat messages, usernames).
 
 
+</td></tr>
+<tr><td>
+
+[freezePointerLock(freeze)](./client.hytopiaui.freezepointerlock.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Freezes or unfreezes the pointer lock state. Preventing player inputs from automatically locking or unlocking the pointer. Esc key will still unlock the pointer - this is a system level feature that cannot be overriden. Pointer lock only affects Desktop devices.
+
+
 </td></tr>
 <tr><td>
 
@@ -282,7 +296,7 @@ Checks whether a Scene UI template is currently registered.
 
 </td><td>
 
-Controls pointer lock for your UI. When locked, the cursor is hidden and mouse movement controls the camera. Call with `true` when hiding your UI so players can control the camera, `false` when showing UI that needs cursor interaction.
+Controls pointer lock for your UI. When locked, the cursor is hidden and mouse movement controls the camera. Call with `true` when hiding your UI so players can control the camera, `false` when showing UI that needs cursor interaction. Pointer lock only affects Desktop devices.
 
 
 </td></tr>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hytopia",
-  "version": "0.14.26",
+  "version": "0.14.28",
   "description": "The HYTOPIA SDK makes it easy for developers to create massively multiplayer games using JavaScript or TypeScript.",
   "type": "module",
   "main": "./server.mjs",