hytopia 0.5.24 → 0.6.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hytopia",
-  "version": "0.5.24",
+  "version": "0.6.1",
   "description": "The HYTOPIA SDK makes it easy for developers to create massively multiplayer games using JavaScript or TypeScript.",
   "type": "module",
   "main": "./node-server.mjs",

package/server.api.json

@@ -10893,6 +10893,36 @@
                 }
               ]
             },
+            {
+              "kind": "Property",
+              "canonicalReference": "server!DefaultPlayerEntityController#applyDirectionalMovementRotations:member",
+              "docComment": "/**\n * Whether to apply directional rotations to the entity while moving, defaults to true.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "applyDirectionalMovementRotations: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "boolean"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "applyDirectionalMovementRotations",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
             {
               "kind": "Method",
               "canonicalReference": "server!DefaultPlayerEntityController#attach:member(1)",
@@ -11278,6 +11308,66 @@
               "isProtected": false,
               "isAbstract": false
             },
+            {
+              "kind": "Property",
+              "canonicalReference": "server!DefaultPlayerEntityController#jumpLandHeavyOneshotAnimations:member",
+              "docComment": "/**\n * The oneshot animation(s) that will play when the entity lands with a high velocity.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "jumpLandHeavyOneshotAnimations: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string[]"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "jumpLandHeavyOneshotAnimations",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
+            {
+              "kind": "Property",
+              "canonicalReference": "server!DefaultPlayerEntityController#jumpLandLightOneshotAnimations:member",
+              "docComment": "/**\n * The oneshot animation(s) that will play when the entity lands after jumping or being airborne.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "jumpLandLightOneshotAnimations: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string[]"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "jumpLandLightOneshotAnimations",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
             {
               "kind": "Property",
               "canonicalReference": "server!DefaultPlayerEntityController#jumpOneshotAnimations:member",
@@ -11572,10 +11662,40 @@
               "isProtected": false,
               "isAbstract": false
             },
+            {
+              "kind": "Property",
+              "canonicalReference": "server!DefaultPlayerEntityController#swimIdleLoopedAnimations:member",
+              "docComment": "/**\n * The looped animation(s) that will play when the entity is not moving while swimming.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "swimIdleLoopedAnimations: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string[]"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "swimIdleLoopedAnimations",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
             {
               "kind": "Property",
               "canonicalReference": "server!DefaultPlayerEntityController#swimLoopedAnimations:member",
-              "docComment": "/**\n * The looped animation(s) that will play when the entity is swimming.\n */\n",
+              "docComment": "/**\n * The looped animation(s) that will play when the entity is swimming in any direction.\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -11873,6 +11993,33 @@
           "name": "DefaultPlayerEntityControllerOptions",
           "preserveMemberOrder": false,
           "members": [
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "server!DefaultPlayerEntityControllerOptions#applyDirectionalMovementRotations:member",
+              "docComment": "/**\n * Whether to apply directional rotations to the entity while moving, defaults to true.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "applyDirectionalMovementRotations?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "boolean"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "applyDirectionalMovementRotations",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
             {
               "kind": "PropertySignature",
               "canonicalReference": "server!DefaultPlayerEntityControllerOptions#autoCancelMouseLeftClick:member",
@@ -12062,6 +12209,60 @@
                 "endIndex": 2
               }
             },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "server!DefaultPlayerEntityControllerOptions#jumpLandHeavyOneshotAnimations:member",
+              "docComment": "/**\n * Overrides the animation(s) that will play when the entity lands with a high velocity.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "jumpLandHeavyOneshotAnimations?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string[]"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "jumpLandHeavyOneshotAnimations",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "server!DefaultPlayerEntityControllerOptions#jumpLandLightOneshotAnimations:member",
+              "docComment": "/**\n * Overrides the animation(s) that will play when the entity lands after jumping or being airborne.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "jumpLandLightOneshotAnimations?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string[]"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "jumpLandLightOneshotAnimations",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
             {
               "kind": "PropertySignature",
               "canonicalReference": "server!DefaultPlayerEntityControllerOptions#jumpOneshotAnimations:member",
@@ -12251,10 +12452,37 @@
                 "endIndex": 2
               }
             },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "server!DefaultPlayerEntityControllerOptions#swimIdleLoopedAnimations:member",
+              "docComment": "/**\n * The looped animation(s) that will play when the entity is not moving while swimming.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "swimIdleLoopedAnimations?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string[]"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "swimIdleLoopedAnimations",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
             {
               "kind": "PropertySignature",
               "canonicalReference": "server!DefaultPlayerEntityControllerOptions#swimLoopedAnimations:member",
-              "docComment": "/**\n * The looped animation(s) that will play when the entity is swimming.\n */\n",
+              "docComment": "/**\n * The looped animation(s) that will play when the entity is swimming in any direction.\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -13384,7 +13612,7 @@
                 },
                 {
                   "kind": "Content",
-                  "text": "number | undefined"
+                  "text": "number"
                 },
                 {
                   "kind": "Content",
@@ -14090,6 +14318,150 @@
               "isAbstract": false,
               "name": "startModelOneshotAnimations"
             },
+            {
+              "kind": "Method",
+              "canonicalReference": "server!Entity#stopAllModelAnimations:member(1)",
+              "docComment": "/**\n * Stops all looped and oneshot animations for the entity, optionally excluded the provided animations from stopping.\n *\n * @param excludedAnimations - The animations to exclude from being stopped.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "stopAllModelAnimations(excludedAnimations?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string[]"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "void"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 4
+              },
+              "releaseTag": "Public",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "excludedAnimations",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": true
+                }
+              ],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "stopAllModelAnimations"
+            },
+            {
+              "kind": "Method",
+              "canonicalReference": "server!Entity#stopAllModelLoopedAnimations:member(1)",
+              "docComment": "/**\n * Stops all looped animations for the entity, optionally excluded the provided animations from stopping.\n *\n * @param excludedAnimations - The animations to exclude from being stopped.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "stopAllModelLoopedAnimations(excludedAnimations?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string[]"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "void"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 4
+              },
+              "releaseTag": "Public",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "excludedAnimations",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": true
+                }
+              ],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "stopAllModelLoopedAnimations"
+            },
+            {
+              "kind": "Method",
+              "canonicalReference": "server!Entity#stopAllModelOneshotAnimations:member(1)",
+              "docComment": "/**\n * Stops all oneshot animations for the entity, optionally excluded the provided animations from stopping.\n *\n * @param excludedAnimations - The animations to exclude from being stopped.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "stopAllModelOneshotAnimations(excludedAnimations?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string[]"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "void"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 4
+              },
+              "releaseTag": "Public",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "excludedAnimations",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": true
+                }
+              ],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "stopAllModelOneshotAnimations"
+            },
             {
               "kind": "Method",
               "canonicalReference": "server!Entity#stopModelAnimations:member(1)",

package/server.d.ts

@@ -1470,6 +1470,19 @@ export declare class DefaultPlayerEntity extends PlayerEntity {
  * @public
  */
 export declare class DefaultPlayerEntityController extends BaseEntityController {
+    private static readonly BASE_ENTITY_HEIGHT;
+    private static readonly GROUND_SENSOR_HEIGHT_SCALE;
+    private static readonly GROUND_SENSOR_RADIUS_SCALE;
+    private static readonly JUMP_LAND_HEAVY_VELOCITY_THRESHOLD;
+    private static readonly WALL_COLLIDER_HEIGHT_SCALE;
+    private static readonly WALL_COLLIDER_RADIUS_SCALE;
+    private static readonly MOVEMENT_ROTATIONS;
+    private static readonly SWIM_UPWARD_COOLDOWN_MS;
+    private static readonly SWIMMING_DRAG_FACTOR;
+    private static readonly WATER_ENTRY_SINKING_FACTOR;
+    private static readonly WATER_ENTRY_SINKING_MS;
+    /** Whether to apply directional rotations to the entity while moving, defaults to true. */
+    applyDirectionalMovementRotations: boolean;
     /** Whether to automatically cancel left click input after first processed tick, defaults to true. */
     autoCancelMouseLeftClick: boolean;
     /**
@@ -1500,6 +1513,10 @@ export declare class DefaultPlayerEntityController extends BaseEntityController
     idleLoopedAnimations: string[];
     /** The oneshot animation(s) that will play when the entity interacts (left click) */
     interactOneshotAnimations: string[];
+    /** The oneshot animation(s) that will play when the entity lands with a high velocity. */
+    jumpLandHeavyOneshotAnimations: string[];
+    /** The oneshot animation(s) that will play when the entity lands after jumping or being airborne. */
+    jumpLandLightOneshotAnimations: string[];
     /** The oneshot animation(s) that will play when the entity is jumping. */
     jumpOneshotAnimations: string[];
     /** The upward velocity applied to the entity when it jumps. */
@@ -1514,7 +1531,9 @@ export declare class DefaultPlayerEntityController extends BaseEntityController
     swimFastVelocity: number;
     /** The gravity modifier applied to the entity when swimming. */
     swimGravity: number;
-    /** The looped animation(s) that will play when the entity is swimming. */
+    /** The looped animation(s) that will play when the entity is not moving while swimming. */
+    swimIdleLoopedAnimations: string[];
+    /** The looped animation(s) that will play when the entity is swimming in any direction. */
     swimLoopedAnimations: string[];
     /** The maximum downward velocity that the entity can reach when affected by gravity while swimming. */
     swimMaxGravityVelocity: number;
@@ -1531,6 +1550,12 @@ export declare class DefaultPlayerEntityController extends BaseEntityController
 
 
 
+
+
+
+
+
+
     /**
      * @param options - Options for the controller.
      */
@@ -1571,6 +1596,8 @@ export declare class DefaultPlayerEntityController extends BaseEntityController
 
 /** Options for creating a DefaultPlayerEntityController instance. @public */
 export declare interface DefaultPlayerEntityControllerOptions {
+    /** Whether to apply directional rotations to the entity while moving, defaults to true. */
+    applyDirectionalMovementRotations?: boolean;
     /** Whether to automatically cancel left click input after first processed tick, defaults to true. */
     autoCancelMouseLeftClick?: boolean;
     /** A function allowing custom logic to determine if the entity can jump. */
@@ -1587,6 +1614,10 @@ export declare interface DefaultPlayerEntityControllerOptions {
     interactOneshotAnimations?: string[];
     /** Overrides the animation(s) that will play when the entity is jumping. */
     jumpOneshotAnimations?: string[];
+    /** Overrides the animation(s) that will play when the entity lands with a high velocity. */
+    jumpLandHeavyOneshotAnimations?: string[];
+    /** Overrides the animation(s) that will play when the entity lands after jumping or being airborne. */
+    jumpLandLightOneshotAnimations?: string[];
     /** The upward velocity applied to the entity when it jumps. */
     jumpVelocity?: number;
     /** The normalized horizontal velocity applied to the entity when it runs. */
@@ -1601,8 +1632,10 @@ export declare interface DefaultPlayerEntityControllerOptions {
     swimGravity?: number;
     /** The maximum downward velocity that the entity can reach when affected by gravity while swimming. */
     swimMaxGravityVelocity?: number;
-    /** 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. */
     swimLoopedAnimations?: string[];
+    /** The looped animation(s) that will play when the entity is not moving while swimming. */
+    swimIdleLoopedAnimations?: string[];
     /** The normalized horizontal velocity applied to the entity when it swims slowly (equivalent to walking). */
     swimSlowVelocity?: number;
     /** The upward velocity applied to the entity when swimming. */
@@ -1734,7 +1767,7 @@ export declare class Entity extends RigidBody implements protocol.Serializable {
     /** The preferred shape of the entity's model when automatically generating its collider when no explicit colliders are provided. */
     get modelPreferredShape(): ColliderShape | undefined;
     /** The scale of the entity's model. */
-    get modelScale(): number | undefined;
+    get modelScale(): number;
     /** The URI or path to the .gltf model asset to be used for the entity. */
     get modelUri(): string | undefined;
     /** The name of the entity. */
@@ -1840,6 +1873,27 @@ export declare class Entity extends RigidBody implements protocol.Serializable {
      * @param animations - The animations to start.
      */
     startModelOneshotAnimations(animations: string[]): void;
+    /**
+     * Stops all looped and oneshot animations for the entity,
+     * optionally excluded the provided animations from stopping.
+     *
+     * @param excludedAnimations - The animations to exclude from being stopped.
+     */
+    stopAllModelAnimations(excludedAnimations?: string[]): void;
+    /**
+     * Stops all looped animations for the entity, optionally
+     * excluded the provided animations from stopping.
+     *
+     * @param excludedAnimations - The animations to exclude from being stopped.
+     */
+    stopAllModelLoopedAnimations(excludedAnimations?: string[]): void;
+    /**
+     * Stops all oneshot animations for the entity, optionally
+     * excluded the provided animations from stopping.
+     *
+     * @param excludedAnimations - The animations to exclude from being stopped.
+     */
+    stopAllModelOneshotAnimations(excludedAnimations?: string[]): void;
     /**
      * Stops the provided model animations for the entity.
      *
@@ -1856,6 +1910,7 @@ export declare class Entity extends RigidBody implements protocol.Serializable {
 
 
 
+
 }
 
 /** Event types an Entity instance can emit. See {@link EntityEventPayloads} for the payloads. @public */