hytopia 0.14.0 → 0.14.2

package/README.md

@@ -1,7 +1,7 @@
 # HYTOPIA SDK
 
 ## Quick Links
-[Quickstart (Start Here)](#quickstart-start-here) • [Developer Docs](https://dev.hytopia.com/) • [API Reference](./docs/server.md) • [Examples](https://github.com/hytopiagg/sdk-examples) • [Join Our Developer Discord](https://discord.gg/hytopia-developers) • [Report Bugs or Request Features](https://github.com/hytopiagg/sdk/issues)
+[Quickstart (Start Here)](#quickstart-start-here) • [Developer Docs](https://dev.hytopia.com/) • [SDK API Reference](./docs/server.md) • [Client HytopiaUI API Reference](./client-docs/client.hytopiaui.md) • [Examples](https://github.com/hytopiagg/sdk-examples) • [Join Our Developer Discord](https://discord.gg/hytopia-developers) • [Report Bugs or Request Features](https://github.com/hytopiagg/sdk/issues)
 
 ## What is HYTOPIA?
 

package/client-docs/client.hytopiaui.camerafar.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; [cameraFar](./client.hytopiaui.camerafar.md)
+
+## HytopiaUI.cameraFar property
+
+Maximum render distance of the camera in world units. Objects beyond this distance are not rendered.
+
+**Signature:**
+
+```typescript
+get cameraFar(): number;
+```

package/client-docs/client.hytopiaui.cameranear.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; [cameraNear](./client.hytopiaui.cameranear.md)
+
+## HytopiaUI.cameraNear property
+
+Minimum render distance of the camera in world units. Objects closer than this distance are not rendered.
+
+**Signature:**
+
+```typescript
+get cameraNear(): number;
+```

package/client-docs/client.hytopiaui.filterprofanity.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; [filterProfanity](./client.hytopiaui.filterprofanity.md)
+
+## HytopiaUI.filterProfanity() method
+
+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).
+
+**Signature:**
+
+```typescript
+filterProfanity(text: string): string;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+text
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+Text to filter
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+string
+
+Filtered text with profanity replaced by asterisks
+

package/client-docs/client.hytopiaui.getsceneuitemplaterenderer.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; [getSceneUITemplateRenderer](./client.hytopiaui.getsceneuitemplaterenderer.md)
+
+## HytopiaUI.getSceneUITemplateRenderer() method
+
+Retrieves a registered Scene UI template renderer function.
+
+**Signature:**
+
+```typescript
+getSceneUITemplateRenderer(templateId: string): TemplateRenderer | undefined;
+```
+
+## 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 look up
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+[TemplateRenderer](./client.templaterenderer.md) \| undefined
+
+Template renderer function if found, `undefined` otherwise
+

package/client-docs/client.hytopiaui.gltfloader.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; [gltfLoader](./client.hytopiaui.gltfloader.md)
+
+## HytopiaUI.gltfLoader property
+
+Access to a THREE.js GLTFLoader instance for loading 3D models, useful if you want to render models in your UI.
+
+**Signature:**
+
+```typescript
+get gltfLoader(): typeof GLTFLoader;
+```

package/client-docs/client.hytopiaui.hasprofanity.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; [hasProfanity](./client.hytopiaui.hasprofanity.md)
+
+## HytopiaUI.hasProfanity() method
+
+Checks if text contains inappropriate language. Useful for validating input before sending to the server.
+
+**Signature:**
+
+```typescript
+hasProfanity(text: string): boolean;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+text
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+Text to check
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+boolean
+
+`true` if profanity is detected, `false` otherwise
+

package/client-docs/client.hytopiaui.hassceneuitemplaterenderer.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; [hasSceneUITemplateRenderer](./client.hytopiaui.hassceneuitemplaterenderer.md)
+
+## HytopiaUI.hasSceneUITemplateRenderer() method
+
+Checks whether a Scene UI template is currently registered.
+
+**Signature:**
+
+```typescript
+hasSceneUITemplateRenderer(templateId: string): boolean;
+```
+
+## 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 check
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+boolean
+
+`true` if the template is registered, `false` otherwise
+

package/client-docs/client.hytopiaui.ismobile.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; [isMobile](./client.hytopiaui.ismobile.md)
+
+## HytopiaUI.isMobile property
+
+Detects if the player is on a mobile device. Use this to adjust UI layout or controls, etc.
+
+**Signature:**
+
+```typescript
+get isMobile(): boolean;
+```

package/client-docs/client.hytopiaui.lockpointer.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; [lockPointer](./client.hytopiaui.lockpointer.md)
+
+## 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.
+
+**Signature:**
+
+```typescript
+lockPointer(lock: boolean, maintainInput?: boolean): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+lock
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+`true` to lock pointer and hide cursor, `false` to unlock and show cursor
+
+
+</td></tr>
+<tr><td>
+
+maintainInput
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+_(Optional)_ When `true`<!-- -->, keyboard movement/inputs for gameplay still work while pointer is unlocked (default: `false`<!-- -->)
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+void
+