hytopia 0.1.78 → 0.1.80

package/docs/server.entity.despawn.md

@@ -4,7 +4,7 @@
 
 ## Entity.despawn() method
 
-Despawns the entity from the world.
+Despawns the entity and all children from the world.
 
 **Signature:**
 

package/docs/server.entity.md

@@ -528,6 +528,48 @@ number \| undefined
 The opacity of the entity between 0 and 1. 0 is fully transparent, 1 is fully opaque.
 
 
+</td></tr>
+<tr><td>
+
+[parent](./server.entity.parent.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+[Entity](./server.entity.md) \| undefined
+
+
+</td><td>
+
+The parent entity of the entity.
+
+
+</td></tr>
+<tr><td>
+
+[parentNodeName](./server.entity.parentnodename.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+string \| undefined
+
+
+</td><td>
+
+The name of the parent's node (if parent is a model entity) this entity is attached to when spawned.
+
+
 </td></tr>
 <tr><td>
 
@@ -622,7 +664,7 @@ Description
 
 </td><td>
 
-Despawns the entity from the world.
+Despawns the entity and all children from the world.
 
 
 </td></tr>
@@ -698,7 +740,7 @@ Sets the tint color of the entity.
 </td></tr>
 <tr><td>
 
-[spawn(world, coordinate)](./server.entity.spawn.md)
+[spawn(world, position, rotation)](./server.entity.spawn.md)
 
 
 </td><td>

package/docs/server.entity.parent.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [Entity](./server.entity.md) &gt; [parent](./server.entity.parent.md)
+
+## Entity.parent property
+
+The parent entity of the entity.
+
+**Signature:**
+
+```typescript
+get parent(): Entity | undefined;
+```

package/docs/server.entity.parentnodename.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [Entity](./server.entity.md) &gt; [parentNodeName](./server.entity.parentnodename.md)
+
+## Entity.parentNodeName property
+
+The name of the parent's node (if parent is a model entity) this entity is attached to when spawned.
+
+**Signature:**
+
+```typescript
+get parentNodeName(): string | undefined;
+```

package/docs/server.entity.spawn.md

@@ -9,7 +9,7 @@ Spawns the entity in the world.
 **Signature:**
 
 ```typescript
-spawn(world: World, coordinate: Vector3Like): void;
+spawn(world: World, position: Vector3Like, rotation?: QuaternionLike): void;
 ```
 
 ## Parameters
@@ -48,7 +48,7 @@ The world to spawn the entity in.
 </td></tr>
 <tr><td>
 
-coordinate
+position
 
 
 </td><td>
@@ -58,7 +58,23 @@ coordinate
 
 </td><td>
 
-The coordinate to spawn the entity at.
+The position to spawn the entity at.
+
+
+</td></tr>
+<tr><td>
+
+rotation
+
+
+</td><td>
+
+[QuaternionLike](./server.quaternionlike.md)
+
+
+</td><td>
+
+_(Optional)_ The optional rotation to spawn the entity with.
 
 
 </td></tr>

package/docs/server.entitymanager.getentitychildren.md

@@ -0,0 +1,55 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [EntityManager](./server.entitymanager.md) &gt; [getEntityChildren](./server.entitymanager.getentitychildren.md)
+
+## EntityManager.getEntityChildren() method
+
+Gets all child entities of an entity.
+
+**Signature:**
+
+```typescript
+getEntityChildren(entity: Entity): Entity[];
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+entity
+
+
+</td><td>
+
+[Entity](./server.entity.md)
+
+
+</td><td>
+
+The entity to get the children for.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+[Entity](./server.entity.md)<!-- -->\[\]
+
+All child entities of the entity.
+

package/docs/server.entitymanager.md

@@ -160,6 +160,20 @@ Gets all spawned entities in the world with a tag that includes a specific subst
 Gets a spawned entity in the world by its id.
 
 
+</td></tr>
+<tr><td>
+
+[getEntityChildren(entity)](./server.entitymanager.getentitychildren.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Gets all child entities of an entity.
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.entityoptions.md

@@ -224,6 +224,44 @@ number
 _(Optional)_ The opacity of the entity between 0 and 1. 0 is fully transparent, 1 is fully opaque.
 
 
+</td></tr>
+<tr><td>
+
+[parent?](./server.entityoptions.parent.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[Entity](./server.entity.md)
+
+
+</td><td>
+
+_(Optional)_ The parent entity of the entity, entities with a parent will ignore creating their own colliders.
+
+
+</td></tr>
+<tr><td>
+
+[parentNodeName?](./server.entityoptions.parentnodename.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+_(Optional)_ The name of the parent's node (if parent is a model entity) to attach the entity to.
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.entityoptions.parent.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [EntityOptions](./server.entityoptions.md) &gt; [parent](./server.entityoptions.parent.md)
+
+## EntityOptions.parent property
+
+The parent entity of the entity, entities with a parent will ignore creating their own colliders.
+
+**Signature:**
+
+```typescript
+parent?: Entity;
+```

package/docs/server.entityoptions.parentnodename.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [EntityOptions](./server.entityoptions.md) &gt; [parentNodeName](./server.entityoptions.parentnodename.md)
+
+## EntityOptions.parentNodeName property
+
+The name of the parent's node (if parent is a model entity) to attach the entity to.
+
+**Signature:**
+
+```typescript
+parentNodeName?: string;
+```

package/docs/server.modelregistry.getnodenames.md

@@ -0,0 +1,55 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [ModelRegistry](./server.modelregistry.md) &gt; [getNodeNames](./server.modelregistry.getnodenames.md)
+
+## ModelRegistry.getNodeNames() method
+
+Retrieves the names of all nodes in a model.
+
+**Signature:**
+
+```typescript
+getNodeNames(modelUri: string): string[];
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+modelUri
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+The URI of the model to retrieve the node names for.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+string\[\]
+
+The names of all nodes in the model.
+

package/docs/server.modelregistry.md

@@ -107,5 +107,33 @@ Description
 Retrieves the bounding box of a model.
 
 
+</td></tr>
+<tr><td>
+
+[getNodeNames(modelUri)](./server.modelregistry.getnodenames.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Retrieves the names of all nodes in a model.
+
+
+</td></tr>
+<tr><td>
+
+[modelHasNode(modelUri, nodeName)](./server.modelregistry.modelhasnode.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Checks if a model has a node with the given name.
+
+
 </td></tr>
 </tbody></table>

package/docs/server.modelregistry.modelhasnode.md

@@ -0,0 +1,71 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [ModelRegistry](./server.modelregistry.md) &gt; [modelHasNode](./server.modelregistry.modelhasnode.md)
+
+## ModelRegistry.modelHasNode() method
+
+Checks if a model has a node with the given name.
+
+**Signature:**
+
+```typescript
+modelHasNode(modelUri: string, nodeName: string): boolean;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+modelUri
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+The URI of the model to check.
+
+
+</td></tr>
+<tr><td>
+
+nodeName
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+The name of the node to check for.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+boolean
+
+Whether the model has a node with the given name.
+

package/examples/child-entity/README.md

@@ -0,0 +1,3 @@
+# child-entity
+
+An example showing how to spawn an entity as a child of another entity. In this example, we spawn a sword entity in the hand of the player entity.