hytopia 0.1.88 → 0.1.90

package/boilerplate/index.ts

@@ -122,7 +122,7 @@ startServer(world => {
    */
   
   new Audio({
-    uri: 'audio/music/overworld.mp3',
+    uri: 'audio/music/hytopia-main.mp3',
     loop: true,
     volume: 0.1,
   }).play(world);

package/docs/server.entity.md

@@ -723,6 +723,20 @@ Sets the nodes to hide on the entity's model. Matched nodes will be hidden for a
 Sets the opacity of the entity.
 
 
+</td></tr>
+<tr><td>
+
+[setParent(parent, parentNodeName, position, rotation)](./server.entity.setparent.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Sets the parent of the entity and resets this entity's position and rotation.
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.entity.setparent.md

@@ -0,0 +1,105 @@
+<!-- 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; [setParent](./server.entity.setparent.md)
+
+## Entity.setParent() method
+
+Sets the parent of the entity and resets this entity's position and rotation.
+
+**Signature:**
+
+```typescript
+setParent(parent: Entity | undefined, parentNodeName?: string, position?: Vector3Like, rotation?: QuaternionLike): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+parent
+
+
+</td><td>
+
+[Entity](./server.entity.md) \| undefined
+
+
+</td><td>
+
+The parent entity to set, or undefined to remove from an existing parent.
+
+
+</td></tr>
+<tr><td>
+
+parentNodeName
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+_(Optional)_ The name of the parent's node (if parent is a model entity) this entity will attach to.
+
+
+</td></tr>
+<tr><td>
+
+position
+
+
+</td><td>
+
+[Vector3Like](./server.vector3like.md)
+
+
+</td><td>
+
+_(Optional)_ The position to set for the entity. If parent is provided, this is relative to the parent's attachment point.
+
+
+</td></tr>
+<tr><td>
+
+rotation
+
+
+</td><td>
+
+[QuaternionLike](./server.quaternionlike.md)
+
+
+</td><td>
+
+_(Optional)_ The rotation to set for the entity. If parent is provided, this is relative to the parent's rotation.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+
+## 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.
+

package/docs/server.entityeventpayload.md

@@ -60,6 +60,15 @@ Description
 </td><td>
 
 
+</td></tr>
+<tr><td>
+
+[SetParent](./server.entityeventpayload.setparent.md)
+
+
+</td><td>
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.entityeventpayload.setparent.entity.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [EntityEventPayload](./server.entityeventpayload.md) &gt; [SetParent](./server.entityeventpayload.setparent.md) &gt; [entity](./server.entityeventpayload.setparent.entity.md)
+
+## EntityEventPayload.SetParent.entity property
+
+**Signature:**
+
+```typescript
+entity: Entity;
+```

package/docs/server.entityeventpayload.setparent.md

@@ -0,0 +1,87 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [EntityEventPayload](./server.entityeventpayload.md) &gt; [SetParent](./server.entityeventpayload.setparent.md)
+
+## EntityEventPayload.SetParent interface
+
+**Signature:**
+
+```typescript
+interface SetParent 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[entity](./server.entityeventpayload.setparent.entity.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[Entity](./server.entity.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[parent](./server.entityeventpayload.setparent.parent.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[Entity](./server.entity.md) \| undefined
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[parentNodeName](./server.entityeventpayload.setparent.parentnodename.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string \| undefined
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>

package/docs/server.entityeventpayload.setparent.parent.md

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

package/docs/server.entityeventpayload.setparent.parentnodename.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [EntityEventPayload](./server.entityeventpayload.md) &gt; [SetParent](./server.entityeventpayload.setparent.md) &gt; [parentNodeName](./server.entityeventpayload.setparent.parentnodename.md)
+
+## EntityEventPayload.SetParent.parentNodeName property
+
+**Signature:**
+
+```typescript
+parentNodeName: string | undefined;
+```

package/docs/server.entityeventtype.md

@@ -85,6 +85,20 @@ SET\_OPACITY
 </td><td>
 
 
+</td></tr>
+<tr><td>
+
+SET\_PARENT
+
+
+</td><td>
+
+`"ENTITY.SET_PARENT"`
+
+
+</td><td>
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.rigidbody.md

@@ -1135,6 +1135,62 @@ Locks all rotations of the rigid body.
 Removes the rigid body from the simulation it belongs to.
 
 
+</td></tr>
+<tr><td>
+
+[resetAngularVelocity()](./server.rigidbody.resetangularvelocity.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Resets the angular velocity of the rigid body.
+
+
+</td></tr>
+<tr><td>
+
+[resetForces()](./server.rigidbody.resetforces.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Resets the forces actiong on the rigid body.
+
+
+</td></tr>
+<tr><td>
+
+[resetLinearVelocity()](./server.rigidbody.resetlinearvelocity.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Resets the linear velocity of the rigid body.
+
+
+</td></tr>
+<tr><td>
+
+[resetTorques()](./server.rigidbody.resettorques.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Resets the torques acting on the rigid body.
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.rigidbody.resetangularvelocity.md

@@ -0,0 +1,17 @@
+<!-- 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; [resetAngularVelocity](./server.rigidbody.resetangularvelocity.md)
+
+## RigidBody.resetAngularVelocity() method
+
+Resets the angular velocity of the rigid body.
+
+**Signature:**
+
+```typescript
+resetAngularVelocity(): void;
+```
+**Returns:**
+
+void
+

package/docs/server.rigidbody.resetforces.md

@@ -0,0 +1,17 @@
+<!-- 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; [resetForces](./server.rigidbody.resetforces.md)
+
+## RigidBody.resetForces() method
+
+Resets the forces actiong on the rigid body.
+
+**Signature:**
+
+```typescript
+resetForces(): void;
+```
+**Returns:**
+
+void
+

package/docs/server.rigidbody.resetlinearvelocity.md

@@ -0,0 +1,17 @@
+<!-- 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; [resetLinearVelocity](./server.rigidbody.resetlinearvelocity.md)
+
+## RigidBody.resetLinearVelocity() method
+
+Resets the linear velocity of the rigid body.
+
+**Signature:**
+
+```typescript
+resetLinearVelocity(): void;
+```
+**Returns:**
+
+void
+

package/docs/server.rigidbody.resettorques.md

@@ -0,0 +1,17 @@
+<!-- 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; [resetTorques](./server.rigidbody.resettorques.md)
+
+## RigidBody.resetTorques() method
+
+Resets the torques acting on the rigid body.
+
+**Signature:**
+
+```typescript
+resetTorques(): void;
+```
+**Returns:**
+
+void
+

package/docs/server.worldmap.entities.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [WorldMap](./server.worldmap.md) &gt; [entities](./server.worldmap.entities.md)
+
+## WorldMap.entities property
+
+The entities in the map.
+
+**Signature:**
+
+```typescript
+entities: {
+        [position: string]: EntityOptions;
+    };
+```

package/docs/server.worldmap.md

@@ -72,5 +72,24 @@ The blocks in the map
 The block types in the map.
 
 
+</td></tr>
+<tr><td>
+
+[entities](./server.worldmap.entities.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ \[position: string\]: [EntityOptions](./server.entityoptions.md)<!-- -->; }
+
+
+</td><td>
+
+The entities in the map.
+
+
 </td></tr>
 </tbody></table>

package/package.json

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