hytopia 0.1.77 → 0.1.79

package/server.api.json

@@ -9692,7 +9692,7 @@
             {
               "kind": "Method",
               "canonicalReference": "server!Entity#despawn:member(1)",
-              "docComment": "/**\n * Despawns the entity from the world.\n */\n",
+              "docComment": "/**\n * Despawns the entity and all children from the world.\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -10423,6 +10423,71 @@
               "isProtected": false,
               "isAbstract": false
             },
+            {
+              "kind": "Property",
+              "canonicalReference": "server!Entity#parent:member",
+              "docComment": "/**\n * The parent entity of the entity.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "get parent(): "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Entity",
+                  "canonicalReference": "server!Entity:class"
+                },
+                {
+                  "kind": "Content",
+                  "text": " | undefined"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": true,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "parent",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 3
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
+            {
+              "kind": "Property",
+              "canonicalReference": "server!Entity#parentNodeName:member",
+              "docComment": "/**\n * The name of the parent's node (if parent is a model entity) this entity is attached to when spawned.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "get parentNodeName(): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string | undefined"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": true,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "parentNodeName",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
             {
               "kind": "Method",
               "canonicalReference": "server!Entity#setController:member(1)",
@@ -10676,7 +10741,7 @@
             {
               "kind": "Method",
               "canonicalReference": "server!Entity#spawn:member(1)",
-              "docComment": "/**\n * Spawns the entity in the world.\n *\n * @param world - The world to spawn the entity in.\n *\n * @param coordinate - The coordinate to spawn the entity at.\n */\n",
+              "docComment": "/**\n * Spawns the entity in the world.\n *\n * @param world - The world to spawn the entity in.\n *\n * @param position - The position to spawn the entity at.\n *\n * @param rotation - The optional rotation to spawn the entity with.\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -10689,13 +10754,22 @@
                 },
                 {
                   "kind": "Content",
-                  "text": ", coordinate: "
+                  "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": "): "
@@ -10711,8 +10785,8 @@
               ],
               "isStatic": false,
               "returnTypeTokenRange": {
-                "startIndex": 5,
-                "endIndex": 6
+                "startIndex": 7,
+                "endIndex": 8
               },
               "releaseTag": "Public",
               "isProtected": false,
@@ -10727,12 +10801,20 @@
                   "isOptional": false
                 },
                 {
-                  "parameterName": "coordinate",
+                  "parameterName": "position",
                   "parameterTypeTokenRange": {
                     "startIndex": 3,
                     "endIndex": 4
                   },
                   "isOptional": false
+                },
+                {
+                  "parameterName": "rotation",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 5,
+                    "endIndex": 6
+                  },
+                  "isOptional": true
                 }
               ],
               "isOptional": false,
@@ -12289,6 +12371,60 @@
               "isAbstract": false,
               "name": "getEntity"
             },
+            {
+              "kind": "Method",
+              "canonicalReference": "server!EntityManager#getEntityChildren:member(1)",
+              "docComment": "/**\n * Gets all child entities of an entity.\n *\n * @param entity - The entity to get the children for.\n *\n * @returns All child entities of the entity.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "getEntityChildren(entity: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Entity",
+                  "canonicalReference": "server!Entity:class"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Entity",
+                  "canonicalReference": "server!Entity:class"
+                },
+                {
+                  "kind": "Content",
+                  "text": "[]"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 5
+              },
+              "releaseTag": "Public",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "entity",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                }
+              ],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "getEntityChildren"
+            },
             {
               "kind": "Method",
               "canonicalReference": "server!EntityManager#getPlayerEntitiesByPlayer:member(1)",
@@ -12664,6 +12800,61 @@
                 "endIndex": 2
               }
             },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "server!EntityOptions#parent:member",
