hytopia 0.5.23 → 0.5.24

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hytopia",
-  "version": "0.5.23",
+  "version": "0.5.24",
   "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

@@ -25860,7 +25860,7 @@
             },
             {
               "kind": "Content",
-              "text": ";\n    moveIgnoreAxes?: {\n        x?: boolean;\n        y?: boolean;\n        z?: boolean;\n    };\n}"
+              "text": ";\n    moveIgnoreAxes?: {\n        x?: boolean;\n        y?: boolean;\n        z?: boolean;\n    };\n    moveStartIdleAnimationsOnCompletion?: boolean;\n}"
             },
             {
               "kind": "Content",
@@ -38430,6 +38430,66 @@
               "isAbstract": false,
               "name": "face"
             },
+            {
+              "kind": "Property",
+              "canonicalReference": "server!SimpleEntityController#idleLoopedAnimations:member",
+              "docComment": "/**\n * The animations to loop when the entity is idle.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "idleLoopedAnimations: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string[]"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "idleLoopedAnimations",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
+            {
+              "kind": "Property",
+              "canonicalReference": "server!SimpleEntityController#idleLoopedAnimationsSpeed:member",
+              "docComment": "/**\n * The speed at which to loop the idle animations.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "idleLoopedAnimationsSpeed: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "number | undefined"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "idleLoopedAnimationsSpeed",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
             {
               "kind": "Method",
               "canonicalReference": "server!SimpleEntityController#jump:member(1)",
@@ -38478,6 +38538,36 @@
               "isAbstract": false,
               "name": "jump"
             },
+            {
+              "kind": "Property",
+              "canonicalReference": "server!SimpleEntityController#jumpOneshotAnimations:member",
+              "docComment": "/**\n * The animations to play when the entity jumps.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "jumpOneshotAnimations: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string[]"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "jumpOneshotAnimations",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
             {
               "kind": "Method",
               "canonicalReference": "server!SimpleEntityController#move:member(1)",
@@ -38559,6 +38649,145 @@
               "isOptional": false,
               "isAbstract": false,
               "name": "move"
+            },
+            {
+              "kind": "Property",
+              "canonicalReference": "server!SimpleEntityController#moveLoopedAnimations:member",
+              "docComment": "/**\n * The animations to loop when the entity is moving.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "moveLoopedAnimations: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string[]"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "moveLoopedAnimations",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
+            {
+              "kind": "Property",
+              "canonicalReference": "server!SimpleEntityController#moveLoopedAnimationsSpeed:member",
+              "docComment": "/**\n * The speed at which to loop the move animations.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "moveLoopedAnimationsSpeed: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "number | undefined"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "moveLoopedAnimationsSpeed",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
+            {
+              "kind": "Property",
+              "canonicalReference": "server!SimpleEntityController#moveSpeed:member",
+              "docComment": "/**\n * The speed at which to move the entity. Can be altered while moving.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "moveSpeed: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "number"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "moveSpeed",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
+            {
+              "kind": "Method",
+              "canonicalReference": "server!SimpleEntityController#spawn:member(1)",
+              "docComment": "/**\n * Override of the {@link BaseEntityController.spawn} method. Starts the set idle animations (if any) when the entity is spawned.\n *\n * @param entity - The entity that was spawned.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "spawn(entity: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Entity",
+                  "canonicalReference": "server!Entity:class"
+                },
+                {
+                  "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": "entity",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                }
+              ],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "spawn"
             }
           ],
           "extendsTokenRange": {

package/server.d.ts

@@ -3298,6 +3298,8 @@ export declare type MoveOptions = {
         y?: boolean;
         z?: boolean;
     };
+    /** Whether to start the idle animations when the entity finishes moving. Defaults to true. */
+    moveStartIdleAnimationsOnCompletion?: boolean;
 };
 
 /** The options for an error type "none" collider. @public */
@@ -4902,6 +4904,20 @@ export declare interface SceneUIOptions {
  * @public
  */
 export declare class SimpleEntityController extends BaseEntityController {
+    /** The speed at which to rotate to the target coordinate when facing. Can be altered while facing. */
+    private faceSpeed;
+    /** The animations to loop when the entity is idle. */
+    idleLoopedAnimations: string[];
+    /** The speed at which to loop the idle animations. */
+    idleLoopedAnimationsSpeed: number | undefined;
+    /** The animations to play when the entity jumps. */
+    jumpOneshotAnimations: string[];
+    /** The animations to loop when the entity is moving. */
+    moveLoopedAnimations: string[];
+    /** The speed at which to loop the move animations. */
+    moveLoopedAnimationsSpeed: number | undefined;
+    /** The speed at which to move the entity. Can be altered while moving. */
+    moveSpeed: number;
 
 
 
@@ -4912,6 +4928,12 @@ export declare class SimpleEntityController extends BaseEntityController {
 
 
 
+    /**
+     * Override of the {@link BaseEntityController.spawn} method. Starts
+     * the set idle animations (if any) when the entity is spawned.
+     * @param entity - The entity that was spawned.
+     */
+    spawn(entity: Entity): void;
     /**
      * Rotates the entity at a given speed to face a target coordinate.
      *
@@ -4946,6 +4968,9 @@ export declare class SimpleEntityController extends BaseEntityController {
      */
     move(target: Vector3Like, speed: number, options?: MoveOptions): void;
 
+
+
+
 }
 
 /**