hytopia 0.6.5 → 0.6.7

package/package.json

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

@@ -9816,16 +9816,16 @@
             },
             {
               "kind": "EnumMember",
-              "canonicalReference": "server!CollisionGroup.GROUP_1:member",
+              "canonicalReference": "server!CollisionGroup.ENVIRONMENT_ENTITY:member",
               "docComment": "",
               "excerptTokens": [
                 {
                   "kind": "Content",
-                  "text": "GROUP_1 = "
+                  "text": "ENVIRONMENT_ENTITY = "
                 },
                 {
                   "kind": "Content",
-                  "text": "16"
+                  "text": "8"
                 }
               ],
               "initializerTokenRange": {
@@ -9833,20 +9833,20 @@
                 "endIndex": 2
               },
               "releaseTag": "Public",
-              "name": "GROUP_1"
+              "name": "ENVIRONMENT_ENTITY"
             },
             {
               "kind": "EnumMember",
-              "canonicalReference": "server!CollisionGroup.GROUP_10:member",
+              "canonicalReference": "server!CollisionGroup.GROUP_1:member",
               "docComment": "",
               "excerptTokens": [
                 {
                   "kind": "Content",
-                  "text": "GROUP_10 = "
+                  "text": "GROUP_1 = "
                 },
                 {
                   "kind": "Content",
-                  "text": "8192"
+                  "text": "32"
                 }
               ],
               "initializerTokenRange": {
@@ -9854,16 +9854,16 @@
                 "endIndex": 2
               },
               "releaseTag": "Public",
-              "name": "GROUP_10"
+              "name": "GROUP_1"
             },
             {
               "kind": "EnumMember",
-              "canonicalReference": "server!CollisionGroup.GROUP_11:member",
+              "canonicalReference": "server!CollisionGroup.GROUP_10:member",
               "docComment": "",
               "excerptTokens": [
                 {
                   "kind": "Content",
-                  "text": "GROUP_11 = "
+                  "text": "GROUP_10 = "
                 },
                 {
                   "kind": "Content",
@@ -9875,16 +9875,16 @@
                 "endIndex": 2
               },
               "releaseTag": "Public",
-              "name": "GROUP_11"
+              "name": "GROUP_10"
             },
             {
               "kind": "EnumMember",
-              "canonicalReference": "server!CollisionGroup.GROUP_12:member",
+              "canonicalReference": "server!CollisionGroup.GROUP_11:member",
               "docComment": "",
               "excerptTokens": [
                 {
                   "kind": "Content",
-                  "text": "GROUP_12 = "
+                  "text": "GROUP_11 = "
                 },
                 {
                   "kind": "Content",
@@ -9896,7 +9896,7 @@
                 "endIndex": 2
               },
               "releaseTag": "Public",
-              "name": "GROUP_12"
+              "name": "GROUP_11"
             },
             {
               "kind": "EnumMember",
@@ -9909,7 +9909,7 @@
                 },
                 {
                   "kind": "Content",
-                  "text": "32"
+                  "text": "64"
                 }
               ],
               "initializerTokenRange": {
@@ -9930,7 +9930,7 @@
                 },
                 {
                   "kind": "Content",
-                  "text": "64"
+                  "text": "128"
                 }
               ],
               "initializerTokenRange": {
@@ -9951,7 +9951,7 @@
                 },
                 {
                   "kind": "Content",
-                  "text": "128"
+                  "text": "256"
                 }
               ],
               "initializerTokenRange": {
@@ -9972,7 +9972,7 @@
                 },
                 {
                   "kind": "Content",
-                  "text": "256"
+                  "text": "512"
                 }
               ],
               "initializerTokenRange": {
@@ -9993,7 +9993,7 @@
                 },
                 {
                   "kind": "Content",
-                  "text": "512"
+                  "text": "1024"
                 }
               ],
               "initializerTokenRange": {
@@ -10014,7 +10014,7 @@
                 },
                 {
                   "kind": "Content",
-                  "text": "1024"
+                  "text": "2048"
                 }
               ],
               "initializerTokenRange": {
@@ -10035,7 +10035,7 @@
                 },
                 {
                   "kind": "Content",
-                  "text": "2048"
+                  "text": "4096"
                 }
               ],
               "initializerTokenRange": {
@@ -10056,7 +10056,7 @@
                 },
                 {
                   "kind": "Content",
-                  "text": "4096"
+                  "text": "8192"
                 }
               ],
               "initializerTokenRange": {
@@ -10077,7 +10077,7 @@
                 },
                 {
                   "kind": "Content",
-                  "text": "8"
+                  "text": "16"
                 }
               ],
               "initializerTokenRange": {
@@ -26262,7 +26262,7 @@
             },
             {
               "kind": "Content",
-              "text": ";\n    moveIgnoreAxes?: {\n        x?: boolean;\n        y?: boolean;\n        z?: boolean;\n    };\n    moveStartIdleAnimationsOnCompletion?: boolean;\n}"
+              "text": ";\n    moveIgnoreAxes?: {\n        x?: boolean;\n        y?: boolean;\n        z?: boolean;\n    };\n    moveStartIdleAnimationsOnCompletion?: boolean;\n    moveStoppingDistance?: number;\n}"
             },
             {
               "kind": "Content",
@@ -26414,6 +26414,39 @@
           "name": "PathfindingEntityController",
           "preserveMemberOrder": false,
           "members": [
+            {
+              "kind": "Constructor",
+              "canonicalReference": "server!PathfindingEntityController:constructor(1)",
+              "docComment": "/**\n * Constructs a new instance of the `PathfindingEntityController` class\n *\n * @param options - Options for the controller.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "constructor(options?: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "PathfindingEntityControllerOptions",
+                  "canonicalReference": "server!~PathfindingEntityControllerOptions:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ");"
+                }
+              ],
+              "releaseTag": "Public",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "options",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": true
+                }
+              ]
+            },
             {
               "kind": "Property",
               "canonicalReference": "server!PathfindingEntityController#debug:member",
@@ -28605,6 +28638,54 @@
               "isAbstract": false,
               "name": "setOffset"
             },
