hytopia 0.1.48 → 0.1.50

package/bin/scripts.js

@@ -45,7 +45,7 @@ const path = require('path');
         return;
       }
 
-      fs.cpSync(templateDir, destDir, { recursive: true });
+      fs.cpSync(templateDir, destDir, { recursive: true, force: false });
     } else {
       // Init from boilerplate
       console.log('🧑‍💻 Initializing project with boilerplate...');

package/docs/server.basecharactercontroller.md

@@ -115,7 +115,7 @@ _(Optional)_ A callback function for when the controller ticks.
 </td></tr>
 <tr><td>
 
-[onTickPlayerMovement?](./server.basecharactercontroller.ontickplayermovement.md)
+[onTickWithPlayerInput?](./server.basecharactercontroller.ontickwithplayerinput.md)
 
 
 </td><td>
@@ -123,12 +123,12 @@ _(Optional)_ A callback function for when the controller ticks.
 
 </td><td>
 
-(inputState: [PlayerInputState](./server.playerinputstate.md)<!-- -->, orientationState: [PlayerOrientationState](./server.playerorientationstate.md)<!-- -->, deltaTimeMs: number) =&gt; void
+(input: [PlayerInput](./server.playerinput.md)<!-- -->, cameraOrientation: [PlayerCameraOrientation](./server.playercameraorientation.md)<!-- -->, deltaTimeMs: number) =&gt; void
 
 
 </td><td>
 
-_(Optional)_ A callback function for when the controller ticks player movement.
+_(Optional)_ A callback function for when the controller ticks player movement. This is called every tick by a PlayerEntity with a character controller.
 
 
 </td></tr>
@@ -182,7 +182,7 @@ Override this method to handle entity movements based on your character controll
 </td></tr>
 <tr><td>
 
-[tickPlayerMovement(inputState, orientationState, deltaTimeMs)](./server.basecharactercontroller.tickplayermovement.md)
+[tickWithPlayerInput(input, cameraOrientation, deltaTimeMs)](./server.basecharactercontroller.tickwithplayerinput.md)
 
 
 </td><td>

package/docs/server.basecharactercontroller.ontickwithplayerinput.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; [BaseCharacterController](./server.basecharactercontroller.md) &gt; [onTickWithPlayerInput](./server.basecharactercontroller.ontickwithplayerinput.md)
+
+## BaseCharacterController.onTickWithPlayerInput property
+
+A callback function for when the controller ticks player movement. This is called every tick by a PlayerEntity with a character controller.
+
+**Signature:**
+
+```typescript
+onTickWithPlayerInput?: (input: PlayerInput, cameraOrientation: PlayerCameraOrientation, deltaTimeMs: number) => void;
+```

package/docs/{server.basecharactercontroller.tickplayermovement.md → server.basecharactercontroller.tickwithplayerinput.md}

@@ -1,15 +1,15 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [server](./server.md) &gt; [BaseCharacterController](./server.basecharactercontroller.md) &gt; [tickPlayerMovement](./server.basecharactercontroller.tickplayermovement.md)
+[Home](./index.md) &gt; [server](./server.md) &gt; [BaseCharacterController](./server.basecharactercontroller.md) &gt; [tickWithPlayerInput](./server.basecharactercontroller.tickwithplayerinput.md)
 
-## BaseCharacterController.tickPlayerMovement() method
+## BaseCharacterController.tickWithPlayerInput() method
 
 Override this method to handle entity movements based on player input for your character controller.
 
 **Signature:**
 
 ```typescript
-tickPlayerMovement(inputState: PlayerInputState, orientationState: PlayerOrientationState, deltaTimeMs: number): void;
+tickWithPlayerInput(input: PlayerInput, cameraOrientation: PlayerCameraOrientation, deltaTimeMs: number): void;
 ```
 
 ## Parameters
@@ -32,12 +32,12 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
-inputState
+input
 
 
 </td><td>
 
-[PlayerInputState](./server.playerinputstate.md)
+[PlayerInput](./server.playerinput.md)
 
 
 </td><td>
@@ -48,17 +48,17 @@ The current input state of the player.
 </td></tr>
 <tr><td>
 
-orientationState
+cameraOrientation
 
 
 </td><td>
 
-[PlayerOrientationState](./server.playerorientationstate.md)
+[PlayerCameraOrientation](./server.playercameraorientation.md)
 
 
 </td><td>
 
-The current orientation state of the player.
+The current camera orientation state of the player.
 
 
 </td></tr>

package/docs/server.defaultcharactercontroller.md

@@ -304,7 +304,7 @@ Creates the colliders for the character controller, overriding the default imple
 </td></tr>
 <tr><td>
 
-[tickPlayerMovement(inputState, orientationState, deltaTimeMs)](./server.defaultcharactercontroller.tickplayermovement.md)
+[tickWithPlayerInput(input, cameraOrientation, deltaTimeMs)](./server.defaultcharactercontroller.tickwithplayerinput.md)
 
 
 </td><td>

package/docs/{server.defaultcharactercontroller.tickplayermovement.md → server.defaultcharactercontroller.tickwithplayerinput.md}

@@ -1,15 +1,15 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [server](./server.md) &gt; [DefaultCharacterController](./server.defaultcharactercontroller.md) &gt; [tickPlayerMovement](./server.defaultcharactercontroller.tickplayermovement.md)
+[Home](./index.md) &gt; [server](./server.md) &gt; [DefaultCharacterController](./server.defaultcharactercontroller.md) &gt; [tickWithPlayerInput](./server.defaultcharactercontroller.tickwithplayerinput.md)
 
-## DefaultCharacterController.tickPlayerMovement() method
+## DefaultCharacterController.tickWithPlayerInput() method
 
 Ticks the player movement for the character controller, overriding the default implementation.
 
 **Signature:**
 
 ```typescript
-tickPlayerMovement(inputState: PlayerInputState, orientationState: PlayerOrientationState, deltaTimeMs: number): void;
+tickWithPlayerInput(input: PlayerInput, cameraOrientation: PlayerCameraOrientation, deltaTimeMs: number): void;
 ```
 
 ## Parameters
@@ -32,12 +32,12 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
-inputState
+input
 
 
 </td><td>
 
-[PlayerInputState](./server.playerinputstate.md)
+[PlayerInput](./server.playerinput.md)
 
 
 </td><td>
@@ -48,17 +48,17 @@ The current input state of the player.
 </td></tr>
 <tr><td>
 
-orientationState
+cameraOrientation
 
 
 </td><td>
 
-[PlayerOrientationState](./server.playerorientationstate.md)
+[PlayerCameraOrientation](./server.playercameraorientation.md)
 
 
 </td><td>
 
-The current orientation state of the player.
+The current camera orientation state of the player.
 
 
 </td></tr>

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>
 
@@ -871,7 +904,7 @@ The port the server will run on. You can override this in your .env by setting P
 
 </td><td>
 
-The input keys that can be included in the PlayerInputState.
+The input keys that are included in the PlayerInput.
 
 
 </td></tr>
@@ -1002,23 +1035,23 @@ Options for the [SimpleCharacterController.move()](./server.simplecharactercontr
 </td></tr>
 <tr><td>
 
-[PlayerInputState](./server.playerinputstate.md)
+[PlayerCameraOrientation](./server.playercameraorientation.md)
 
 
 </td><td>
 
-The input state of a Player; keys from SUPPORTED\_INPUT\_KEYS.
+The camera orientation state of a Player.
 
 
 </td></tr>
 <tr><td>
 
-[PlayerOrientationState](./server.playerorientationstate.md)
+[PlayerInput](./server.playerinput.md)
 
 
 </td><td>
 
-The camera orientation state of a Player.
+The input state of a Player; keys from SUPPORTED\_INPUT\_KEYS.
 
 
 </td></tr>

package/docs/server.player.cameraorientation.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; [cameraOrientation](./server.player.cameraorientation.md)
+
+## Player.cameraOrientation property
+
+The current [PlayerCameraOrientation](./server.playercameraorientation.md) of the player.
+
+**Signature:**
+
+```typescript
+get cameraOrientation(): Readonly<PlayerCameraOrientation>;
+```

package/docs/server.player.input.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; [input](./server.player.input.md)
+
+## Player.input property
+
+The current [PlayerInput](./server.playerinput.md) of the player.
+
+**Signature:**
+
+```typescript
+get input(): Readonly<PlayerInput>;
+```

package/docs/server.player.md

@@ -64,7 +64,7 @@ The camera for the player.
 </td></tr>
 <tr><td>
 
-[id](./server.player.id.md)
+[cameraOrientation](./server.player.cameraorientation.md)
 
 
 </td><td>
@@ -74,18 +74,18 @@ The camera for the player.
 
 </td><td>
 
-number
+Readonly&lt;[PlayerCameraOrientation](./server.playercameraorientation.md)<!-- -->&gt;
 
 
 </td><td>
 
-The unique identifier for the player.
+The current [PlayerCameraOrientation](./server.playercameraorientation.md) of the player.
 
 
 </td></tr>
 <tr><td>
 
-[inputState](./server.player.inputstate.md)
+[id](./server.player.id.md)
 
 
 </td><td>
@@ -95,18 +95,18 @@ The unique identifier for the player.
 
 </td><td>
 
-Readonly&lt;[PlayerInputState](./server.playerinputstate.md)<!-- -->&gt;
+number
 
 
 </td><td>
 
-The current [PlayerInputState](./server.playerinputstate.md) of the player.
+The unique identifier for the player.
 
 
 </td></tr>
 <tr><td>
 
-[orientationState](./server.player.orientationstate.md)
+[input](./server.player.input.md)
 
 
 </td><td>
@@ -116,12 +116,12 @@ The current [PlayerInputState](./server.playerinputstate.md) of the player.
 
 </td><td>
 
-Readonly&lt;[PlayerOrientationState](./server.playerorientationstate.md)<!-- -->&gt;
+Readonly&lt;[PlayerInput](./server.playerinput.md)<!-- -->&gt;
 
 
 </td><td>
 
-The current [PlayerOrientationState](./server.playerorientationstate.md) of the player.
+The current [PlayerInput](./server.playerinput.md) of the player.
 
 
 </td></tr>
@@ -137,7 +137,7 @@ The current [PlayerOrientationState](./server.playerorientationstate.md) of the
 
 </td><td>
 
-PlayerUI
+[PlayerUI](./server.playerui.md)
 
 
 </td><td>

package/docs/server.playercameraorientation.md

@@ -0,0 +1,16 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [PlayerCameraOrientation](./server.playercameraorientation.md)
+
+## PlayerCameraOrientation type
+
+The camera orientation state of a Player.
+
+**Signature:**
+
+```typescript
+export type PlayerCameraOrientation = {
+    pitch: number;
+    yaw: number;
+};
+```

package/docs/server.playerinput.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; [PlayerInput](./server.playerinput.md)
+
+## PlayerInput type
+
+The input state of a Player; keys from SUPPORTED\_INPUT\_KEYS.
+
+**Signature:**
+
+```typescript
+export type PlayerInput = Partial<Record<keyof InputSchema, boolean>>;
+```

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;
+```