npm - hytopia - Versions diffs - 0.1.47 → 0.1.48 - Mend

hytopia 0.1.47 → 0.1.48

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (23) hide show

package/docs/server.md +0 -33
package/docs/server.player.md +1 -1
package/docs/server.simulation.enabledebugraycasting.md +53 -0
package/docs/server.simulation.enabledebugrendering.md +1 -1
package/docs/server.simulation.isdebugraycastingenabled.md +13 -0
package/docs/server.simulation.md +36 -1
package/package.json +1 -1
package/server.api.json +80 -407
package/server.d.ts +12 -20
package/server.js +80 -80
package/docs/server.playerui.load.md +0 -53
package/docs/server.playerui.md +0 -132
package/docs/server.playerui.ondata.md +0 -18
package/docs/server.playerui.player.md +0 -13
package/docs/server.playerui.senddata.md +0 -53
package/docs/server.playeruieventpayload.load.htmluri.md +0 -11
package/docs/server.playeruieventpayload.load.md +0 -70
package/docs/server.playeruieventpayload.load.playerui.md +0 -11
package/docs/server.playeruieventpayload.md +0 -46
package/docs/server.playeruieventpayload.senddata.data.md +0 -11
package/docs/server.playeruieventpayload.senddata.md +0 -70
package/docs/server.playeruieventpayload.senddata.playerui.md +0 -11
package/docs/server.playeruieventtype.md +0 -61

package/docs/server.playerui.load.md DELETED Viewed