+            {
+              "kind": "Method",
+              "canonicalReference": "server!PlayerCamera#setShoulderAngle:member(1)",
+              "docComment": "/**\n * Only used in third-person mode. Sets the shoulder angle of the camera in degrees. A positive value shifts the camera to the right, a negative value shifts it to the left.\n *\n * @param shoulderAngle - The shoulder angle to set in degrees.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "setShoulderAngle(shoulderAngle: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "number"
+                },
+                {
+                  "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": "shoulderAngle",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                }
+              ],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "setShoulderAngle"
+            },
             {
               "kind": "Method",
               "canonicalReference": "server!PlayerCamera#setTrackedEntity:member(1)",
@@ -28759,6 +28840,36 @@
               "isAbstract": false,
               "name": "setZoom"
             },
+            {
+              "kind": "Property",
+              "canonicalReference": "server!PlayerCamera#shoulderAngle:member",
+              "docComment": "/**\n * The shoulder angle of the camera in degrees.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "get shoulderAngle(): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "number"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": true,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "shoulderAngle",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
             {
               "kind": "Property",
               "canonicalReference": "server!PlayerCamera#trackedEntity:member",
@@ -29096,6 +29207,27 @@
               "releaseTag": "Public",
               "name": "SET_OFFSET"
             },
+            {
+              "kind": "EnumMember",
+              "canonicalReference": "server!PlayerCameraEvent.SET_SHOULDER_ANGLE:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "SET_SHOULDER_ANGLE = "
+                },
+                {
+                  "kind": "Content",
+                  "text": "\"PLAYER_CAMERA.SET_SHOULDER_ANGLE\""
+                }
+              ],
+              "initializerTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "releaseTag": "Public",
+              "name": "SET_SHOULDER_ANGLE"
+            },
             {
               "kind": "EnumMember",
               "canonicalReference": "server!PlayerCameraEvent.SET_TRACKED_ENTITY:member",
@@ -29689,6 +29821,51 @@
                 "endIndex": 8
               }
             },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "server!PlayerCameraEventPayloads#\"PLAYER_CAMERA.SET_SHOULDER_ANGLE\":member",
