hytopia 0.4.4 → 0.5.0-dev1

package/docs/server.playerentitycontroller.spawn.md

@@ -1,53 +0,0 @@
-<!-- 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.playerentitycontroller.stickstoplatforms.md

@@ -1,13 +0,0 @@
-<!-- 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; [sticksToPlatforms](./server.playerentitycontroller.stickstoplatforms.md)
-
-## PlayerEntityController.sticksToPlatforms property
-
-Whether the entity sticks to platforms.
-
-**Signature:**
-
-```typescript
-sticksToPlatforms: boolean;
-```

package/docs/server.playerentitycontroller.walkloopedanimations.md

@@ -1,13 +0,0 @@
-<!-- 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; [walkLoopedAnimations](./server.playerentitycontroller.walkloopedanimations.md)
-
-## PlayerEntityController.walkLoopedAnimations property
-
-The looped animation(s) that will play when the entity is walking.
-
-**Signature:**
-
-```typescript
-walkLoopedAnimations: string[];
-```

package/docs/server.playerentitycontroller.walkvelocity.md

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

@@ -1,13 +0,0 @@
-<!-- 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; [autoCancelMouseLeftClick](./server.playerentitycontrolleroptions.autocancelmouseleftclick.md)
-
-## PlayerEntityControllerOptions.autoCancelMouseLeftClick property
-
-Whether to automatically cancel left click input after first processed tick, defaults to true.
-
-**Signature:**
-
-```typescript
-autoCancelMouseLeftClick?: boolean;
-```

package/docs/server.playerentitycontrolleroptions.canjump.md

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

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

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

@@ -1,13 +0,0 @@
-<!-- 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; [idleLoopedAnimations](./server.playerentitycontrolleroptions.idleloopedanimations.md)
-
-## PlayerEntityControllerOptions.idleLoopedAnimations property
-
-Overrides the animation(s) that will play when the entity is idle.
-
-**Signature:**
-
-```typescript
-idleLoopedAnimations?: string[];
-```

package/docs/server.playerentitycontrolleroptions.interactoneshotanimations.md

@@ -1,13 +0,0 @@
-<!-- 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; [interactOneshotAnimations](./server.playerentitycontrolleroptions.interactoneshotanimations.md)
-
-## PlayerEntityControllerOptions.interactOneshotAnimations property
-
-Overrides the animation(s) that will play when the entity interacts (left click)
-
-**Signature:**
-
-```typescript
-interactOneshotAnimations?: string[];
-```

package/docs/server.playerentitycontrolleroptions.jumponeshotanimations.md

@@ -1,13 +0,0 @@
-<!-- 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; [jumpOneshotAnimations](./server.playerentitycontrolleroptions.jumponeshotanimations.md)
-
-## PlayerEntityControllerOptions.jumpOneshotAnimations property
-
-Overrides the animation(s) that will play when the entity is jumping.
-
-**Signature:**
-
-```typescript
-jumpOneshotAnimations?: string[];
-```

package/docs/server.playerentitycontrolleroptions.jumpvelocity.md

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

