hytopia 0.14.25 → 0.14.27

package/bin/scripts.js

@@ -76,7 +76,7 @@ async function start() {
   const projectRoot = process.cwd();
   const entryFile = path.join(projectRoot, 'index.mjs');
   const buildCmd = 'hytopia build-dev';
-  const runCmd = `"${process.execPath}" "${entryFile}"`;
+  const runCmd = `"${process.execPath}" --enable-source-maps "${entryFile}"`;
 
   // Start nodemon to watch for changes, rebuild, then run the server
   nodemon({
@@ -470,9 +470,9 @@ async function packageProject() {
 
 
 async function build(devMode = false) {
-  let envFlags = devMode ? '' : '--minify-whitespace --minify-syntax --sourcemap=inline';
+  let envFlags = devMode ? '' : '--minify-whitespace --minify-syntax';
 
-  execSync(`npx --yes bun build --target=node --env=disable --format=esm ${envFlags} --external=@fails-components/webtransport --external=@fails-components/webtransport-transport-http3-quiche --outfile=index.mjs index.ts`, { stdio: 'inherit' });
+  execSync(`npx --yes bun build --target=node --env=disable --format=esm ${envFlags} --sourcemap=inline --external=@fails-components/webtransport --external=@fails-components/webtransport-transport-http3-quiche --outfile=index.mjs index.ts`, { stdio: 'inherit' });
 }
 
 /**

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/docs/server.blocktype.interact.md

@@ -0,0 +1,73 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [BlockType](./server.blocktype.md) &gt; [interact](./server.blocktype.interact.md)
+
+## BlockType.interact() method
+
+Triggers an interaction on the block type from a player.
+
+**Signature:**
+
+```typescript
+interact(player: Player, raycastHit?: RaycastHit): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+player
+
+
+</td><td>
+
+[Player](./server.player.md)
+
+
+</td><td>
+
+The player interacting with the block type.
+
+
+</td></tr>
+<tr><td>
+
+raycastHit
+
+
+</td><td>
+
+[RaycastHit](./server.raycasthit.md)
+
+
+</td><td>
+
+_(Optional)_ The raycast hit result, if the interaction was triggered by a client-side click/tap.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+
+## Remarks
+
+This is automatically called when a player clicks or taps a block of this block type, but can also be called directly for programmatic interactions. Emits [BlockTypeEvent.INTERACT](./server.blocktypeevent.md)<!-- -->.
+

package/docs/server.blocktype.md

@@ -283,5 +283,39 @@ string
 The URI of the texture for the block type.
 
 
+</td></tr>
+</tbody></table>
+
+## Methods
+
+<table><thead><tr><th>
+
+Method
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[interact(player, raycastHit)](./server.blocktype.interact.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Triggers an interaction on the block type from a player.
+
+
 </td></tr>
 </tbody></table>

package/docs/server.blocktypeevent.md

@@ -57,5 +57,19 @@ ENTITY\_CONTACT\_FORCE
 </td><td>
 
 
+</td></tr>
+<tr><td>
+
+INTERACT
+
+
+</td><td>
+
+`"BLOCK_TYPE.INTERACT"`
+
+
+</td><td>
+
+
 </td></tr>
 </tbody></table>

package/docs/server.blocktypeeventpayloads._block_type.interact_.md

@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [BlockTypeEventPayloads](./server.blocktypeeventpayloads.md) &gt; ["BLOCK\_TYPE.INTERACT"](./server.blocktypeeventpayloads._block_type.interact_.md)
+
+## BlockTypeEventPayloads."BLOCK\_TYPE.INTERACT" property
+
+Emitted when a player interacts with a block type.
+
+**Signature:**
+
+```typescript
+[BlockTypeEvent.INTERACT]: {
+        blockType: BlockType;
+        player: Player;
+        raycastHit?: RaycastHit;
+    };
+```

package/docs/server.blocktypeeventpayloads.md

@@ -72,5 +72,24 @@ Emitted when an entity collides with a block type.
 Emitted when an entity's contact force is applied to a block type.
 
 
+</td></tr>
+<tr><td>
+
+["BLOCK\_TYPE.INTERACT"](./server.blocktypeeventpayloads._block_type.interact_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ blockType: [BlockType](./server.blocktype.md)<!-- -->; player: [Player](./server.player.md)<!-- -->; raycastHit?: [RaycastHit](./server.raycasthit.md)<!-- -->; }
+
+
+</td><td>
+
+Emitted when a player interacts with a block type.
+
+
 </td></tr>
 </tbody></table>

package/docs/server.entity.interact.md

@@ -0,0 +1,73 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [Entity](./server.entity.md) &gt; [interact](./server.entity.interact.md)
+
+## Entity.interact() method
+
+Triggers an interaction on the entity from a player.
+
+**Signature:**
+
+```typescript
+interact(player: Player, raycastHit?: RaycastHit): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+player
+
+
+</td><td>
+
+[Player](./server.player.md)
+
+
+</td><td>
+
+The player interacting with the entity.
+
+
+</td></tr>
+<tr><td>
+
+raycastHit
+
+
+</td><td>
+
+[RaycastHit](./server.raycasthit.md)
+
+
+</td><td>
+
+_(Optional)_ The raycast hit result, if the interaction was triggered by a client-side click/tap.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+
+## Remarks
+
+This is automatically called when a player clicks or taps the entity, but can also be called directly for programmatic interactions. Emits [EntityEvent.INTERACT](./server.entityevent.md)<!-- -->.
+

package/docs/server.entity.isenvironmental.md

@@ -4,7 +4,7 @@
 
 ## Entity.isEnvironmental property
 
-Whether the entity is environmental, if true it will not invoke its tick function or change position.
+Whether the entity is environmental, if true it will not invoke its tick function or change position. It also cannot be animated or removed after spawning.
 
 **Signature:**
 

package/docs/server.entity.md

@@ -270,7 +270,7 @@ boolean
 
 </td><td>
 
-Whether the entity is environmental, if true it will not invoke its tick function or change position.
+Whether the entity is environmental, if true it will not invoke its tick function or change position. It also cannot be animated or removed after spawning.
 
 
 </td></tr>
@@ -685,6 +685,20 @@ Description
 Despawns the entity and all children from the world.
 
 
+</td></tr>
+<tr><td>
+
+[interact(player, raycastHit)](./server.entity.interact.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Triggers an interaction on the entity from a player.
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.entityevent.md

@@ -99,6 +99,20 @@ ENTITY\_CONTACT\_FORCE
 </td><td>
 
 
+</td></tr>
+<tr><td>
+
+INTERACT
+
+
+</td><td>
+
+`"ENTITY.INTERACT"`
+
+
+</td><td>
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.entityeventpayloads._entity.interact_.md

@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [EntityEventPayloads](./server.entityeventpayloads.md) &gt; ["ENTITY.INTERACT"](./server.entityeventpayloads._entity.interact_.md)
+
+## EntityEventPayloads."ENTITY.INTERACT" property
+
+Emitted when a player interacts with the entity by clicking or tapping it.
+
+**Signature:**
+
+```typescript
+[EntityEvent.INTERACT]: {
+        entity: Entity;
+        player: Player;
+        raycastHit?: RaycastHit;
+    };
+```

package/docs/server.entityeventpayloads.md

@@ -129,6 +129,25 @@ Emitted when an entity collides with another entity.
 Emitted when an entity's contact force is applied to another entity.
 
 
+</td></tr>
+<tr><td>
+
+["ENTITY.INTERACT"](./server.entityeventpayloads._entity.interact_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ entity: [Entity](./server.entity.md)<!-- -->; player: [Player](./server.player.md)<!-- -->; raycastHit?: [RaycastHit](./server.raycasthit.md)<!-- -->; }
+
+
+</td><td>
+
+Emitted when a player interacts with the entity by clicking or tapping it.
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.player.interactenabled.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [Player](./server.player.md) &gt; [interactEnabled](./server.player.interactenabled.md)
+
+## Player.interactEnabled property
+
+Whether the players click/taps will cause interacts with blocks or entities. Defaults to true.
+
+**Signature:**
+
+```typescript
+get interactEnabled(): boolean;
+```

package/docs/server.player.maxinteractdistance.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [Player](./server.player.md) &gt; [maxInteractDistance](./server.player.maxinteractdistance.md)
+
+## Player.maxInteractDistance property
+
+The maximum distance a player can interact with entities or blocks. The raycast distance in blocks for interactions. Defaults to 20.
+
+**Signature:**
+
+```typescript
+get maxInteractDistance(): number;
+```

package/docs/server.player.md

@@ -131,6 +131,48 @@ The unique HYTOPIA UUID for the player.
 The current [PlayerInput](./server.playerinput.md) of the player.
 
 
+</td></tr>
+<tr><td>
+
+[interactEnabled](./server.player.interactenabled.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+Whether the players click/taps will cause interacts with blocks or entities. Defaults to true.
+
+
+</td></tr>
+<tr><td>
+
+[maxInteractDistance](./server.player.maxinteractdistance.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+The maximum distance a player can interact with entities or blocks. The raycast distance in blocks for interactions. Defaults to 20.
+
+
 </td></tr>
 <tr><td>
 
@@ -305,6 +347,34 @@ Resets all inputs keys
 Schedule a notification the player at a point in time in the future. This will automatically handle prompting a player (if necessary) for notification permissions in-game.
 
 
+</td></tr>
+<tr><td>
+
+[setInteractEnabled(enabled)](./server.player.setinteractenabled.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Sets whether the players click/taps will cause interacts with blocks or entities.
+
+
+</td></tr>
+<tr><td>
+
+[setMaxInteractDistance(distance)](./server.player.setmaxinteractdistance.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Sets the maximum distance a player can interact with entities or blocks.
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.player.setinteractenabled.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; [Player](./server.player.md) &gt; [setInteractEnabled](./server.player.setinteractenabled.md)
+
+## Player.setInteractEnabled() method
+
+Sets whether the players click/taps will cause interacts with blocks or entities.
+
+**Signature:**
+
+```typescript
+setInteractEnabled(enabled: boolean): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+enabled
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+Whether the players click/taps will cause interacts with blocks or entities.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

package/docs/server.player.setmaxinteractdistance.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; [Player](./server.player.md) &gt; [setMaxInteractDistance](./server.player.setmaxinteractdistance.md)
+
+## Player.setMaxInteractDistance() method
+
+Sets the maximum distance a player can interact with entities or blocks.
+
+**Signature:**
+
+```typescript
+setMaxInteractDistance(distance: number): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+distance
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+The maximum distance in blocks used for the interact raycast. Default is 20.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+