hytopia 0.14.0 → 0.14.1

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

@@ -0,0 +1,74 @@
+<!-- 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; [setEntityColorCorrection](./client.hytopiaui.setentitycolorcorrection.md)
+
+## HytopiaUI.setEntityColorCorrection() method
+
+Applies color tint to an entity on the client only (does not affect other players' view). Use for client-side visual effects like highlighting, damage indicators, or team colors.
+
+**Signature:**
+
+```typescript
+setEntityColorCorrection(entityId: number, color: {
+        r: number;
+        g: number;
+        b: number;
+    } | undefined): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+entityId
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+ID of the entity to tint
+
+
+</td></tr>
+<tr><td>
+
+color
+
+
+</td><td>
+
+{ r: number; g: number; b: number; } \| undefined
+
+
+</td><td>
+
+RGB color multiplier (0-1 range per channel), or `undefined` to remove tint
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+void
+

package/client-docs/client.hytopiaui.setmousesensitivitymultiplier.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; [setMouseSensitivityMultiplier](./client.hytopiaui.setmousesensitivitymultiplier.md)
+
+## HytopiaUI.setMouseSensitivityMultiplier() method
+
+Adjusts the user's base mouse sensitivity for camera rotation. Values above 1.0 increase sensitivity, below 1.0 decrease it. Useful for providing sensitivity settings in your UI options menu.
+
+**Signature:**
+
+```typescript
+setMouseSensitivityMultiplier(multiplier: number): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+multiplier
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+Sensitivity multiplier (`1.0` = default, `2.0` = twice as sensitive, `0.5` = half as sensitive)
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+void
+

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

@@ -0,0 +1,13 @@
+<!-- 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; [three](./client.hytopiaui.three.md)
+
+## HytopiaUI.three property
+
+Access to the THREE.js library for advanced 3D rendering. Use for custom visual effects in your UI.
+
+**Signature:**
+
+```typescript
+get three(): typeof THREE;
+```

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

@@ -0,0 +1,17 @@
+<!-- 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; [unregisterLoadedSceneUITemplates](./client.hytopiaui.unregisterloadedsceneuitemplates.md)
+
+## HytopiaUI.unregisterLoadedSceneUITemplates() method
+
+Removes all custom Scene UI templates. Built-in HYTOPIA templates (prefixed with `hytopia:`<!-- -->) are preserved. Use this when cleaning up your game code on disconnect or world change.
+
+**Signature:**
+
+```typescript
+unregisterLoadedSceneUITemplates(): void;
+```
+**Returns:**
+
+void
+

package/client-docs/client.hytopiaui.unregistersceneuitemplate.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; [unregisterSceneUITemplate](./client.hytopiaui.unregistersceneuitemplate.md)
+
+## HytopiaUI.unregisterSceneUITemplate() method
+
+Removes a registered Scene UI template. The template will no longer be available for new Scene UI instances. Existing instances using this template are not affected.
+
+**Signature:**
+
+```typescript
+unregisterSceneUITemplate(templateId: string): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+templateId
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+Template identifier to remove
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+void
+

package/client-docs/client.md

@@ -0,0 +1,58 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [client](./client.md)
+
+## client package
+
+## Classes
+
+<table><thead><tr><th>
+
+Class
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[HytopiaUI](./client.hytopiaui.md)
+
+
+</td><td>
+
+Global API for interacting with the HYTOPIA game client. Access via the `hytopia` global variable in your client-side HTML UI code.
+
+
+</td></tr>
+</tbody></table>
+
+## Type Aliases
+
+<table><thead><tr><th>
+
+Type Alias
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[TemplateRenderer](./client.templaterenderer.md)
+
+
+</td><td>
+
+A function that creates and returns an HTML element for a Scene UI template.
+
+
+</td></tr>
+</tbody></table>
+

package/client-docs/client.templaterenderer.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [client](./client.md) &gt; [TemplateRenderer](./client.templaterenderer.md)
+
+## TemplateRenderer type
+
+A function that creates and returns an HTML element for a Scene UI template.
+
+**Signature:**
+
+```typescript
+export type TemplateRenderer = (id: number, onState: (callback: OnStateCallback) => void) => HTMLElement;
+```

package/client-docs/index.md

@@ -0,0 +1,30 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md)
+
+## API Reference
+
+## Packages
+
+<table><thead><tr><th>
+
+Package
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[client](./client.md)
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+

package/package.json

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