hytopia 0.14.0 → 0.14.2

package/client-docs/client.hytopiaui.md

@@ -0,0 +1,374 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [client](./client.md) &gt; [HytopiaUI](./client.hytopiaui.md)
+
+## HytopiaUI class
+
+Global API for interacting with the HYTOPIA game client. Access via the `hytopia` global variable in your client-side HTML UI code.
+
+**Signature:**
+
+```typescript
+export declare class HytopiaUI 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[cameraFar](./client.hytopiaui.camerafar.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+Maximum render distance of the camera in world units. Objects beyond this distance are not rendered.
+
+
+</td></tr>
+<tr><td>
+
+[cameraNear](./client.hytopiaui.cameranear.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+Minimum render distance of the camera in world units. Objects closer than this distance are not rendered.
+
+
+</td></tr>
+<tr><td>
+
+[gltfLoader](./client.hytopiaui.gltfloader.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+typeof GLTFLoader
+
+
+</td><td>
+
+Access to a THREE.js GLTFLoader instance for loading 3D models, useful if you want to render models in your UI.
+
+
+</td></tr>
+<tr><td>
+
+[isMobile](./client.hytopiaui.ismobile.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+Detects if the player is on a mobile device. Use this to adjust UI layout or controls, etc.
+
+
+</td></tr>
+<tr><td>
+
+[three](./client.hytopiaui.three.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+typeof THREE
+
+
+</td><td>
+
+Access to the THREE.js library for advanced 3D rendering. Use for custom visual effects in your UI.
+
+
+</td></tr>
+</tbody></table>
+
+## Methods
+
+<table><thead><tr><th>
+
+Method
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[filterProfanity(text)](./client.hytopiaui.filterprofanity.md)
+
+
+</td><td>
+
+
+</td><td>
+
+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>
+
+[getSceneUITemplateRenderer(templateId)](./client.hytopiaui.getsceneuitemplaterenderer.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Retrieves a registered Scene UI template renderer function.
+
+
+</td></tr>
+<tr><td>
+
+[hasProfanity(text)](./client.hytopiaui.hasprofanity.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Checks if text contains inappropriate language. Useful for validating input before sending to the server.
+
+
+</td></tr>
+<tr><td>
+
+[hasSceneUITemplateRenderer(templateId)](./client.hytopiaui.hassceneuitemplaterenderer.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Checks whether a Scene UI template is currently registered.
+
+
+</td></tr>
+<tr><td>
+
+[lockPointer(lock, maintainInput)](./client.hytopiaui.lockpointer.md)
+
+
+</td><td>
+
+
+</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.
+
+
+</td></tr>
+<tr><td>
+
+[offAllData()](./client.hytopiaui.offalldata.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Removes all registered data event listeners.
+
+
+</td></tr>
+<tr><td>
+
+[offData(callback)](./client.hytopiaui.offdata.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Removes a specific data event listener. Pass the same callback function used in `onData()`<!-- -->.
+
+
+</td></tr>
+<tr><td>
+
+[onData(callback)](./client.hytopiaui.ondata.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Registers a listener for data received by the server from `player.ui.sendData()`<!-- -->.
+
+
+</td></tr>
+<tr><td>
+
+[pressInput(input, pressed)](./client.hytopiaui.pressinput.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Simulates player input programmatically. Useful for creating custom UI controls that trigger game actions, such as for mobile UI buttons.
+
+
+</td></tr>
+<tr><td>
+
+[registerSceneUITemplate(templateId, templateRenderer)](./client.hytopiaui.registersceneuitemplate.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Registers a custom Scene UI template that will instantiate when a SceneUI on the server for the given templateId is loaded. Templates define how your UI should render for each Scene UI instance created by the server.
+
+
+</td></tr>
+<tr><td>
+
+[sendData(data)](./client.hytopiaui.senddata.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Sends data from your UI to the game server. The server receives this via `player.ui.on(PlayerUIEvent.DATA, callback)`<!-- -->. Use this to notify the server of player actions taken in your custom UI.
+
+
+</td></tr>
+<tr><td>
+
+[setEntityColorCorrection(entityId, color)](./client.hytopiaui.setentitycolorcorrection.md)
+
+
+</td><td>
+
+
+</td><td>
+
+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.
+
+
+</td></tr>
+<tr><td>
+
+[setMouseSensitivityMultiplier(multiplier)](./client.hytopiaui.setmousesensitivitymultiplier.md)
+
+
+</td><td>
+
+
+</td><td>
+
+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.
+
+
+</td></tr>
+<tr><td>
+
+[unregisterLoadedSceneUITemplates()](./client.hytopiaui.unregisterloadedsceneuitemplates.md)
+
+
+</td><td>
+
+
+</td><td>
+
+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.
+
+
+</td></tr>
+<tr><td>
+
+[unregisterSceneUITemplate(templateId)](./client.hytopiaui.unregistersceneuitemplate.md)
+
+
+</td><td>
+
+
+</td><td>
+
+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.
+
+
+</td></tr>
+</tbody></table>
+

package/client-docs/client.hytopiaui.offalldata.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; [offAllData](./client.hytopiaui.offalldata.md)
+
+## HytopiaUI.offAllData() method
+
+Removes all registered data event listeners.
+
+**Signature:**
+
+```typescript
+offAllData(): void;
+```
+**Returns:**
+
+void
+

package/client-docs/client.hytopiaui.offdata.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; [offData](./client.hytopiaui.offdata.md)
+
+## HytopiaUI.offData() method
+
+Removes a specific data event listener. Pass the same callback function used in `onData()`<!-- -->.
+
+**Signature:**
+
+```typescript
+offData(callback: (data: object) => void): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+callback
+
+
+</td><td>
+
+(data: object) =&gt; void
+
+
+</td><td>
+
+The callback function to remove
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+void
+

