hytopia 0.1.73 → 0.1.75

package/docs/server.player.input.md

@@ -9,5 +9,5 @@ The current [PlayerInput](./server.playerinput.md) of the player.
 **Signature:**
 
 ```typescript
-get input(): Readonly<PlayerInput>;
+get input(): PlayerInput;
 ```

package/docs/server.player.md

@@ -95,7 +95,7 @@ The unique identifier for the player.
 
 </td><td>
 
-Readonly&lt;[PlayerInput](./server.playerinput.md)<!-- -->&gt;
+[PlayerInput](./server.playerinput.md)
 
 
 </td><td>

package/docs/{server.rigidbody.createandaddchildcollidertosimulation.md → server.rigidbody.createandaddchildcollider.md}

@@ -1,15 +1,15 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [server](./server.md) &gt; [RigidBody](./server.rigidbody.md) &gt; [createAndAddChildColliderToSimulation](./server.rigidbody.createandaddchildcollidertosimulation.md)
+[Home](./index.md) &gt; [server](./server.md) &gt; [RigidBody](./server.rigidbody.md) &gt; [createAndAddChildCollider](./server.rigidbody.createandaddchildcollider.md)
 
-## RigidBody.createAndAddChildColliderToSimulation() method
+## RigidBody.createAndAddChildCollider() method
 
 Creates and adds a child collider to the rigid body for the simulation it belongs to.
 
 **Signature:**
 
 ```typescript
-createAndAddChildColliderToSimulation(colliderOptions: ColliderOptions): Collider;
+createAndAddChildCollider(colliderOptions: ColliderOptions): Collider;
 ```
 
 ## Parameters
@@ -53,3 +53,7 @@ The options for the child collider to add.
 
 The child collider that was added to the rigid body.
 
+## Remarks
+
+If the rigid body is not simulated, the collider will be added to the rigid body as a pending child collider and also simulated when the rigid body is simulated.
+

package/docs/server.rigidbody.md

@@ -1054,7 +1054,7 @@ Applies a torque impulse to the rigid body.
 </td></tr>
 <tr><td>
 
-[createAndAddChildCollidersToSimulation(colliderOptions)](./server.rigidbody.createandaddchildcolliderstosimulation.md)
+[createAndAddChildCollider(colliderOptions)](./server.rigidbody.createandaddchildcollider.md)
 
 
 </td><td>
@@ -1062,13 +1062,13 @@ Applies a torque impulse to the rigid body.
 
 </td><td>
 
-Creates and adds multiple child colliders to the rigid body for the simulation it belongs to.
+Creates and adds a child collider to the rigid body for the simulation it belongs to.
 
 
 </td></tr>
 <tr><td>
 
-[createAndAddChildColliderToSimulation(colliderOptions)](./server.rigidbody.createandaddchildcollidertosimulation.md)
+[createAndAddChildCollidersToSimulation(colliderOptions)](./server.rigidbody.createandaddchildcolliderstosimulation.md)
 
 
 </td><td>
@@ -1076,7 +1076,7 @@ Creates and adds multiple child colliders to the rigid body for the simulation i
 
 </td><td>
 
-Creates and adds a child collider to the rigid body for the simulation it belongs to.
+Creates and adds multiple child colliders to the rigid body for the simulation it belongs to.
 
 
 </td></tr>

package/examples/entity-controller/MyEntityController.ts

@@ -135,7 +135,7 @@ export default class MyEntityController extends BaseEntityController {
     }
 
     // Ground sensor
