hytopia 0.14.25 → 0.14.27

package/docs/server.playerevent.md

@@ -43,6 +43,20 @@ CHAT\_MESSAGE\_SEND
 </td><td>
 
 
+</td></tr>
+<tr><td>
+
+INTERACT
+
+
+</td><td>
+
+`"PLAYER.INTERACT"`
+
+
+</td><td>
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.playereventpayloads._player.interact_.md

@@ -0,0 +1,18 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [PlayerEventPayloads](./server.playereventpayloads.md) &gt; ["PLAYER.INTERACT"](./server.playereventpayloads._player.interact_.md)
+
+## PlayerEventPayloads."PLAYER.INTERACT" property
+
+Emitted when a player interacts the world.
+
+**Signature:**
+
+```typescript
+[PlayerEvent.INTERACT]: {
+        player: Player;
+        interactOrigin: Vector3Like;
+        interactDirection: Vector3Like;
+        raycastHit?: RaycastHit;
+    };
+```

package/docs/server.playereventpayloads.md

@@ -53,6 +53,25 @@ Description
 Emitted when a player sends a chat message.
 
 
+</td></tr>
+<tr><td>
+
+["PLAYER.INTERACT"](./server.playereventpayloads._player.interact_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ player: [Player](./server.player.md)<!-- -->; interactOrigin: [Vector3Like](./server.vector3like.md)<!-- -->; interactDirection: [Vector3Like](./server.vector3like.md)<!-- -->; raycastHit?: [RaycastHit](./server.raycasthit.md)<!-- -->; }
+
+
+</td><td>
+
+Emitted when a player interacts the world.
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.playerui.freezepointerlock.md

@@ -0,0 +1,53 @@
+<!-- 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. Preventing player inputs from automatically locking or unlocking the pointer relative to its current state.
+
+**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>
+
+Set true to freeze the pointer lock state, false to unfreeze it.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

package/docs/server.playerui.lockpointer.md

@@ -4,7 +4,7 @@
 
 ## PlayerUI.lockPointer() method
 
-Locks or unlocks the player's mouse pointer. If the pointer is unlocked with lockPointer(false), the player will not be able to use in-game inputs or camera controls from the mouse pointer until `player.ui.lockPointer(true)`<!-- -->, or in your game's client UI html with `hytopia.lockPointer(true)`<!-- -->.
+Locks or unlocks the player's mouse pointer on Desktop. If the pointer is unlocked with `lockPointer(false)`<!-- -->, the player will not be able to use in-game inputs or camera controls from the mouse pointer until `player.ui.lockPointer(true)`<!-- -->, or in your game's client UI html with `hytopia.lockPointer(true)`<!-- -->.
 
 **Signature:**
 
@@ -51,3 +51,7 @@ Set true to lock the pointer, false to unlock it.
 
 void
 
+## Remarks
+
+Pointer lock has no effect on mobile devices.
+

package/docs/server.playerui.md

@@ -89,6 +89,20 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
+[freezePointerLock(freeze)](./server.playerui.freezepointerlock.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Freezes or unfreezes the player's pointer lock state. Preventing player inputs from automatically locking or unlocking the pointer relative to its current state.
+
+
+</td></tr>
+<tr><td>
+
 [load(htmlUri)](./server.playerui.load.md)
 
 
@@ -111,7 +125,7 @@ Loads client UI for the player.
 
 </td><td>
 
-Locks or unlocks the player's mouse pointer. If the pointer is unlocked with lockPointer(false), the player will not be able to use in-game inputs or camera controls from the mouse pointer until `player.ui.lockPointer(true)`<!-- -->, or in your game's client UI html with `hytopia.lockPointer(true)`<!-- -->.
+Locks or unlocks the player's mouse pointer on Desktop. If the pointer is unlocked with `lockPointer(false)`<!-- -->, the player will not be able to use in-game inputs or camera controls from the mouse pointer until `player.ui.lockPointer(true)`<!-- -->, or in your game's client UI html with `hytopia.lockPointer(true)`<!-- -->.
 
 
 </td></tr>

package/docs/server.playeruievent.md

@@ -43,6 +43,20 @@ DATA
 </td><td>
 
 
+</td></tr>
+<tr><td>
+
+FREEZE\_POINTER\_LOCK
+
+
+</td><td>
+
+`"PLAYER_UI.FREEZE_POINTER_LOCK"`
+
+
+</td><td>
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.playeruieventpayloads._player_ui.freeze_pointer_lock_.md

@@ -0,0 +1,16 @@
+<!-- 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.FREEZE\_POINTER\_LOCK"](./server.playeruieventpayloads._player_ui.freeze_pointer_lock_.md)
+
+## PlayerUIEventPayloads."PLAYER\_UI.FREEZE\_POINTER\_LOCK" property
+
+Emitted when the player's pointer lock is frozen or unfrozen.
+
+**Signature:**
+
+```typescript
+[PlayerUIEvent.FREEZE_POINTER_LOCK]: {
+        playerUI: PlayerUI;
+        freeze: boolean;
+    };
+```

package/docs/server.playeruieventpayloads.md

@@ -53,6 +53,25 @@ Description
 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>
 

package/docs/server.raycasthit.md

@@ -14,6 +14,8 @@ export type RaycastHit = {
     hitEntity?: Entity;
     hitPoint: Vector3Like;
     hitDistance: number;
+    origin: Vector3Like;
+    originDirection: Vector3Like;
 };
 ```
 **References:** [Block](./server.block.md)<!-- -->, [Entity](./server.entity.md)<!-- -->, [Vector3Like](./server.vector3like.md)

package/docs/server.supported_inputs.md

@@ -9,5 +9,5 @@ The inputs that are included in the PlayerInput.
 **Signature:**
 
 ```typescript
-SUPPORTED_INPUTS: readonly ["w", "a", "s", "d", "sp", "sh", "tb", "ml", "mr", "q", "e", "r", "f", "z", "x", "c", "v", "u", "i", "o", "j", "k", "l", "n", "m", "1", "2", "3", "4", "5", "6", "7", "8", "9", "0", "cp", "cy", "jd"]
+SUPPORTED_INPUTS: readonly ["w", "a", "s", "d", "sp", "sh", "tb", "ml", "mr", "q", "e", "r", "f", "z", "x", "c", "v", "u", "i", "o", "j", "k", "l", "n", "m", "1", "2", "3", "4", "5", "6", "7", "8", "9", "0", "cp", "cy", "iro", "ird", "jd"]
 ```

package/package.json

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