+              "docComment": "/**\n * Emitted when the shoulder angle of the camera is set.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "["
+                },
+                {
+                  "kind": "Reference",
+                  "text": "PlayerCameraEvent.SET_SHOULDER_ANGLE",
+                  "canonicalReference": "server!PlayerCameraEvent.SET_SHOULDER_ANGLE:member"
+                },
+                {
+                  "kind": "Content",
+                  "text": "]: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "{\n        playerCamera: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "PlayerCamera",
+                  "canonicalReference": "server!PlayerCamera:class"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";\n        shoulderAngle: number;\n    }"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "\"PLAYER_CAMERA.SET_SHOULDER_ANGLE\"",
+              "propertyTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 6
+              }
+            },
             {
               "kind": "PropertySignature",
               "canonicalReference": "server!PlayerCameraEventPayloads#\"PLAYER_CAMERA.SET_TRACKED_ENTITY\":member",
@@ -34141,12 +34318,12 @@
             },
             {
               "kind": "Method",
-              "canonicalReference": "server!RigidBody#createAndAddChildCollidersToSimulation:member(1)",
-              "docComment": "/**\n * Creates and adds multiple child colliders to the rigid body for the simulation it belongs to.\n *\n * @param colliderOptions - The options for the child colliders to add to the rigid body.\n *\n * @returns The child colliders that were added to the rigid body.\n */\n",
+              "canonicalReference": "server!RigidBody#createAndAddChildColliders:member(1)",
+              "docComment": "/**\n * Creates and adds multiple child colliders to the rigid body for the simulation it belongs to.\n *\n * @remarks\n *\n * If the rigid body is not simulated, the colliders will be added to the rigid body as pending child colliders and also simulated when the rigid body is simulated.\n *\n * @param colliderOptions - The options for the child colliders to add to the rigid body.\n *\n * @returns The child colliders that were added to the rigid body.\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
-                  "text": "createAndAddChildCollidersToSimulation(colliderOptions: "
+                  "text": "createAndAddChildColliders(colliderOptions: "
                 },
                 {
                   "kind": "Reference",
@@ -34195,7 +34372,7 @@
               ],
               "isOptional": false,
               "isAbstract": false,
-              "name": "createAndAddChildCollidersToSimulation"
+              "name": "createAndAddChildColliders"
             },
             {
               "kind": "Property",
@@ -38750,6 +38927,39 @@
           "name": "SimpleEntityController",
           "preserveMemberOrder": false,
           "members": [
+            {
+              "kind": "Constructor",
+              "canonicalReference": "server!SimpleEntityController:constructor(1)",
+              "docComment": "/**\n * Constructs a new instance of the `SimpleEntityController` class\n *\n * @param options - Options for the controller.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "constructor(options?: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "SimpleEntityControllerOptions",
+                  "canonicalReference": "server!~SimpleEntityControllerOptions:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ");"
+                }
+              ],
+              "releaseTag": "Public",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "options",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": true
+                }
+              ]
+            },
             {
               "kind": "Method",
               "canonicalReference": "server!SimpleEntityController#face:member(1)",
@@ -39190,6 +39400,68 @@
               "isOptional": false,
               "isAbstract": false,
               "name": "spawn"
+            },
+            {
+              "kind": "Method",
+              "canonicalReference": "server!SimpleEntityController#stopFace:member(1)",
+              "docComment": "/**\n * Stops the entity from attempting to face a target coordinate.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "stopFace(): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "void"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "releaseTag": "Public",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "stopFace"
+            },
+            {
+              "kind": "Method",
+              "canonicalReference": "server!SimpleEntityController#stopMove:member(1)",
+              "docComment": "/**\n * Stops the entity from continuing to move it's current target coordinate.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "stopMove(): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "void"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "releaseTag": "Public",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "stopMove"
             }
           ],
           "extendsTokenRange": {
@@ -40150,7 +40422,7 @@
             },
             {
               "kind": "Content",
-              "text": "readonly [\"w\", \"a\", \"s\", \"d\", \"sp\", \"sh\", \"tb\", \"ml\", \"mr\", \"q\", \"e\", \"r\", \"f\", \"z\", \"x\", \"c\", \"v\", \"1\", \"2\", \"3\", \"4\", \"5\", \"6\", \"7\", \"8\", \"9\", \"0\"]"
+              "text": "readonly [\"w\", \"a\", \"s\", \"d\", \"sp\", \"sh\", \"tb\", \"ml\", \"mr\", \"q\", \"e\", \"r\", \"f\", \"z\", \"x\", \"c\", \"v\", \"u\", \"i\", \"o\", \"j\", \"k\", \"l\", \"n\", \"m\", \"1\", \"2\", \"3\", \"4\", \"5\", \"6\", \"7\", \"8\", \"9\", \"0\"]"
             }
           ],
           "fileUrlPath": "src/players/Player.ts",