hytopia 0.5.24 → 0.6.1

package/docs/server.defaultplayerentitycontroller.applydirectionalmovementrotations.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; [applyDirectionalMovementRotations](./server.defaultplayerentitycontroller.applydirectionalmovementrotations.md)
+
+## DefaultPlayerEntityController.applyDirectionalMovementRotations property
+
+Whether to apply directional rotations to the entity while moving, defaults to true.
+
+**Signature:**
+
+```typescript
+applyDirectionalMovementRotations: boolean;
+```

package/docs/server.defaultplayerentitycontroller.jumplandheavyoneshotanimations.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; [jumpLandHeavyOneshotAnimations](./server.defaultplayerentitycontroller.jumplandheavyoneshotanimations.md)
+
+## DefaultPlayerEntityController.jumpLandHeavyOneshotAnimations property
+
+The oneshot animation(s) that will play when the entity lands with a high velocity.
+
+**Signature:**
+
+```typescript
+jumpLandHeavyOneshotAnimations: string[];
+```

package/docs/server.defaultplayerentitycontroller.jumplandlightoneshotanimations.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; [jumpLandLightOneshotAnimations](./server.defaultplayerentitycontroller.jumplandlightoneshotanimations.md)
+
+## DefaultPlayerEntityController.jumpLandLightOneshotAnimations property
+
+The oneshot animation(s) that will play when the entity lands after jumping or being airborne.
+
+**Signature:**
+
+```typescript
+jumpLandLightOneshotAnimations: string[];
+```

package/docs/server.defaultplayerentitycontroller.md

