hytopia 0.1.56 → 0.1.57

package/docs/server.playerentitycontroller.md

@@ -0,0 +1,331 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [PlayerEntityController](./server.playerentitycontroller.md)
+
+## PlayerEntityController class
+
+The player entity controller implementation.
+
+**Signature:**
+
+```typescript
+export default class PlayerEntityController extends BaseEntityController 
+```
+**Extends:** [BaseEntityController](./server.baseentitycontroller.md)
+
+## Remarks
+
+This class extends [BaseEntityController](./server.baseentitycontroller.md) and implements the default movement logic for a entity. This is used as the default for players when they join your game. This class may be extended if you'd like to implement additional logic on top of the PlayerEntityController implementation.
+
+## Example
+
+
+```typescript
+// Create a custom entity controller for myEntity, prior to spawning it.
+myEntity.setController(new PlayerEntityController(myEntity, {
+  jumpVelocity: 10,
+  runVelocity: 8,
+  walkVelocity: 4,
+}));
+
+// Spawn the entity in the world.
+myEntity.spawn(world, { x: 53, y: 10, z: 23 });
+```
+
+## Constructors
+
+<table><thead><tr><th>
+
+Constructor
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[(constructor)(options)](./server.playerentitycontroller._constructor_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Constructs a new instance of the `PlayerEntityController` class
+
+
+</td></tr>
+</tbody></table>
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[canJump](./server.playerentitycontroller.canjump.md)
+
+
+</td><td>
+
+
+</td><td>
+
+(playerEntityController: [PlayerEntityController](./server.playerentitycontroller.md)<!-- -->) =&gt; boolean
+
+
+</td><td>
+
+A function allowing custom logic to determine if the entity can jump.
+
+
+</td></tr>
+<tr><td>
+
+[canRun](./server.playerentitycontroller.canrun.md)
+
+
+</td><td>
+
+
+</td><td>
+
+(playerEntityController: [PlayerEntityController](./server.playerentitycontroller.md)<!-- -->) =&gt; boolean
+
+
+</td><td>
+
+A function allowing custom logic to determine if the entity can run.
+
+
+</td></tr>
+<tr><td>
+
+[canWalk](./server.playerentitycontroller.canwalk.md)
+
+
+</td><td>
+
+
+</td><td>
+
+(playerEntityController: [PlayerEntityController](./server.playerentitycontroller.md)<!-- -->) =&gt; boolean
+
+
+</td><td>
+
+A function allowing custom logic to determine if the entity can walk.
+
+
+</td></tr>
+<tr><td>
+
+[isGrounded](./server.playerentitycontroller.isgrounded.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+Whether the entity is grounded.
+
+
+</td></tr>
+<tr><td>
+
+[isOnPlatform](./server.playerentitycontroller.isonplatform.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+Whether the entity is on a platform, a platform is any entity with a kinematic rigid body.
+
+
+</td></tr>
+<tr><td>
+
+[jumpVelocity](./server.playerentitycontroller.jumpvelocity.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+The upward velocity applied to the entity when it jumps.
+
+
+</td></tr>
+<tr><td>
+
+[platform](./server.playerentitycontroller.platform.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+[Entity](./server.entity.md) \| undefined
+
+
+</td><td>
+
+The platform the entity is on, if any.
+
+
+</td></tr>
+<tr><td>
+
+[runVelocity](./server.playerentitycontroller.runvelocity.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+The normalized horizontal velocity applied to the entity when it runs.
+
+
+</td></tr>
+<tr><td>
+
+[walkVelocity](./server.playerentitycontroller.walkvelocity.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+The normalized horizontal velocity applied to the entity when it walks.
+
+
+</td></tr>
+</tbody></table>
+
+## Methods
+
+<table><thead><tr><th>
+
+Method
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[attach(entity)](./server.playerentitycontroller.attach.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Called when the controller is attached to an entity.
+
+
+</td></tr>
+<tr><td>
+
+[spawn(entity)](./server.playerentitycontroller.spawn.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Called when the controlled entity is spawned. In PlayerEntityController, this function is used to create the colliders for the entity for wall and ground detection.
+
+
+</td></tr>
+<tr><td>
+
+[tickWithPlayerInput(entity, input, cameraOrientation, deltaTimeMs)](./server.playerentitycontroller.tickwithplayerinput.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Ticks the player movement for the entity controller, overriding the default implementation.
+
+
+</td></tr>
+</tbody></table>

package/docs/server.playerentitycontroller.platform.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; [PlayerEntityController](./server.playerentitycontroller.md) &gt; [platform](./server.playerentitycontroller.platform.md)
+
+## PlayerEntityController.platform property
+
+The platform the entity is on, if any.
+
+**Signature:**
+
+```typescript
+get platform(): Entity | undefined;
+```

package/docs/server.playerentitycontroller.runvelocity.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; [PlayerEntityController](./server.playerentitycontroller.md) &gt; [runVelocity](./server.playerentitycontroller.runvelocity.md)
+
+## PlayerEntityController.runVelocity property
+
+The normalized horizontal velocity applied to the entity when it runs.
+
+**Signature:**
+
+```typescript
+runVelocity: number;
+```

package/docs/server.playerentitycontroller.spawn.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; [PlayerEntityController](./server.playerentitycontroller.md) &gt; [spawn](./server.playerentitycontroller.spawn.md)
+
+## PlayerEntityController.spawn() method
+
+Called when the controlled entity is spawned. In PlayerEntityController, this function is used to create the colliders for the entity for wall and ground detection.
+
+**Signature:**
+
+```typescript
+spawn(entity: Entity): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+entity
+
+
+</td><td>
+
+[Entity](./server.entity.md)
+
+
+</td><td>
+
+The entity that is spawned.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

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

@@ -1,10 +1,10 @@
 <!-- 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; [tickWithPlayerInput](./server.defaultcharactercontroller.tickwithplayerinput.md)
+[Home](./index.md) &gt; [server](./server.md) &gt; [PlayerEntityController](./server.playerentitycontroller.md) &gt; [tickWithPlayerInput](./server.playerentitycontroller.tickwithplayerinput.md)
 
-## DefaultCharacterController.tickWithPlayerInput() method
+## PlayerEntityController.tickWithPlayerInput() method
 
-Ticks the player movement for the character controller, overriding the default implementation.
+Ticks the player movement for the entity controller, overriding the default implementation.
 
 **Signature:**
 

package/docs/server.playerentitycontroller.walkvelocity.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; [PlayerEntityController](./server.playerentitycontroller.md) &gt; [walkVelocity](./server.playerentitycontroller.walkvelocity.md)
+
+## PlayerEntityController.walkVelocity property
+
+The normalized horizontal velocity applied to the entity when it walks.
+
+**Signature:**
+
+```typescript
+walkVelocity: number;
+```

package/docs/server.playerentitycontrolleroptions.canjump.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; [PlayerEntityControllerOptions](./server.playerentitycontrolleroptions.md) &gt; [canJump](./server.playerentitycontrolleroptions.canjump.md)
+
+## PlayerEntityControllerOptions.canJump property
+
+A function allowing custom logic to determine if the entity can jump.
+
+**Signature:**
+
+```typescript
+canJump?: () => boolean;
+```

package/docs/server.playerentitycontrolleroptions.canrun.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; [PlayerEntityControllerOptions](./server.playerentitycontrolleroptions.md) &gt; [canRun](./server.playerentitycontrolleroptions.canrun.md)
+
+## PlayerEntityControllerOptions.canRun property
+
+A function allowing custom logic to determine if the entity can run.
+
+**Signature:**
+
+```typescript
+canRun?: () => boolean;
+```

package/docs/server.playerentitycontrolleroptions.canwalk.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; [PlayerEntityControllerOptions](./server.playerentitycontrolleroptions.md) &gt; [canWalk](./server.playerentitycontrolleroptions.canwalk.md)
+
+## PlayerEntityControllerOptions.canWalk property
+
+A function allowing custom logic to determine if the entity can walk.
+
+**Signature:**
+
+```typescript
+canWalk?: () => boolean;
+```

package/docs/server.playerentitycontrolleroptions.jumpvelocity.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; [PlayerEntityControllerOptions](./server.playerentitycontrolleroptions.md) &gt; [jumpVelocity](./server.playerentitycontrolleroptions.jumpvelocity.md)
+
+## PlayerEntityControllerOptions.jumpVelocity property
+
+The upward velocity applied to the entity when it jumps.
+
+**Signature:**
+
+```typescript
+jumpVelocity?: number;
+```

package/docs/{server.defaultcharactercontrolleroptions.md → server.playerentitycontrolleroptions.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; [DefaultCharacterControllerOptions](./server.defaultcharactercontrolleroptions.md)
+[Home](./index.md) &gt; [server](./server.md) &gt; [PlayerEntityControllerOptions](./server.playerentitycontrolleroptions.md)
 
-## DefaultCharacterControllerOptions interface
+## PlayerEntityControllerOptions interface
 
-Options for creating a DefaultCharacterController instance.
+Options for creating a PlayerEntityController instance.
 
 **Signature:**
 
 ```typescript
-export interface DefaultCharacterControllerOptions 
+export interface PlayerEntityControllerOptions 
 ```
 
 ## Properties
@@ -37,7 +37,7 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
-[canJump?](./server.defaultcharactercontrolleroptions.canjump.md)
+[canJump?](./server.playerentitycontrolleroptions.canjump.md)
 
 
 </td><td>
@@ -56,7 +56,7 @@ _(Optional)_ A function allowing custom logic to determine if the entity can jum
 </td></tr>
 <tr><td>
 
-[canRun?](./server.defaultcharactercontrolleroptions.canrun.md)
+[canRun?](./server.playerentitycontrolleroptions.canrun.md)
 
 
 </td><td>
@@ -75,7 +75,7 @@ _(Optional)_ A function allowing custom logic to determine if the entity can run
 </td></tr>
 <tr><td>
 
-[canWalk?](./server.defaultcharactercontrolleroptions.canwalk.md)
+[canWalk?](./server.playerentitycontrolleroptions.canwalk.md)
 
 
 </td><td>
@@ -94,7 +94,7 @@ _(Optional)_ A function allowing custom logic to determine if the entity can wal
 </td></tr>
 <tr><td>
 
-[jumpVelocity?](./server.defaultcharactercontrolleroptions.jumpvelocity.md)
+[jumpVelocity?](./server.playerentitycontrolleroptions.jumpvelocity.md)
 
 
 </td><td>
@@ -113,7 +113,7 @@ _(Optional)_ The upward velocity applied to the entity when it jumps.
 </td></tr>
 <tr><td>
 
-[runVelocity?](./server.defaultcharactercontrolleroptions.runvelocity.md)
+[runVelocity?](./server.playerentitycontrolleroptions.runvelocity.md)
 
 
 </td><td>
@@ -132,7 +132,7 @@ _(Optional)_ The normalized horizontal velocity applied to the entity when it ru
 </td></tr>
 <tr><td>
 
-[walkVelocity?](./server.defaultcharactercontrolleroptions.walkvelocity.md)
+[walkVelocity?](./server.playerentitycontrolleroptions.walkvelocity.md)
 
 
 </td><td>

package/docs/server.playerentitycontrolleroptions.runvelocity.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; [PlayerEntityControllerOptions](./server.playerentitycontrolleroptions.md) &gt; [runVelocity](./server.playerentitycontrolleroptions.runvelocity.md)
+
+## PlayerEntityControllerOptions.runVelocity property
+
+The normalized horizontal velocity applied to the entity when it runs.
+
+**Signature:**
+
+```typescript
+runVelocity?: number;
+```

package/docs/server.playerentitycontrolleroptions.walkvelocity.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; [PlayerEntityControllerOptions](./server.playerentitycontrolleroptions.md) &gt; [walkVelocity](./server.playerentitycontrolleroptions.walkvelocity.md)
+
+## PlayerEntityControllerOptions.walkVelocity property
+
+The normalized horizontal velocity applied to the entity when it walks.
+
+**Signature:**
+
+```typescript
+walkVelocity?: number;
+```

package/docs/server.playerui.lockpointer.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; [lockPointer](./server.playerui.lockpointer.md)
+
+## PlayerUI.lockPointer() method
+
+Locks or unlocks the player's mouse pointer.
+
+**Signature:**
+
+```typescript
+lockPointer(lock: 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>
+
+Set true to lock the pointer, false to unlock it.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

package/docs/server.playerui.md

@@ -114,6 +114,20 @@ Description
 Loads client UI for the player.
 
 
+</td></tr>
+<tr><td>
+
+[lockPointer(lock)](./server.playerui.lockpointer.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Locks or unlocks the player's mouse pointer.
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.playeruieventpayload.lockpointer.lock.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; [LockPointer](./server.playeruieventpayload.lockpointer.md) &gt; [lock](./server.playeruieventpayload.lockpointer.lock.md)
+
+## PlayerUIEventPayload.LockPointer.lock property
+
+**Signature:**
+
+```typescript
+lock: boolean;
+```