hytopia 0.14.15 → 0.14.17

package/bin/scripts.js

@@ -158,6 +158,12 @@ function init() {
 function installProjectDependencies() {
   // init project
   execSync('npm init -y --silent --loglevel silent', { stdio: ['ignore', 'ignore', 'inherit'] });
+  
+  // Add various common scripts to the package.json
+  execSync('npm pkg set scripts.build="hytopia build"', { stdio: 'ignore' });
+  execSync('npm pkg set scripts.package="hytopia package"', { stdio: 'ignore' });
+  execSync('npm pkg set scripts.upgrade-assets-library="hytopia upgrade-assets-library"', { stdio: 'ignore' });
+  execSync('npm pkg set scripts.upgrade-project="hytopia upgrade-project"', { stdio: 'ignore' });
 
   // create tsconfig.json, used by build
   fs.writeFileSync('tsconfig.json', JSON.stringify({

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

@@ -0,0 +1,95 @@
+<!-- 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; [connectArrow](./client.hytopiaui.connectarrow.md)
+
+## HytopiaUI.connectArrow() method
+
+Creates an arrow between two points or entities.
+
+**Signature:**
+
+```typescript
+connectArrow(source: number | THREE.Vector3Like, target: number | THREE.Vector3Like, options?: {
+        color?: {
+            r: number;
+            g: number;
+            b: number;
+        };
+        textureUri?: string;
+    }): number;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+source
+
+
+</td><td>
+
+number \| THREE.Vector3Like
+
+
+</td><td>
+
+Source entity ID (number) or position (Vector3Like)
+
+
+</td></tr>
+<tr><td>
+
+target
+
+
+</td><td>
+
+number \| THREE.Vector3Like
+
+
+</td><td>
+
+Target entity ID (number) or position (Vector3Like)
+
+
+</td></tr>
+<tr><td>
+
+options
+
+
+</td><td>
+
+{ color?: { r: number; g: number; b: number; }; textureUri?: string; }
+
+
+</td><td>
+
+_(Optional)_ Optional arrow properties (color, textureUrl)
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+number
+
+The arrow ID
+

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

@@ -0,0 +1,58 @@
+<!-- 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; [disconnectArrow](./client.hytopiaui.disconnectarrow.md)
+
+## HytopiaUI.disconnectArrow() method
+
+Removes an arrow by its ID.
+
+**Signature:**
+
+```typescript
+disconnectArrow(arrowId: number): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+arrowId
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+The arrow ID to remove
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+void
+
+## Exceptions
+
+Error if the arrow ID does not exist
+

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

@@ -0,0 +1,56 @@
+<!-- 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; [getEntityIdByName](./client.hytopiaui.getentityidbyname.md)
+
+## HytopiaUI.getEntityIdByName() method
+
+Finds an entity by its name property and returns its ID. If multiple entities have the same name, returns the first one found.
+
+**Signature:**
+
+```typescript
+getEntityIdByName(name: string): number | undefined;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+name
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+The exact name to search for (case-sensitive)
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+number \| undefined
+
+The entity ID if found, undefined otherwise
+

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

@@ -0,0 +1,19 @@
+<!-- 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; [getPlayerEntityId](./client.hytopiaui.getplayerentityid.md)
+
+## HytopiaUI.getPlayerEntityId() method
+
+Gets the entity ID of the current player's entity. Returns undefined if the player entity is not yet initialized.
+
+**Signature:**
+
+```typescript
+getPlayerEntityId(): number | undefined;
+```
+**Returns:**
+
+number \| undefined
+
+The player's entity ID, or undefined if not available
+

package/client-docs/client.hytopiaui.md

@@ -162,6 +162,34 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
+[connectArrow(source, target, options)](./client.hytopiaui.connectarrow.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Creates an arrow between two points or entities.
+
+
+</td></tr>
+<tr><td>
+
+[disconnectArrow(arrowId)](./client.hytopiaui.disconnectarrow.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Removes an arrow by its ID.
+
+
+</td></tr>
+<tr><td>
+
 [filterProfanity(text)](./client.hytopiaui.filterprofanity.md)
 
 
@@ -173,6 +201,34 @@ Description
 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>
+
+[getEntityIdByName(name)](./client.hytopiaui.getentityidbyname.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Finds an entity by its name property and returns its ID. If multiple entities have the same name, returns the first one found.
+
+
+</td></tr>
+<tr><td>
+
+[getPlayerEntityId()](./client.hytopiaui.getplayerentityid.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Gets the entity ID of the current player's entity. Returns undefined if the player entity is not yet initialized.
+
+
 </td></tr>
 <tr><td>
 

package/package.json

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