hytopia 0.1.88 → 0.1.90

package/server.api.json

@@ -10694,6 +10694,109 @@
               "isAbstract": false,
               "name": "setOpacity"
             },
+            {
+              "kind": "Method",
+              "canonicalReference": "server!Entity#setParent:member(1)",
+              "docComment": "/**\n * Sets the parent of the entity and resets this entity's position and rotation.\n *\n * @remarks\n *\n * When setting the parent, all forces, torques and velocities of this entity are reset. Additionally, this entity's type will be set to `KINEMATIC_VELOCITY` if it is not already. All colliders of this entity will be disabled when parent is not undefined. If the provided parent is undefined, this entity will be removed from its parent and all colliders will be re-enabled. When setting an undefined parent to remove this entity from its parent, this entity's type will be set to the last type it was set to before being a child.\n *\n * @param parent - The parent entity to set, or undefined to remove from an existing parent.\n *\n * @param parentNodeName - The name of the parent's node (if parent is a model entity) this entity will attach to.\n *\n * @param position - The position to set for the entity. If parent is provided, this is relative to the parent's attachment point.\n *\n * @param rotation - The rotation to set for the entity. If parent is provided, this is relative to the parent's rotation.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "setParent(parent: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Entity",
+                  "canonicalReference": "server!Entity:class"
+                },
+                {
+                  "kind": "Content",
+                  "text": " | undefined"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", parentNodeName?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", position?: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Vector3Like",
+                  "canonicalReference": "server!Vector3Like:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", rotation?: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "QuaternionLike",
+                  "canonicalReference": "server!QuaternionLike:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "void"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 10,
+                "endIndex": 11
+              },
+              "releaseTag": "Public",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "parent",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 3
+                  },
+                  "isOptional": false
+                },
+                {
+                  "parameterName": "parentNodeName",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 4,
+                    "endIndex": 5
+                  },
+                  "isOptional": true
+                },
+                {
+                  "parameterName": "position",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 6,
+                    "endIndex": 7
+                  },
+                  "isOptional": true
+                },
+                {
+                  "parameterName": "rotation",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 8,
+                    "endIndex": 9
+                  },
+                  "isOptional": true
+                }
+              ],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "setParent"
+            },
             {
               "kind": "Method",
               "canonicalReference": "server!Entity#setTintColor:member(1)",
@@ -11367,6 +11470,110 @@
               ],
               "extendsTokenRanges": []
             },
+            {
+              "kind": "Interface",
+              "canonicalReference": "server!EntityEventPayload.SetParent:interface",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "interface SetParent "
+                }
+              ],
+              "releaseTag": "Public",
+              "name": "SetParent",
+              "preserveMemberOrder": false,
+              "members": [
+                {
+                  "kind": "PropertySignature",
+                  "canonicalReference": "server!EntityEventPayload.SetParent#entity:member",
+                  "docComment": "",
+                  "excerptTokens": [
+                    {
+                      "kind": "Content",
+                      "text": "entity: "
+                    },
+                    {
+                      "kind": "Reference",
+                      "text": "Entity",
+                      "canonicalReference": "server!Entity:class"
+                    },
+                    {
+                      "kind": "Content",
+                      "text": ";"
+                    }
+                  ],
+                  "isReadonly": false,
+                  "isOptional": false,
+                  "releaseTag": "Public",
+                  "name": "entity",
+                  "propertyTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  }
+                },
+                {
+                  "kind": "PropertySignature",
+                  "canonicalReference": "server!EntityEventPayload.SetParent#parent:member",
+                  "docComment": "",
+                  "excerptTokens": [
+                    {
+                      "kind": "Content",
+                      "text": "parent: "
+                    },
+                    {
+                      "kind": "Reference",
+                      "text": "Entity",
+                      "canonicalReference": "server!Entity:class"
+                    },
+                    {
+                      "kind": "Content",
+                      "text": " | undefined"
+                    },
+                    {
+                      "kind": "Content",
+                      "text": ";"
+                    }
+                  ],
+                  "isReadonly": false,
+                  "isOptional": false,
+                  "releaseTag": "Public",
+                  "name": "parent",
+                  "propertyTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 3
+                  }
+                },
+                {
+                  "kind": "PropertySignature",
+                  "canonicalReference": "server!EntityEventPayload.SetParent#parentNodeName:member",
+                  "docComment": "",
+                  "excerptTokens": [
+                    {
+                      "kind": "Content",
+                      "text": "parentNodeName: "
+                    },
+                    {
+                      "kind": "Content",
+                      "text": "string | undefined"
+                    },
+                    {
+                      "kind": "Content",
+                      "text": ";"
+                    }
+                  ],
+                  "isReadonly": false,
+                  "isOptional": false,
+                  "releaseTag": "Public",
+                  "name": "parentNodeName",
+                  "propertyTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  }
+                }
+              ],
+              "extendsTokenRanges": []
+            },
             {
               "kind": "Interface",
               "canonicalReference": "server!EntityEventPayload.SetTintColor:interface",
@@ -11967,6 +12174,27 @@
               "releaseTag": "Public",
               "name": "SET_OPACITY"
             },
+            {
+              "kind": "EnumMember",
+              "canonicalReference": "server!EntityEventType.SET_PARENT:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "SET_PARENT = "
+                },
+                {
+                  "kind": "Content",
+                  "text": "\"ENTITY.SET_PARENT\""
+                }
+              ],
+              "initializerTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "releaseTag": "Public",
+              "name": "SET_PARENT"
+            },
             {
               "kind": "EnumMember",
               "canonicalReference": "server!EntityEventType.SET_TINT_COLOR:member",
@@ -25663,6 +25891,130 @@
               "isAbstract": false,
               "name": "removeFromSimulation"
             },