-    entity.createAndAddChildColliderToSimulation({
+    entity.createAndAddChildCollider({
       shape: ColliderShape.CYLINDER,
       radius: 0.23,
       halfHeight: 0.125,
@@ -169,7 +169,7 @@ export default class MyEntityController extends BaseEntityController {
 
 
     // Wall collider
-    entity.createAndAddChildColliderToSimulation({
+    entity.createAndAddChildCollider({
       shape: ColliderShape.CAPSULE,
       halfHeight: 0.30,
       radius: 0.37,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hytopia",
-  "version": "0.1.73",
+  "version": "0.1.75",
   "description": "The HYTOPIA SDK makes it easy for developers to create massively multiplayer games using JavaScript or TypeScript.",
   "main": "server.js",
   "bin": {

package/server.api.json

@@ -16992,24 +16992,11 @@
                   "kind": "Content",
                   "text": "get input(): "
                 },
-                {
-                  "kind": "Reference",
-                  "text": "Readonly",
-                  "canonicalReference": "!Readonly:type"
-                },
-                {
-                  "kind": "Content",
-                  "text": "<"
-                },
                 {
                   "kind": "Reference",
                   "text": "PlayerInput",
                   "canonicalReference": "server!PlayerInput:type"
                 },
-                {
-                  "kind": "Content",
-                  "text": ">"
-                },
                 {
                   "kind": "Content",
                   "text": ";"
@@ -17021,7 +17008,7 @@
               "name": "input",
               "propertyTypeTokenRange": {
                 "startIndex": 1,
-                "endIndex": 5
+                "endIndex": 2
               },
               "isStatic": false,
               "isProtected": false,
@@ -24023,22 +24010,18 @@
             },
             {
               "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#createAndAddChildCollider:member(1)",
+              "docComment": "/**\n * Creates and adds a child collider to the rigid body for the simulation it belongs to.\n *\n * @remarks\n *\n * If the rigid body is not simulated, the collider will be added to the rigid body as a pending child collider and also simulated when the rigid body is simulated.\n *\n * @param colliderOptions - The options for the child collider to add.\n *\n * @returns The child collider that was added to the rigid body.\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
-                  "text": "createAndAddChildCollidersToSimulation(colliderOptions: "
+                  "text": "createAndAddChildCollider(colliderOptions: "
                 },
                 {
                   "kind": "Reference",
                   "text": "ColliderOptions",
                   "canonicalReference": "server!ColliderOptions:interface"
                 },
-                {
-                  "kind": "Content",
-                  "text": "[]"
-                },
                 {
                   "kind": "Content",
                   "text": "): "
@@ -24048,10 +24031,6 @@
                   "text": "Collider",
                   "canonicalReference": "server!Collider:class"
                 },
-                {
-                  "kind": "Content",
-                  "text": "[]"
-                },
                 {
                   "kind": "Content",
                   "text": ";"
@@ -24059,8 +24038,8 @@
               ],
               "isStatic": false,
               "returnTypeTokenRange": {
-                "startIndex": 4,
-                "endIndex": 6
+                "startIndex": 3,
+                "endIndex": 4
               },
               "releaseTag": "Public",
               "isProtected": false,
@@ -24070,29 +24049,33 @@
                   "parameterName": "colliderOptions",
                   "parameterTypeTokenRange": {
                     "startIndex": 1,
-                    "endIndex": 3
+                    "endIndex": 2
                   },
                   "isOptional": false
                 }
               ],
               "isOptional": false,
               "isAbstract": false,
-              "name": "createAndAddChildCollidersToSimulation"
+              "name": "createAndAddChildCollider"
             },
             {
               "kind": "Method",
-              "canonicalReference": "server!RigidBody#createAndAddChildColliderToSimulation:member(1)",
-              "docComment": "/**\n * Creates and adds a child collider to the rigid body for the simulation it belongs to.\n *\n * @param colliderOptions - The options for the child collider to add.\n *\n * @returns The child collider that was added to the rigid body.\n */\n",
+              "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",
               "excerptTokens": [
                 {
                   "kind": "Content",
-                  "text": "createAndAddChildColliderToSimulation(colliderOptions: "
+                  "text": "createAndAddChildCollidersToSimulation(colliderOptions: "
                 },
                 {
                   "kind": "Reference",
                   "text": "ColliderOptions",
                   "canonicalReference": "server!ColliderOptions:interface"
                 },
+                {
+                  "kind": "Content",
+                  "text": "[]"
+                },
                 {
                   "kind": "Content",
                   "text": "): "
@@ -24102,6 +24085,10 @@
                   "text": "Collider",
                   "canonicalReference": "server!Collider:class"
                 },
+                {
+                  "kind": "Content",
+                  "text": "[]"
+                },
                 {
                   "kind": "Content",
                   "text": ";"
@@ -24109,8 +24096,8 @@
               ],
               "isStatic": false,
               "returnTypeTokenRange": {
-                "startIndex": 3,
-                "endIndex": 4
+                "startIndex": 4,
+                "endIndex": 6
               },
               "releaseTag": "Public",
               "isProtected": false,
@@ -24120,14 +24107,14 @@
                   "parameterName": "colliderOptions",
                   "parameterTypeTokenRange": {
                     "startIndex": 1,
-                    "endIndex": 2
+                    "endIndex": 3
                   },
                   "isOptional": false
                 }
               ],
               "isOptional": false,
               "isAbstract": false,
-              "name": "createAndAddChildColliderToSimulation"
+              "name": "createAndAddChildCollidersToSimulation"
             },
             {
               "kind": "Property",

package/server.d.ts

@@ -2170,7 +2170,7 @@ export declare class Player {
 
 
     /** The current {@link PlayerInput} of the player. */
-    get input(): Readonly<PlayerInput>;
+    get input(): PlayerInput;
     /** The current {@link World} the player is in. */
     get world(): World | undefined;
     /**
@@ -3194,10 +3194,15 @@ export declare class RigidBody {
     applyTorqueImpulse(impulse: Vector3Like): void;
     /**
      * Creates and adds a child collider to the rigid body for the simulation it belongs to.
+     *
+     * @remarks
+     * If the rigid body is not simulated, the collider will be added to the rigid body as a pending child collider
+     * and also simulated when the rigid body is simulated.
+     *
      * @param colliderOptions - The options for the child collider to add.
      * @returns The child collider that was added to the rigid body.
      */
-    createAndAddChildColliderToSimulation(colliderOptions: ColliderOptions): Collider;
+    createAndAddChildCollider(colliderOptions: ColliderOptions): Collider;
     /**
      * Creates and adds multiple child colliders to the rigid body for the simulation it belongs to.
      * @param colliderOptions - The options for the child colliders to add to the rigid body.