package/client-docs/client.hytopiaui.ondata.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; [onData](./client.hytopiaui.ondata.md)
+
+## HytopiaUI.onData() method
+
+Registers a listener for data received by the server from `player.ui.sendData()`<!-- -->.
+
+**Signature:**
+
+```typescript
+onData(callback: (data: object) => void): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+callback
+
+
+</td><td>
+
+(data: object) =&gt; void
+
+
+</td><td>
+
+Function to call when data is received from the server.
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+void
+

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

@@ -0,0 +1,70 @@
+<!-- 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; [pressInput](./client.hytopiaui.pressinput.md)
+
+## HytopiaUI.pressInput() method
+
+Simulates player input programmatically. Useful for creating custom UI controls that trigger game actions, such as for mobile UI buttons.
+
+**Signature:**
+
+```typescript
+pressInput(input: string, pressed: boolean): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+input
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+Input name (e.g., 'forward', 'backward', 'left', 'right', 'jump', 'sprint')
+
+
+</td></tr>
+<tr><td>
+
+pressed
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+`true` to press and hold the input, `false` to release it
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+void
+

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

@@ -0,0 +1,70 @@
+<!-- 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; [registerSceneUITemplate](./client.hytopiaui.registersceneuitemplate.md)
+
+## HytopiaUI.registerSceneUITemplate() method
+
+Registers a custom Scene UI template that will instantiate when a SceneUI on the server for the given templateId is loaded. Templates define how your UI should render for each Scene UI instance created by the server.
+
+**Signature:**
+
+```typescript
+registerSceneUITemplate(templateId: string, templateRenderer: TemplateRenderer): 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>
+
+Unique identifier for this template (must match the templateId used server-side when creating a SceneUI)
+
+
+</td></tr>
+<tr><td>
+
+templateRenderer
+
+
+</td><td>
+
+[TemplateRenderer](./client.templaterenderer.md)
+
+
+</td><td>
+
+Function that creates and returns the HTML element for this UI. This is effectively the factory function.
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+void
+

package/client-docs/client.hytopiaui.senddata.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; [sendData](./client.hytopiaui.senddata.md)
+
+## HytopiaUI.sendData() method
+
+Sends data from your UI to the game server. The server receives this via `player.ui.on(PlayerUIEvent.DATA, callback)`<!-- -->. Use this to notify the server of player actions taken in your custom UI.
+
+**Signature:**
+
+```typescript
+sendData(data: object): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+data
+
+
+</td><td>
+
+object
+
+
+</td><td>
+
+Data object to send to the server
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+void
+