hytopia 0.4.3 → 0.5.0-dev

package/docs/server.defaultplayerentitycontroller.swimgravity.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; [DefaultPlayerEntityController](./server.defaultplayerentitycontroller.md) &gt; [swimGravity](./server.defaultplayerentitycontroller.swimgravity.md)
+
+## DefaultPlayerEntityController.swimGravity property
+
+The gravity modifier applied to the entity when swimming.
+
+**Signature:**
+
+```typescript
+swimGravity: number;
+```

package/docs/server.defaultplayerentitycontroller.swimloopedanimations.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; [DefaultPlayerEntityController](./server.defaultplayerentitycontroller.md) &gt; [swimLoopedAnimations](./server.defaultplayerentitycontroller.swimloopedanimations.md)
+
+## DefaultPlayerEntityController.swimLoopedAnimations property
+
+The looped animation(s) that will play when the entity is swimming.
+
+**Signature:**
+
+```typescript
+swimLoopedAnimations: string[];
+```

package/docs/server.defaultplayerentitycontroller.swimmaxgravityvelocity.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; [DefaultPlayerEntityController](./server.defaultplayerentitycontroller.md) &gt; [swimMaxGravityVelocity](./server.defaultplayerentitycontroller.swimmaxgravityvelocity.md)
+
+## DefaultPlayerEntityController.swimMaxGravityVelocity property
+
+The maximum downward velocity that the entity can reach when affected by gravity while swimming.
+
+**Signature:**
+
+```typescript
+swimMaxGravityVelocity: number;
+```

package/docs/server.defaultplayerentitycontroller.swimslowvelocity.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; [DefaultPlayerEntityController](./server.defaultplayerentitycontroller.md) &gt; [swimSlowVelocity](./server.defaultplayerentitycontroller.swimslowvelocity.md)
+
+## DefaultPlayerEntityController.swimSlowVelocity property
+
+The normalized horizontal velocity applied to the entity when it swims slowly (equivalent to walking).
+
+**Signature:**
+
+```typescript
+swimSlowVelocity: number;
+```

package/docs/server.defaultplayerentitycontroller.swimupwardvelocity.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; [DefaultPlayerEntityController](./server.defaultplayerentitycontroller.md) &gt; [swimUpwardVelocity](./server.defaultplayerentitycontroller.swimupwardvelocity.md)
+
+## DefaultPlayerEntityController.swimUpwardVelocity property
+
+The upward velocity applied to the entity when swimming.
+
+**Signature:**
+
+```typescript
+swimUpwardVelocity: number;
+```

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

@@ -1,8 +1,8 @@
 <!-- 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; [tickWithPlayerInput](./server.playerentitycontroller.tickwithplayerinput.md)
+[Home](./index.md) &gt; [server](./server.md) &gt; [DefaultPlayerEntityController](./server.defaultplayerentitycontroller.md) &gt; [tickWithPlayerInput](./server.defaultplayerentitycontroller.tickwithplayerinput.md)
 
-## PlayerEntityController.tickWithPlayerInput() method
+## DefaultPlayerEntityController.tickWithPlayerInput() method
 
 Ticks the player movement for the entity controller, overriding the default implementation. If the entity to tick is a child entity, only the event will be emitted but the default movement logic will not be applied.
 

package/docs/server.defaultplayerentitycontroller.walkloopedanimations.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; [DefaultPlayerEntityController](./server.defaultplayerentitycontroller.md) &gt; [walkLoopedAnimations](./server.defaultplayerentitycontroller.walkloopedanimations.md)
+
+## DefaultPlayerEntityController.walkLoopedAnimations property
+
+The looped animation(s) that will play when the entity is walking.
+
+**Signature:**
+
+```typescript
+walkLoopedAnimations: string[];
+```

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

package/docs/server.defaultplayerentitycontrolleroptions.autocancelmouseleftclick.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; [DefaultPlayerEntityControllerOptions](./server.defaultplayerentitycontrolleroptions.md) &gt; [autoCancelMouseLeftClick](./server.defaultplayerentitycontrolleroptions.autocancelmouseleftclick.md)
+
+## DefaultPlayerEntityControllerOptions.autoCancelMouseLeftClick property
+
+Whether to automatically cancel left click input after first processed tick, defaults to true.
+
+**Signature:**
+
+```typescript
+autoCancelMouseLeftClick?: boolean;
+```

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

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

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

package/docs/server.defaultplayerentitycontrolleroptions.idleloopedanimations.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; [DefaultPlayerEntityControllerOptions](./server.defaultplayerentitycontrolleroptions.md) &gt; [idleLoopedAnimations](./server.defaultplayerentitycontrolleroptions.idleloopedanimations.md)
+
+## DefaultPlayerEntityControllerOptions.idleLoopedAnimations property
+
+Overrides the animation(s) that will play when the entity is idle.
+
+**Signature:**
+
+```typescript
+idleLoopedAnimations?: string[];
+```

package/docs/server.defaultplayerentitycontrolleroptions.interactoneshotanimations.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; [DefaultPlayerEntityControllerOptions](./server.defaultplayerentitycontrolleroptions.md) &gt; [interactOneshotAnimations](./server.defaultplayerentitycontrolleroptions.interactoneshotanimations.md)
+
+## DefaultPlayerEntityControllerOptions.interactOneshotAnimations property
+
+Overrides the animation(s) that will play when the entity interacts (left click)
+
+**Signature:**
+
+```typescript
+interactOneshotAnimations?: string[];
+```

