hytopia 0.1.45 → 0.1.47

package/README.md

@@ -5,7 +5,7 @@
 
 ## What is HYTOPIA?
 
-![HYTOPIA Banner](./readme/assets/banner-2.jpeg)
+![HYTOPIA Banner](./readme/assets/banner.jpeg)
 
 HYTOPIA is a modern games platform inspired by Minecraft, Roblox, and Rec Room.
 

package/docs/server.md

@@ -225,6 +225,17 @@ Represents an entity controlled by a player in a world.
 Manages all connected players in a game server.
 
 
+</td></tr>
+<tr><td>
+
+[PlayerUI](./server.playerui.md)
+
+
+</td><td>
+
+The UI for a player.
+
+
 </td></tr>
 <tr><td>
 
@@ -473,6 +484,17 @@ Event types a PlayerCamera can emit.
 Event types a Player can emit.
 
 
+</td></tr>
+<tr><td>
+
+[PlayerUIEventType](./server.playeruieventtype.md)
+
+
+</td><td>
+
+Event types a
+
+
 </td></tr>
 <tr><td>
 
@@ -804,6 +826,17 @@ Payloads for events a PlayerCamera can emit.
 Payloads for events a Player can emit.
 
 
+</td></tr>
+<tr><td>
+
+[PlayerUIEventPayload](./server.playeruieventpayload.md)
+
+
+</td><td>
+
+Payloads for events a PlayerUI instance can emit.
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.player.md

@@ -124,6 +124,27 @@ Readonly&lt;[PlayerOrientationState](./server.playerorientationstate.md)<!-- -->
 The current [PlayerOrientationState](./server.playerorientationstate.md) of the player.
 
 
+</td></tr>
+<tr><td>
+
+[ui](./server.player.ui.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+[PlayerUI](./server.playerui.md)
+
+
+</td><td>
+
+The UI for the player.
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.player.ui.md

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

package/docs/server.playerui.load.md

@@ -0,0 +1,53 @@
+<!-- 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

@@ -0,0 +1,132 @@
+<!-- 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

@@ -0,0 +1,18 @@
+<!-- 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

@@ -0,0 +1,13 @@
+<!-- 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

@@ -0,0 +1,53 @@
+<!-- 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

@@ -0,0 +1,11 @@
+<!-- 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

@@ -0,0 +1,70 @@
+<!-- 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

@@ -0,0 +1,11 @@
+<!-- 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

@@ -0,0 +1,46 @@
+<!-- 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

@@ -0,0 +1,11 @@
+<!-- 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

@@ -0,0 +1,70 @@
+<!-- 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

@@ -0,0 +1,11 @@
+<!-- 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

@@ -0,0 +1,61 @@
+<!-- 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>