@@ -1,53 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [server](./server.md) &gt; [PlayerUI](./server.playerui.md) &gt; [load](./server.playerui.load.md)
-## PlayerUI.load() method
-Loads client UI for the player.
-**Signature:**
-```typescript
-load(htmlUri: string): void;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-htmlUri
-</td><td>
-string
-</td><td>
-The ui html uri to load.
-</td></tr>
-</tbody></table>
-**Returns:**
-void

package/docs/server.playerui.md DELETED Viewed

@@ -1,132 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [server](./server.md) &gt; [PlayerUI](./server.playerui.md)
-## PlayerUI class
-The UI for a player.
-**Signature:**
-```typescript
-export default class PlayerUI
-```
-## Remarks
-UI allows control of all in-game overlays a player sees. UI is controlled by HTML, CSS and JavaScript files you provide in your `assets` folder.
-The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `PlayerUI` class.
-## Properties
-<table><thead><tr><th>
-Property
-</th><th>
-Modifiers
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[onData?](./server.playerui.ondata.md)
-</td><td>
-</td><td>
-(playerUI: [PlayerUI](./server.playerui.md)<!-- -->, data: object) =&gt; void
-</td><td>
-_(Optional)_ A function that is called when the player's client UI sends data to the server.
-</td></tr>
-<tr><td>
-[player](./server.playerui.player.md)
-</td><td>
-`readonly`
-</td><td>
-[Player](./server.player.md)
-</td><td>
-The player that the UI belongs to.
-</td></tr>
-</tbody></table>
-## Methods
-<table><thead><tr><th>
-Method
-</th><th>
-Modifiers
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[load(htmlUri)](./server.playerui.load.md)
-</td><td>
-</td><td>
-Loads client UI for the player.
-</td></tr>
-<tr><td>
-[sendData(data)](./server.playerui.senddata.md)
-</td><td>
-</td><td>
-Sends data to the player's client UI.
-</td></tr>
-</tbody></table>

package/docs/server.playerui.ondata.md DELETED Viewed

@@ -1,18 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [server](./server.md) &gt; [PlayerUI](./server.playerui.md) &gt; [onData](./server.playerui.ondata.md)
-## PlayerUI.onData property
-A function that is called when the player's client UI sends data to the server.
-**Signature:**
-```typescript
-onData?: (playerUI: PlayerUI, data: object) => void;
-```
-## Remarks
-Data sent is an object of any shape defined by you and controlled with invocations of `hytopia.ui.sendData()` from your loaded client UI files.

package/docs/server.playerui.player.md DELETED Viewed

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [server](./server.md) &gt; [PlayerUI](./server.playerui.md) &gt; [player](./server.playerui.player.md)
-## PlayerUI.player property
-The player that the UI belongs to.
-**Signature:**
-```typescript
-readonly player: Player;
-```

package/docs/server.playerui.senddata.md DELETED Viewed

@@ -1,53 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [server](./server.md) &gt; [PlayerUI](./server.playerui.md) &gt; [sendData](./server.playerui.senddata.md)
-## PlayerUI.sendData() method
-Sends data to the player's client 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>
-The data to send to the client UI.
-</td></tr>
-</tbody></table>
-**Returns:**
-void

package/docs/server.playeruieventpayload.load.htmluri.md DELETED Viewed

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [server](./server.md) &gt; [PlayerUIEventPayload](./server.playeruieventpayload.md) &gt; [Load](./server.playeruieventpayload.load.md) &gt; [htmlUri](./server.playeruieventpayload.load.htmluri.md)
-## PlayerUIEventPayload.Load.htmlUri property
-**Signature:**
-```typescript
-htmlUri: string;
-```

package/docs/server.playeruieventpayload.load.md DELETED Viewed

@@ -1,70 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [server](./server.md) &gt; [PlayerUIEventPayload](./server.playeruieventpayload.md) &gt; [Load](./server.playeruieventpayload.load.md)
-## PlayerUIEventPayload.Load interface
-**Signature:**
-```typescript
-interface Load
-```
-## Properties
-<table><thead><tr><th>
-Property
-</th><th>
-Modifiers
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[htmlUri](./server.playeruieventpayload.load.htmluri.md)
-</td><td>
-</td><td>
-string
-</td><td>
-</td></tr>
-<tr><td>
-[playerUI](./server.playeruieventpayload.load.playerui.md)
-</td><td>
-</td><td>
-[PlayerUI](./server.playerui.md)
-</td><td>
-</td></tr>
-</tbody></table>

package/docs/server.playeruieventpayload.load.playerui.md DELETED Viewed

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [server](./server.md) &gt; [PlayerUIEventPayload](./server.playeruieventpayload.md) &gt; [Load](./server.playeruieventpayload.load.md) &gt; [playerUI](./server.playeruieventpayload.load.playerui.md)
-## PlayerUIEventPayload.Load.playerUI property
-**Signature:**
-```typescript
-playerUI: PlayerUI;
-```

package/docs/server.playeruieventpayload.md DELETED Viewed

@@ -1,46 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [server](./server.md) &gt; [PlayerUIEventPayload](./server.playeruieventpayload.md)
-## PlayerUIEventPayload namespace
-Payloads for events a PlayerUI instance can emit.
-**Signature:**
-```typescript
-export declare namespace PlayerUIEventPayload
-```
-## Interfaces
-<table><thead><tr><th>
-Interface
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[Load](./server.playeruieventpayload.load.md)
-</td><td>
-</td></tr>
-<tr><td>
-[SendData](./server.playeruieventpayload.senddata.md)
-</td><td>
-</td></tr>
-</tbody></table>

package/docs/server.playeruieventpayload.senddata.data.md DELETED Viewed

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [server](./server.md) &gt; [PlayerUIEventPayload](./server.playeruieventpayload.md) &gt; [SendData](./server.playeruieventpayload.senddata.md) &gt; [data](./server.playeruieventpayload.senddata.data.md)
-## PlayerUIEventPayload.SendData.data property
-**Signature:**
-```typescript
-data: object;
-```

package/docs/server.playeruieventpayload.senddata.md DELETED Viewed

@@ -1,70 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [server](./server.md) &gt; [PlayerUIEventPayload](./server.playeruieventpayload.md) &gt; [SendData](./server.playeruieventpayload.senddata.md)
-## PlayerUIEventPayload.SendData interface
-**Signature:**
-```typescript
-interface SendData
-```
-## Properties
-<table><thead><tr><th>
-Property
-</th><th>
-Modifiers
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[data](./server.playeruieventpayload.senddata.data.md)
-</td><td>
-</td><td>
-object
-</td><td>
-</td></tr>
-<tr><td>
-[playerUI](./server.playeruieventpayload.senddata.playerui.md)
-</td><td>
-</td><td>
-[PlayerUI](./server.playerui.md)
-</td><td>
-</td></tr>
-</tbody></table>

package/docs/server.playeruieventpayload.senddata.playerui.md DELETED Viewed

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [server](./server.md) &gt; [PlayerUIEventPayload](./server.playeruieventpayload.md) &gt; [SendData](./server.playeruieventpayload.senddata.md) &gt; [playerUI](./server.playeruieventpayload.senddata.playerui.md)
-## PlayerUIEventPayload.SendData.playerUI property
-**Signature:**
-```typescript
-playerUI: PlayerUI;
-```

package/docs/server.playeruieventtype.md DELETED Viewed

@@ -1,61 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [server](./server.md) &gt; [PlayerUIEventType](./server.playeruieventtype.md)
-## PlayerUIEventType enum
-Event types a
-**Signature:**
-```typescript
-export declare enum PlayerUIEventType
-```
-## Enumeration Members
-<table><thead><tr><th>
-Member
-</th><th>
-Value
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-LOAD
-</td><td>
-`"PLAYER_UI.LOAD"`
-</td><td>
-</td></tr>
-<tr><td>
-SEND\_DATA
-</td><td>
-`"PLAYER_UI.SEND_DATA"`
-</td><td>
-</td></tr>
-</tbody></table>