package/docs/server.defaultplayerentitycontrolleroptions.jumponeshotanimations.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; [DefaultPlayerEntityControllerOptions](./server.defaultplayerentitycontrolleroptions.md) &gt; [jumpOneshotAnimations](./server.defaultplayerentitycontrolleroptions.jumponeshotanimations.md)
+
+## DefaultPlayerEntityControllerOptions.jumpOneshotAnimations property
+
+Overrides the animation(s) that will play when the entity is jumping.
+
+**Signature:**
+
+```typescript
+jumpOneshotAnimations?: string[];
+```

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

package/docs/server.defaultplayerentitycontrolleroptions.md

@@ -0,0 +1,399 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [DefaultPlayerEntityControllerOptions](./server.defaultplayerentitycontrolleroptions.md)
+
+## DefaultPlayerEntityControllerOptions interface
+
+Options for creating a DefaultPlayerEntityController instance.
+
+**Signature:**
+
+```typescript
+export interface DefaultPlayerEntityControllerOptions 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[autoCancelMouseLeftClick?](./server.defaultplayerentitycontrolleroptions.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.defaultplayerentitycontrolleroptions.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.defaultplayerentitycontrolleroptions.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.defaultplayerentitycontrolleroptions.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.defaultplayerentitycontrolleroptions.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.defaultplayerentitycontrolleroptions.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.defaultplayerentitycontrolleroptions.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.defaultplayerentitycontrolleroptions.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.defaultplayerentitycontrolleroptions.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.defaultplayerentitycontrolleroptions.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.defaultplayerentitycontrolleroptions.stickstoplatforms.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+_(Optional)_ Whether the entity sticks to platforms, defaults to true.
+
+
+</td></tr>
+<tr><td>
+
+[swimFastVelocity?](./server.defaultplayerentitycontrolleroptions.swimfastvelocity.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+_(Optional)_ The normalized horizontal velocity applied to the entity when it swims fast (equivalent to running).
+
+
+</td></tr>
+<tr><td>
+
+[swimGravity?](./server.defaultplayerentitycontrolleroptions.swimgravity.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+_(Optional)_ The gravity modifier applied to the entity when swimming.
+
+
+</td></tr>
+<tr><td>
+
+[swimLoopedAnimations?](./server.defaultplayerentitycontrolleroptions.swimloopedanimations.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string\[\]
+
+
+</td><td>
+
+_(Optional)_ The looped animation(s) that will play when the entity is swimming.
+
+
+</td></tr>
+<tr><td>
+
+[swimMaxGravityVelocity?](./server.defaultplayerentitycontrolleroptions.swimmaxgravityvelocity.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+_(Optional)_ The maximum downward velocity that the entity can reach when affected by gravity while swimming.
+
+
+</td></tr>
+<tr><td>
+
+[swimSlowVelocity?](./server.defaultplayerentitycontrolleroptions.swimslowvelocity.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+_(Optional)_ The normalized horizontal velocity applied to the entity when it swims slowly (equivalent to walking).
+
+
+</td></tr>
+<tr><td>
+
+[swimUpwardVelocity?](./server.defaultplayerentitycontrolleroptions.swimupwardvelocity.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+_(Optional)_ The upward velocity applied to the entity when swimming.
+
+
+</td></tr>
+<tr><td>
+
+[walkLoopedAnimations?](./server.defaultplayerentitycontrolleroptions.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.defaultplayerentitycontrolleroptions.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.defaultplayerentitycontrolleroptions.runloopedanimations.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; [DefaultPlayerEntityControllerOptions](./server.defaultplayerentitycontrolleroptions.md) &gt; [runLoopedAnimations](./server.defaultplayerentitycontrolleroptions.runloopedanimations.md)
+
+## DefaultPlayerEntityControllerOptions.runLoopedAnimations property
+
+Overrides the animation(s) that will play when the entity is running.
+
+**Signature:**
+
+```typescript
+runLoopedAnimations?: string[];
+```

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

package/docs/server.defaultplayerentitycontrolleroptions.stickstoplatforms.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; [DefaultPlayerEntityControllerOptions](./server.defaultplayerentitycontrolleroptions.md) &gt; [sticksToPlatforms](./server.defaultplayerentitycontrolleroptions.stickstoplatforms.md)
+
+## DefaultPlayerEntityControllerOptions.sticksToPlatforms property
+
+Whether the entity sticks to platforms, defaults to true.
+
+**Signature:**
+
+```typescript
+sticksToPlatforms?: boolean;
+```

package/docs/server.defaultplayerentitycontrolleroptions.swimfastvelocity.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; [DefaultPlayerEntityControllerOptions](./server.defaultplayerentitycontrolleroptions.md) &gt; [swimFastVelocity](./server.defaultplayerentitycontrolleroptions.swimfastvelocity.md)
+
+## DefaultPlayerEntityControllerOptions.swimFastVelocity property
+
+The normalized horizontal velocity applied to the entity when it swims fast (equivalent to running).
+
+**Signature:**
+
+```typescript
+swimFastVelocity?: number;
+```