+              "docComment": "/**\n * The parent entity of the entity, entities with a parent will ignore creating their own colliders.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "parent?: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Entity",
+                  "canonicalReference": "server!Entity:class"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "parent",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "server!EntityOptions#parentNodeName:member",
+              "docComment": "/**\n * The name of the parent's node (if parent is a model entity) to attach the entity to.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "parentNodeName?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "parentNodeName",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
             {
               "kind": "PropertySignature",
               "canonicalReference": "server!EntityOptions#rigidBodyOptions:member",
@@ -13664,17 +13855,17 @@
             },
             {
               "kind": "Property",
-              "canonicalReference": "server!GameServer#modelManager:member",
+              "canonicalReference": "server!GameServer#modelRegistry:member",
               "docComment": "/**\n * The model manager for the game server.\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
-                  "text": "get modelManager(): "
+                  "text": "get modelRegistry(): "
                 },
                 {
                   "kind": "Reference",
-                  "text": "ModelManager",
-                  "canonicalReference": "server!ModelManager:class"
+                  "text": "ModelRegistry",
+                  "canonicalReference": "server!ModelRegistry:class"
                 },
                 {
                   "kind": "Content",
@@ -13684,7 +13875,7 @@
               "isReadonly": true,
               "isOptional": false,
               "releaseTag": "Public",
-              "name": "modelManager",
+              "name": "modelRegistry",
               "propertyTypeTokenRange": {
                 "startIndex": 1,
                 "endIndex": 2
@@ -16691,23 +16882,23 @@
         },
         {
           "kind": "Class",
-          "canonicalReference": "server!ModelManager:class",
-          "docComment": "/**\n * Manages model data for all known models of the game.\n *\n * @remarks\n *\n * The ModelManager is created internally as a global singletone accessible with the static property `ModelManager.instance`.\n *\n * The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `ModelManager` class.\n *\n * @example\n * ```typescript\n * import { ModelManager } from 'hytopia';\n *\n * const modelManager = ModelManager.instance;\n * const boundingBox = modelManager.getBoundingBox('models/player.gltf');\n * ```\n *\n * @public\n */\n",
+          "canonicalReference": "server!ModelRegistry:class",
+          "docComment": "/**\n * Manages model data for all known models of the game.\n *\n * @remarks\n *\n * The ModelRegistry is created internally as a global singletone accessible with the static property `ModelRegistry.instance`.\n *\n * The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `ModelRegistry` class.\n *\n * @example\n * ```typescript\n * import { ModelRegistry } from 'hytopia';\n *\n * const modelRegistry = ModelRegistry.instance;\n * const boundingBox = modelRegistry.getBoundingBox('models/player.gltf');\n * ```\n *\n * @public\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
-              "text": "export default class ModelManager "
+              "text": "export default class ModelRegistry "
             }
           ],
-          "fileUrlPath": "src/models/ModelManager.ts",
+          "fileUrlPath": "src/models/ModelRegistry.ts",
           "releaseTag": "Public",
           "isAbstract": false,
-          "name": "ModelManager",
+          "name": "ModelRegistry",
           "preserveMemberOrder": false,
           "members": [
             {
               "kind": "Method",
-              "canonicalReference": "server!ModelManager#getBoundingBox:member(1)",
+              "canonicalReference": "server!ModelRegistry#getBoundingBox:member(1)",
               "docComment": "/**\n * Retrieves the bounding box of a model.\n *\n * @param modelUri - The URI of the model to retrieve the bounding box for.\n *\n * @returns The bounding box of the model.\n */\n",
               "excerptTokens": [
                 {
@@ -16754,10 +16945,58 @@
               "isAbstract": false,
               "name": "getBoundingBox"
             },
+            {
+              "kind": "Method",
+              "canonicalReference": "server!ModelRegistry#getNodeNames:member(1)",
+              "docComment": "/**\n * Retrieves the names of all nodes in a model.\n *\n * @param modelUri - The URI of the model to retrieve the node names for.\n *\n * @returns The names of all nodes in the model.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "getNodeNames(modelUri: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string[]"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 4
+              },
+              "releaseTag": "Public",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "modelUri",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                }
+              ],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "getNodeNames"
+            },
             {
               "kind": "Property",
-              "canonicalReference": "server!ModelManager.instance:member",
-              "docComment": "/**\n * The global PlayerManager instance as a singleton.\n */\n",
+              "canonicalReference": "server!ModelRegistry.instance:member",
+              "docComment": "/**\n * The global ModelRegistry instance as a singleton.\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -16765,8 +17004,8 @@
                 },
                 {
                   "kind": "Reference",
-                  "text": "ModelManager",
-                  "canonicalReference": "server!ModelManager:class"
+                  "text": "ModelRegistry",
+                  "canonicalReference": "server!ModelRegistry:class"
                 },
                 {
                   "kind": "Content",
@@ -16784,6 +17023,70 @@
               "isStatic": true,
               "isProtected": false,
               "isAbstract": false
+            },
+            {
+              "kind": "Method",
+              "canonicalReference": "server!ModelRegistry#modelHasNode:member(1)",
+              "docComment": "/**\n * Checks if a model has a node with the given name.\n *\n * @param modelUri - The URI of the model to check.\n *\n * @param nodeName - The name of the node to check for.\n *\n * @returns Whether the model has a node with the given name.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "modelHasNode(modelUri: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", nodeName: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "boolean"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 5,
+                "endIndex": 6
+              },
+              "releaseTag": "Public",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "modelUri",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                },
+                {
+                  "parameterName": "nodeName",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 3,
+                    "endIndex": 4
+                  },
+                  "isOptional": false
+                }
+              ],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "modelHasNode"
             }
           ],
           "implementsTokenRanges": []

package/server.d.ts