@@ -91,6 +91,25 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
+[applyDirectionalMovementRotations](./server.defaultplayerentitycontroller.applydirectionalmovementrotations.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+Whether to apply directional rotations to the entity while moving, defaults to true.
+
+
+</td></tr>
+<tr><td>
+
 [autoCancelMouseLeftClick](./server.defaultplayerentitycontroller.autocancelmouseleftclick.md)
 
 
@@ -284,6 +303,44 @@ boolean
 Whether the entity is swimming, this is determined by if the entity is in a liquid block.
 
 
+</td></tr>
+<tr><td>
+
+[jumpLandHeavyOneshotAnimations](./server.defaultplayerentitycontroller.jumplandheavyoneshotanimations.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string\[\]
+
+
+</td><td>
+
+The oneshot animation(s) that will play when the entity lands with a high velocity.
+
+
+</td></tr>
+<tr><td>
+
+[jumpLandLightOneshotAnimations](./server.defaultplayerentitycontroller.jumplandlightoneshotanimations.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string\[\]
+
+
+</td><td>
+
+The oneshot animation(s) that will play when the entity lands after jumping or being airborne.
+
+
 </td></tr>
 <tr><td>
 
@@ -438,6 +495,25 @@ number
 The gravity modifier applied to the entity when swimming.
 
 
+</td></tr>
+<tr><td>
+
+[swimIdleLoopedAnimations](./server.defaultplayerentitycontroller.swimidleloopedanimations.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string\[\]
+
+
+</td><td>
+
+The looped animation(s) that will play when the entity is not moving while swimming.
+
+
 </td></tr>
 <tr><td>
 
@@ -454,7 +530,7 @@ string\[\]
 
 </td><td>
 
-The looped animation(s) that will play when the entity is swimming.
+The looped animation(s) that will play when the entity is swimming in any direction.
 
 
 </td></tr>

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

package/docs/server.defaultplayerentitycontroller.swimloopedanimations.md

@@ -4,7 +4,7 @@
 
 ## DefaultPlayerEntityController.swimLoopedAnimations property
 
-The looped animation(s) that will play when the entity is swimming.
+The looped animation(s) that will play when the entity is swimming in any direction.
 
 **Signature:**
 

package/docs/server.defaultplayerentitycontrolleroptions.applydirectionalmovementrotations.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; [applyDirectionalMovementRotations](./server.defaultplayerentitycontrolleroptions.applydirectionalmovementrotations.md)
+
+## DefaultPlayerEntityControllerOptions.applyDirectionalMovementRotations property
+
+Whether to apply directional rotations to the entity while moving, defaults to true.
+
+**Signature:**
+
+```typescript
+applyDirectionalMovementRotations?: boolean;
+```

package/docs/server.defaultplayerentitycontrolleroptions.jumplandheavyoneshotanimations.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; [jumpLandHeavyOneshotAnimations](./server.defaultplayerentitycontrolleroptions.jumplandheavyoneshotanimations.md)
+
+## DefaultPlayerEntityControllerOptions.jumpLandHeavyOneshotAnimations property
+
+Overrides the animation(s) that will play when the entity lands with a high velocity.
+
+**Signature:**
+
+```typescript
+jumpLandHeavyOneshotAnimations?: string[];
+```

package/docs/server.defaultplayerentitycontrolleroptions.jumplandlightoneshotanimations.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; [jumpLandLightOneshotAnimations](./server.defaultplayerentitycontrolleroptions.jumplandlightoneshotanimations.md)
+
+## DefaultPlayerEntityControllerOptions.jumpLandLightOneshotAnimations property
+
+Overrides the animation(s) that will play when the entity lands after jumping or being airborne.
+
+**Signature:**
+
+```typescript
+jumpLandLightOneshotAnimations?: string[];
+```

package/docs/server.defaultplayerentitycontrolleroptions.md

@@ -37,6 +37,25 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
+[applyDirectionalMovementRotations?](./server.defaultplayerentitycontrolleroptions.applydirectionalmovementrotations.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+_(Optional)_ Whether to apply directional rotations to the entity while moving, defaults to true.
+
+
+</td></tr>
+<tr><td>
+
 [autoCancelMouseLeftClick?](./server.defaultplayerentitycontrolleroptions.autocancelmouseleftclick.md)
 
 
@@ -167,6 +186,44 @@ string\[\]
 _(Optional)_ Overrides the animation(s) that will play when the entity interacts (left click)
 
 
+</td></tr>
+<tr><td>
+
+[jumpLandHeavyOneshotAnimations?](./server.defaultplayerentitycontrolleroptions.jumplandheavyoneshotanimations.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string\[\]
+
+
+</td><td>
+
+_(Optional)_ Overrides the animation(s) that will play when the entity lands with a high velocity.
+
+
+</td></tr>
+<tr><td>
+
+[jumpLandLightOneshotAnimations?](./server.defaultplayerentitycontrolleroptions.jumplandlightoneshotanimations.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string\[\]
+
+
+</td><td>
+
+_(Optional)_ Overrides the animation(s) that will play when the entity lands after jumping or being airborne.
+
+
 </td></tr>
 <tr><td>
 
@@ -300,6 +357,25 @@ number
 _(Optional)_ The gravity modifier applied to the entity when swimming.
 
 
+</td></tr>
+<tr><td>
+
+[swimIdleLoopedAnimations?](./server.defaultplayerentitycontrolleroptions.swimidleloopedanimations.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string\[\]
+
+
+</td><td>
+
+_(Optional)_ The looped animation(s) that will play when the entity is not moving while swimming.
+
+
 </td></tr>
 <tr><td>
 
@@ -316,7 +392,7 @@ string\[\]
 
 </td><td>
 
-_(Optional)_ The looped animation(s) that will play when the entity is swimming.
+_(Optional)_ The looped animation(s) that will play when the entity is swimming in any direction.
 
 
 </td></tr>

package/docs/server.defaultplayerentitycontrolleroptions.swimidleloopedanimations.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; [swimIdleLoopedAnimations](./server.defaultplayerentitycontrolleroptions.swimidleloopedanimations.md)
+
+## DefaultPlayerEntityControllerOptions.swimIdleLoopedAnimations property
+
+The looped animation(s) that will play when the entity is not moving while swimming.
+
+**Signature:**
+
+```typescript
+swimIdleLoopedAnimations?: string[];
+```

package/docs/server.defaultplayerentitycontrolleroptions.swimloopedanimations.md

@@ -4,7 +4,7 @@
 
 ## DefaultPlayerEntityControllerOptions.swimLoopedAnimations property
 
-The looped animation(s) that will play when the entity is swimming.
+The looped animation(s) that will play when the entity is swimming in any direction.
 
 **Signature:**
 

package/docs/server.entity.md

@@ -370,7 +370,7 @@ The preferred shape of the entity's model when automatically generating its coll
 
 </td><td>
 
-number \| undefined
+number
 
 
 </td><td>
@@ -706,6 +706,48 @@ Starts looped animations for the entity, blending with other animations currentl
 Starts a oneshot animation for the entity, blending with other animations currently playing.
 
 
+</td></tr>
+<tr><td>
+
+[stopAllModelAnimations(excludedAnimations)](./server.entity.stopallmodelanimations.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Stops all looped and oneshot animations for the entity, optionally excluded the provided animations from stopping.
+
+
+</td></tr>
+<tr><td>
+
+[stopAllModelLoopedAnimations(excludedAnimations)](./server.entity.stopallmodelloopedanimations.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Stops all looped animations for the entity, optionally excluded the provided animations from stopping.
+
+
+</td></tr>
+<tr><td>
+
+[stopAllModelOneshotAnimations(excludedAnimations)](./server.entity.stopallmodeloneshotanimations.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Stops all oneshot animations for the entity, optionally excluded the provided animations from stopping.
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.entity.modelscale.md

@@ -9,5 +9,5 @@ The scale of the entity's model.
 **Signature:**
 
 ```typescript
-get modelScale(): number | undefined;
+get modelScale(): number;
 ```

package/docs/server.entity.stopallmodelanimations.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; [Entity](./server.entity.md) &gt; [stopAllModelAnimations](./server.entity.stopallmodelanimations.md)
+
+## Entity.stopAllModelAnimations() method
+
+Stops all looped and oneshot animations for the entity, optionally excluded the provided animations from stopping.
+
+**Signature:**
+
+```typescript
+stopAllModelAnimations(excludedAnimations?: string[]): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+excludedAnimations
+
+
+</td><td>
+
+string\[\]
+
+
+</td><td>
+
+_(Optional)_ The animations to exclude from being stopped.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

package/docs/server.entity.stopallmodelloopedanimations.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; [Entity](./server.entity.md) &gt; [stopAllModelLoopedAnimations](./server.entity.stopallmodelloopedanimations.md)
+
+## Entity.stopAllModelLoopedAnimations() method
+
+Stops all looped animations for the entity, optionally excluded the provided animations from stopping.
+
+**Signature:**
+
+```typescript
+stopAllModelLoopedAnimations(excludedAnimations?: string[]): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+excludedAnimations
+
+
+</td><td>
+
+string\[\]
+
+
+</td><td>
+
+_(Optional)_ The animations to exclude from being stopped.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

package/docs/server.entity.stopallmodeloneshotanimations.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; [Entity](./server.entity.md) &gt; [stopAllModelOneshotAnimations](./server.entity.stopallmodeloneshotanimations.md)
+
+## Entity.stopAllModelOneshotAnimations() method
+
+Stops all oneshot animations for the entity, optionally excluded the provided animations from stopping.
+
+**Signature:**
+
+```typescript
+stopAllModelOneshotAnimations(excludedAnimations?: string[]): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+excludedAnimations
+
+
+</td><td>
+
+string\[\]
+
+
+</td><td>
+
+_(Optional)_ The animations to exclude from being stopped.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+