@@ -1,285 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [server](./server.md) &gt; [PlayerEntityControllerOptions](./server.playerentitycontrolleroptions.md)
-
-## PlayerEntityControllerOptions interface
-
-Options for creating a PlayerEntityController instance.
-
-**Signature:**
-
-```typescript
-export interface PlayerEntityControllerOptions 
-```
-
-## Properties
-
-<table><thead><tr><th>
-
-Property
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[autoCancelMouseLeftClick?](./server.playerentitycontrolleroptions.autocancelmouseleftclick.md)
-
-
-</td><td>
-
-
-</td><td>
-
-boolean
-
-
-</td><td>
-
-_(Optional)_ Whether to automatically cancel left click input after first processed tick, defaults to true.
-
-
-</td></tr>
-<tr><td>
-
-[canJump?](./server.playerentitycontrolleroptions.canjump.md)
-
-
-</td><td>
-
-
-</td><td>
-
-() =&gt; boolean
-
-
-</td><td>
-
-_(Optional)_ A function allowing custom logic to determine if the entity can jump.
-
-
-</td></tr>
-<tr><td>
-
-[canRun?](./server.playerentitycontrolleroptions.canrun.md)
-
-
-</td><td>
-
-
-</td><td>
-
-() =&gt; boolean
-
-
-</td><td>
-
-_(Optional)_ A function allowing custom logic to determine if the entity can run.
-
-
-</td></tr>
-<tr><td>
-
-[canWalk?](./server.playerentitycontrolleroptions.canwalk.md)
-
-
-</td><td>
-
-
-</td><td>
-
-() =&gt; boolean
-
-
-</td><td>
-
-_(Optional)_ A function allowing custom logic to determine if the entity can walk.
-
-
-</td></tr>
-<tr><td>
-
-[idleLoopedAnimations?](./server.playerentitycontrolleroptions.idleloopedanimations.md)
-
-
-</td><td>
-
-
-</td><td>
-
-string\[\]
-
-
-</td><td>
-
-_(Optional)_ Overrides the animation(s) that will play when the entity is idle.
-
-
-</td></tr>
-<tr><td>
-
-[interactOneshotAnimations?](./server.playerentitycontrolleroptions.interactoneshotanimations.md)
-
-
-</td><td>
-
-
-</td><td>
-
-string\[\]
-
-
-</td><td>
-
-_(Optional)_ Overrides the animation(s) that will play when the entity interacts (left click)
-
-
-</td></tr>
-<tr><td>
-
-[jumpOneshotAnimations?](./server.playerentitycontrolleroptions.jumponeshotanimations.md)
-
-
-</td><td>
-
-
-</td><td>
-
-string\[\]
-
-
-</td><td>
-
-_(Optional)_ Overrides the animation(s) that will play when the entity is jumping.
-
-
-</td></tr>
-<tr><td>
-
-[jumpVelocity?](./server.playerentitycontrolleroptions.jumpvelocity.md)
-
-
-</td><td>
-
-
-</td><td>
-
-number
-
-
-</td><td>
-
-_(Optional)_ The upward velocity applied to the entity when it jumps.
-
-
-</td></tr>
-<tr><td>
-
-[runLoopedAnimations?](./server.playerentitycontrolleroptions.runloopedanimations.md)
-
-
-</td><td>
-
-
-</td><td>
-
-string\[\]
-
-
-</td><td>
-
-_(Optional)_ Overrides the animation(s) that will play when the entity is running.
-
-
-</td></tr>
-<tr><td>
-
-[runVelocity?](./server.playerentitycontrolleroptions.runvelocity.md)
-
-
-</td><td>
-
-
-</td><td>
-
-number
-
-
-</td><td>
-
-_(Optional)_ The normalized horizontal velocity applied to the entity when it runs.
-
-
-</td></tr>
-<tr><td>
-
-[sticksToPlatforms?](./server.playerentitycontrolleroptions.stickstoplatforms.md)
-
-
-</td><td>
-
-
-</td><td>
-
-boolean
-
-
-</td><td>
-
-_(Optional)_ Whether the entity sticks to platforms, defaults to true.
-
-
-</td></tr>
-<tr><td>
-
-[walkLoopedAnimations?](./server.playerentitycontrolleroptions.walkloopedanimations.md)
-
-
-</td><td>
-
-
-</td><td>
-
-string\[\]
-
-
-</td><td>
-
-_(Optional)_ Overrides the animation(s) that will play when the entity is walking.
-
-
-</td></tr>
-<tr><td>
-
-[walkVelocity?](./server.playerentitycontrolleroptions.walkvelocity.md)
-
-
-</td><td>
-
-
-</td><td>
-
-number
-
-
-</td><td>
-
-_(Optional)_ The normalized horizontal velocity applied to the entity when it walks.
-
-
-</td></tr>
-</tbody></table>

package/docs/server.playerentitycontrolleroptions.runloopedanimations.md

@@ -1,13 +0,0 @@
-<!-- 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; [runLoopedAnimations](./server.playerentitycontrolleroptions.runloopedanimations.md)
-
-## PlayerEntityControllerOptions.runLoopedAnimations property
-
-Overrides the animation(s) that will play when the entity is running.
-
-**Signature:**
-
-```typescript
-runLoopedAnimations?: string[];
-```

package/docs/server.playerentitycontrolleroptions.runvelocity.md

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

@@ -1,13 +0,0 @@
-<!-- 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; [sticksToPlatforms](./server.playerentitycontrolleroptions.stickstoplatforms.md)
-
-## PlayerEntityControllerOptions.sticksToPlatforms property
-
-Whether the entity sticks to platforms, defaults to true.
-
-**Signature:**
-
-```typescript
-sticksToPlatforms?: boolean;
-```

package/docs/server.playerentitycontrolleroptions.walkloopedanimations.md

@@ -1,13 +0,0 @@
-<!-- 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; [walkLoopedAnimations](./server.playerentitycontrolleroptions.walkloopedanimations.md)
-
-## PlayerEntityControllerOptions.walkLoopedAnimations property
-
-Overrides the animation(s) that will play when the entity is walking.
-
-**Signature:**
-
-```typescript
-walkLoopedAnimations?: string[];
-```

package/docs/server.playerentitycontrolleroptions.walkvelocity.md

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