@@ -1359,6 +1359,8 @@ export declare class Entity extends RigidBody implements protocol.Serializable {
 
 
 
+
+
     /**
      * @param options - The options for the entity.
      */
@@ -1385,6 +1387,10 @@ export declare class Entity extends RigidBody implements protocol.Serializable {
     get name(): string;
     /** The opacity of the entity between 0 and 1. 0 is fully transparent, 1 is fully opaque. */
     get opacity(): number | undefined;
+    /** The parent entity of the entity. */
+    get parent(): Entity | undefined;
+    /** The name of the parent's node (if parent is a model entity) this entity is attached to when spawned. */
+    get parentNodeName(): string | undefined;
     /** An arbitrary identifier tag of the entity. Useful for your own logic. */
     get tag(): string | undefined;
     /** The tint color of the entity. */
@@ -1400,11 +1406,12 @@ export declare class Entity extends RigidBody implements protocol.Serializable {
     /**
      * Spawns the entity in the world.
      * @param world - The world to spawn the entity in.
-     * @param coordinate - The coordinate to spawn the entity at.
+     * @param position - The position to spawn the entity at.
+     * @param rotation - The optional rotation to spawn the entity with.
      */
-    spawn(world: World, coordinate: Vector3Like): void;
+    spawn(world: World, position: Vector3Like, rotation?: QuaternionLike): void;
     /**
-     * Despawns the entity from the world.
+     * Despawns the entity and all children from the world.
      */
     despawn(): void;
     /**
@@ -1602,6 +1609,12 @@ export declare class EntityManager {
      * @returns All spawned entities in the world with a tag that includes the provided substring.
      */
     getEntitiesByTagSubstring(tagSubstring: string): Entity[];
+    /**
+     * Gets all child entities of an entity.
+     * @param entity - The entity to get the children for.
+     * @returns All child entities of the entity.
+     */
+    getEntityChildren(entity: Entity): Entity[];
 
 
 }
@@ -1628,6 +1641,10 @@ export declare interface EntityOptions {
     name?: string;
     /** The opacity of the entity between 0 and 1. 0 is fully transparent, 1 is fully opaque. */
     opacity?: number;
+    /** The parent entity of the entity, entities with a parent will ignore creating their own colliders. */
+    parent?: Entity;
+    /** The name of the parent's node (if parent is a model entity) to attach the entity to. */
+    parentNodeName?: string;
     /** The rigid body options for the entity. */
     rigidBodyOptions?: RigidBodyOptions;
     /** An arbitrary identifier tag of the entity. Useful for your own logic. */
@@ -1768,7 +1785,7 @@ export declare class GameServer {
     /** The singleton instance of the game server. */
     static get instance(): GameServer;
     /** The model manager for the game server. */
-    get modelManager(): ModelManager;
+    get modelRegistry(): ModelRegistry;
     /** The player manager for the game server. */
     get playerManager(): PlayerManager;
 
@@ -2077,39 +2094,32 @@ export declare enum LightType {
 
 /** A bounding box for a model. @public */
 declare type ModelBoundingBox = {
-    min: {
-        x: number;
-        y: number;
-        z: number;
-    };
-    max: {
-        x: number;
-        y: number;
-        z: number;
-    };
+    min: Vector3Like;
+    max: Vector3Like;
 };
 
 /**
  * Manages model data for all known models of the game.
  *
  * @remarks
- * The ModelManager is created internally as a global
+ * The ModelRegistry is created internally as a global
  * singletone accessible with the static property
- * `ModelManager.instance`.
+ * `ModelRegistry.instance`.
  *
  * @example
  * ```typescript
- * import { ModelManager } from 'hytopia';
+ * import { ModelRegistry } from 'hytopia';
  *
- * const modelManager = ModelManager.instance;
- * const boundingBox = modelManager.getBoundingBox('models/player.gltf');
+ * const modelRegistry = ModelRegistry.instance;
+ * const boundingBox = modelRegistry.getBoundingBox('models/player.gltf');
  * ```
  *
  * @public
  */
-export declare class ModelManager {
-    /** The global PlayerManager instance as a singleton. */
-    static readonly instance: ModelManager;
+export declare class ModelRegistry {
+    /** The global ModelRegistry instance as a singleton. */
+    static readonly instance: ModelRegistry;
+
 
 
 
@@ -2121,6 +2131,21 @@ export declare class ModelManager {
      * @returns The bounding box of the model.
      */
     getBoundingBox(modelUri: string): ModelBoundingBox;
+    /**
+     * Retrieves the names of all nodes in a model.
+     *
+     * @param modelUri - The URI of the model to retrieve the node names for.
+     * @returns The names of all nodes in the model.
+     */
+    getNodeNames(modelUri: string): string[];
+    /**
+     * Checks if a model has a node with the given name.
+     *
+     * @param modelUri - The URI of the model to check.
+     * @param nodeName - The name of the node to check for.
+     * @returns Whether the model has a node with the given name.
+     */
+    modelHasNode(modelUri: string, nodeName: string): boolean;
 
 
 }