+            {
+              "kind": "Method",
+              "canonicalReference": "server!RigidBody#resetAngularVelocity:member(1)",
+              "docComment": "/**\n * Resets the angular velocity of the rigid body.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "resetAngularVelocity(): "
+                },
+                {
+                  "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": "resetAngularVelocity"
+            },
+            {
+              "kind": "Method",
+              "canonicalReference": "server!RigidBody#resetForces:member(1)",
+              "docComment": "/**\n * Resets the forces actiong on the rigid body.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "resetForces(): "
+                },
+                {
+                  "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": "resetForces"
+            },
+            {
+              "kind": "Method",
+              "canonicalReference": "server!RigidBody#resetLinearVelocity:member(1)",
+              "docComment": "/**\n * Resets the linear velocity of the rigid body.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "resetLinearVelocity(): "
+                },
+                {
+                  "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": "resetLinearVelocity"
+            },
+            {
+              "kind": "Method",
+              "canonicalReference": "server!RigidBody#resetTorques:member(1)",
+              "docComment": "/**\n * Resets the torques acting on the rigid body.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "resetTorques(): "
+                },
+                {
+                  "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": "resetTorques"
+            },
             {
               "kind": "Property",
               "canonicalReference": "server!RigidBody#rotation:member",
@@ -32886,6 +33238,42 @@
                 "startIndex": 1,
                 "endIndex": 3
               }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "server!WorldMap#entities:member",
+              "docComment": "/**\n * The entities in the map.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "entities: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "{\n        [position: string]: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "EntityOptions",
+                  "canonicalReference": "server!EntityOptions:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";\n    }"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "entities",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 4
+              }
             }
           ],
           "extendsTokenRanges": []

package/server.d.ts

@@ -1363,6 +1363,7 @@ export declare class Entity extends RigidBody implements protocol.Serializable {
 
 
 
+
     /**
      * @param options - The options for the entity.
      */
@@ -1444,6 +1445,23 @@ export declare class Entity extends RigidBody implements protocol.Serializable {
      * @param opacity - The opacity of the entity between 0 and 1. 0 is fully transparent, 1 is fully opaque.
      */
     setOpacity(opacity: number): void;
+    /**
+     * Sets the parent of the entity and resets this entity's position and rotation.
+     *
+     * @remarks
+     * When setting the parent, all forces, torques and velocities of this entity are reset.
+     * Additionally, this entity's type will be set to `KINEMATIC_VELOCITY` if it is not already.
+     * All colliders of this entity will be disabled when parent is not undefined. If the provided parent
+     * is undefined, this entity will be removed from its parent and all colliders will be re-enabled.
+     * When setting an undefined parent to remove this entity from its parent, this entity's type
+     * will be set to the last type it was set to before being a child.
+     *
+     * @param parent - The parent entity to set, or undefined to remove from an existing parent.
+     * @param parentNodeName - The name of the parent's node (if parent is a model entity) this entity will attach to.
+     * @param position - The position to set for the entity. If parent is provided, this is relative to the parent's attachment point.
+     * @param rotation - The rotation to set for the entity. If parent is provided, this is relative to the parent's rotation.
+     */
+    setParent(parent: Entity | undefined, parentNodeName?: string, position?: Vector3Like, rotation?: QuaternionLike): void;
     /**
      * Sets the tint color of the entity.
      * @param tintColor - The tint color of the entity.
@@ -1506,6 +1524,11 @@ export declare namespace EntityEventPayload {
         entity: Entity;
         opacity: number;
     }
+    export interface SetParent {
+        entity: Entity;
+        parent: Entity | undefined;
+        parentNodeName: string | undefined;
+    }
     export interface SetTintColor {
         entity: Entity;
         tintColor: RgbColor | undefined;
@@ -1541,6 +1564,7 @@ export declare enum EntityEventType {
     SET_MODEL_ANIMATIONS_PLAYBACK_RATE = "ENTITY.SET_MODEL_ANIMATIONS_PLAYBACK_RATE",
     SET_MODEL_HIDDEN_NODES = "ENTITY.SET_MODEL_HIDDEN_NODES",
     SET_OPACITY = "ENTITY.SET_OPACITY",
+    SET_PARENT = "ENTITY.SET_PARENT",
     SET_TINT_COLOR = "ENTITY.SET_TINT_COLOR",
     SPAWN = "ENTITY.SPAWN",
     START_MODEL_LOOPED_ANIMATIONS = "ENTITY.START_MODEL_LOOPED_ANIMATIONS",
@@ -3277,6 +3301,22 @@ export declare class RigidBody {
      */
     removeFromSimulation(): void;
 
+    /**
+     * Resets the angular velocity of the rigid body.
+     */
+    resetAngularVelocity(): void;
+    /**
+     * Resets the forces actiong on the rigid body.
+     */
+    resetForces(): void;
+    /**
+     * Resets the linear velocity of the rigid body.
+     */
+    resetLinearVelocity(): void;
+    /**
+     * Resets the torques acting on the rigid body.
+     */
+    resetTorques(): void;
     /**
      * Explicitly puts the rigid body to sleep. Physics otherwise optimizes sleeping.
      */
@@ -4128,6 +4168,11 @@ export declare interface WorldMap {
         /** The global coordinate to block type id mapping. */
         [coordinate: string]: number;
     };
+    /** The entities in the map. */
+    entities: {
+        /** The position to entity as entity options mapping. */
+        [position: string]: EntityOptions;
+    };
 }
 
 /** Options for creating a World instance. @public */