hytopia 0.6.6 → 0.6.8

package/docs/server.collisiongroup.md

@@ -88,12 +88,12 @@ ENTITY\_SENSOR
 </td></tr>
 <tr><td>
 
-GROUP\_1
+ENVIRONMENT\_ENTITY
 
 
 </td><td>
 
-`16`
+`8`
 
 
 </td><td>
@@ -102,12 +102,12 @@ GROUP\_1
 </td></tr>
 <tr><td>
 
-GROUP\_10
+GROUP\_1
 
 
 </td><td>
 
-`8192`
+`32`
 
 
 </td><td>
@@ -116,7 +116,7 @@ GROUP\_10
 </td></tr>
 <tr><td>
 
-GROUP\_11
+GROUP\_10
 
 
 </td><td>
@@ -130,7 +130,7 @@ GROUP\_11
 </td></tr>
 <tr><td>
 
-GROUP\_12
+GROUP\_11
 
 
 </td><td>
@@ -149,7 +149,7 @@ GROUP\_2
 
 </td><td>
 
-`32`
+`64`
 
 
 </td><td>
@@ -163,7 +163,7 @@ GROUP\_3
 
 </td><td>
 
-`64`
+`128`
 
 
 </td><td>
@@ -177,7 +177,7 @@ GROUP\_4
 
 </td><td>
 
-`128`
+`256`
 
 
 </td><td>
@@ -191,7 +191,7 @@ GROUP\_5
 
 </td><td>
 
-`256`
+`512`
 
 
 </td><td>
@@ -205,7 +205,7 @@ GROUP\_6
 
 </td><td>
 
-`512`
+`1024`
 
 
 </td><td>
@@ -219,7 +219,7 @@ GROUP\_7
 
 </td><td>
 
-`1024`
+`2048`
 
 
 </td><td>
@@ -233,7 +233,7 @@ GROUP\_8
 
 </td><td>
 
-`2048`
+`4096`
 
 
 </td><td>
@@ -247,7 +247,7 @@ GROUP\_9
 
 </td><td>
 
-`4096`
+`8192`
 
 
 </td><td>
@@ -261,7 +261,7 @@ PLAYER
 
 </td><td>
 
-`8`
+`16`
 
 
 </td><td>

package/docs/server.entity.md

@@ -378,6 +378,27 @@ number
 The scale of the entity's model.
 
 
+</td></tr>
+<tr><td>
+
+[modelTextureUri](./server.entity.modeltextureuri.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+string \| undefined
+
+
+</td><td>
+
+The URI or path to the texture that overrides the model entity's default texture.
+
+
 </td></tr>
 <tr><td>
 
@@ -622,6 +643,20 @@ Sets the playback rate of all animations on the entity's model.
 Sets the nodes to hide on the entity's model. Matched nodes will be hidden for all players. Uses case insensitive substring matching.
 
 
+</td></tr>
+<tr><td>
+
+[setModelTextureUri(modelTextureUri)](./server.entity.setmodeltextureuri.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Sets the texture uri of the entity's model. Setting this overrides the model's default texture.
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.entity.modeltextureuri.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; [modelTextureUri](./server.entity.modeltextureuri.md)
+
+## Entity.modelTextureUri property
+
+The URI or path to the texture that overrides the model entity's default texture.
+
+**Signature:**
+
+```typescript
+get modelTextureUri(): string | undefined;
+```

package/docs/server.entity.setmodeltextureuri.md

@@ -0,0 +1,53 @@
+<!-- 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; [setModelTextureUri](./server.entity.setmodeltextureuri.md)
+
+## Entity.setModelTextureUri() method
+
+Sets the texture uri of the entity's model. Setting this overrides the model's default texture.
+
+**Signature:**
+
+```typescript
+setModelTextureUri(modelTextureUri: string | undefined): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+modelTextureUri
+
+
+</td><td>
+
+string \| undefined
+
+
+</td><td>
+
+The texture uri of the entity's model.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

package/docs/server.entityevent.md

@@ -127,6 +127,20 @@ SET\_MODEL\_HIDDEN\_NODES
 </td><td>
 
 
+</td></tr>
+<tr><td>
+
+SET\_MODEL\_TEXTURE\_URI
+
+
+</td><td>
+
+`"ENTITY.SET_MODEL_TEXTURE_URI"`
+
+
+</td><td>
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.entityeventpayloads._entity.set_model_texture_uri_.md

@@ -0,0 +1,16 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [EntityEventPayloads](./server.entityeventpayloads.md) &gt; ["ENTITY.SET\_MODEL\_TEXTURE\_URI"](./server.entityeventpayloads._entity.set_model_texture_uri_.md)
+
+## EntityEventPayloads."ENTITY.SET\_MODEL\_TEXTURE\_URI" property
+
+Emitted when the texture uri of the entity's model is set.
+
+**Signature:**
+
+```typescript
+[EntityEvent.SET_MODEL_TEXTURE_URI]: {
+        entity: Entity;
+        modelTextureUri: string | undefined;
+    };
+```

package/docs/server.entityeventpayloads.md

@@ -167,6 +167,25 @@ Emitted when the playback rate of the entity's model animations is set.
 Emitted when the nodes of the entity's model are set to be hidden.
 
 
+</td></tr>
+<tr><td>
+
+["ENTITY.SET\_MODEL\_TEXTURE\_URI"](./server.entityeventpayloads._entity.set_model_texture_uri_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ entity: [Entity](./server.entity.md)<!-- -->; modelTextureUri: string \| undefined; }
+
+
+</td><td>
+
+Emitted when the texture uri of the entity's model is set.
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.modelentityoptions.md

@@ -130,6 +130,25 @@ number
 _(Optional)_ The scale of the entity's model.
 
 
+</td></tr>
+<tr><td>
+
+[modelTextureUri?](./server.modelentityoptions.modeltextureuri.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+_(Optional)_ The texture uri of the entity's model. Setting this overrides the model's default texture.
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.modelentityoptions.modeltextureuri.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; [ModelEntityOptions](./server.modelentityoptions.md) &gt; [modelTextureUri](./server.modelentityoptions.modeltextureuri.md)
+
+## ModelEntityOptions.modelTextureUri property
+
+The texture uri of the entity's model. Setting this overrides the model's default texture.
+
+**Signature:**
+
+```typescript
+modelTextureUri?: string;
+```

package/docs/server.moveoptions.md

@@ -18,6 +18,7 @@ export type MoveOptions = {
         z?: boolean;
     };
     moveStartIdleAnimationsOnCompletion?: boolean;
+    moveStoppingDistance?: number;
 };
 ```
 **References:** [MoveCallback](./server.movecallback.md)<!-- -->, [MoveCompleteCallback](./server.movecompletecallback.md)

package/docs/server.pathfindingentitycontroller._constructor_.md

@@ -0,0 +1,49 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [PathfindingEntityController](./server.pathfindingentitycontroller.md) &gt; [(constructor)](./server.pathfindingentitycontroller._constructor_.md)
+
+## PathfindingEntityController.(constructor)
+
+Constructs a new instance of the `PathfindingEntityController` class
+
+**Signature:**
+
+```typescript
+constructor(options?: PathfindingEntityControllerOptions);
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+options
+
+
+</td><td>
+
+PathfindingEntityControllerOptions
+
+
+</td><td>
+
+_(Optional)_ Options for the controller.
+
+
+</td></tr>
+</tbody></table>

package/docs/server.pathfindingentitycontroller.md

@@ -17,6 +17,40 @@ export default class PathfindingEntityController extends SimpleEntityController
 
 This class implements pathfinding using the A\* algorithm. Pathfinding when frequently called can cause performance issues, use it sparingly. The .pathfind() method should only need to be called once in nearly all cases when attempting to move an entity to a target coordinate.
 
+## Constructors
+
+<table><thead><tr><th>
+
+Constructor
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[(constructor)(options)](./server.pathfindingentitycontroller._constructor_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Constructs a new instance of the `PathfindingEntityController` class
+
+
+</td></tr>
+</tbody></table>
+
 ## Properties
 
 <table><thead><tr><th>

package/docs/server.playercamera.md

@@ -285,6 +285,27 @@ The current orientation of the camera.
 The player that the camera belongs to.
 
 
+</td></tr>
+<tr><td>
+
+[shoulderAngle](./server.playercamera.shoulderangle.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+The shoulder angle of the camera in degrees.
+
+
 </td></tr>
 <tr><td>
 
@@ -522,6 +543,20 @@ Sets the nodes of the model the camera is attached to that will not be rendered
 Sets the relative offset of the camera from the entity or position it is attached to.
 
 
+</td></tr>
+<tr><td>
+
+[setShoulderAngle(shoulderAngle)](./server.playercamera.setshoulderangle.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Only used in third-person mode. Sets the shoulder angle of the camera in degrees. A positive value shifts the camera to the right, a negative value shifts it to the left.
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.playercamera.setshoulderangle.md

@@ -0,0 +1,53 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [PlayerCamera](./server.playercamera.md) &gt; [setShoulderAngle](./server.playercamera.setshoulderangle.md)
+
+## PlayerCamera.setShoulderAngle() method
+
+Only used in third-person mode. Sets the shoulder angle of the camera in degrees. A positive value shifts the camera to the right, a negative value shifts it to the left.
+
+**Signature:**
+
+```typescript
+setShoulderAngle(shoulderAngle: number): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+shoulderAngle
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+The shoulder angle to set in degrees.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

package/docs/server.playercamera.shoulderangle.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; [PlayerCamera](./server.playercamera.md) &gt; [shoulderAngle](./server.playercamera.shoulderangle.md)
+
+## PlayerCamera.shoulderAngle property
+
+The shoulder angle of the camera in degrees.
+
+**Signature:**
+
+```typescript
+get shoulderAngle(): number;
+```

package/docs/server.playercameraevent.md

@@ -169,6 +169,20 @@ SET\_OFFSET
 </td><td>
 
 
+</td></tr>
+<tr><td>
+
+SET\_SHOULDER\_ANGLE
+
+
+</td><td>
+
+`"PLAYER_CAMERA.SET_SHOULDER_ANGLE"`
+
+
+</td><td>
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.playercameraeventpayloads._player_camera.set_shoulder_angle_.md

@@ -0,0 +1,16 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [PlayerCameraEventPayloads](./server.playercameraeventpayloads.md) &gt; ["PLAYER\_CAMERA.SET\_SHOULDER\_ANGLE"](./server.playercameraeventpayloads._player_camera.set_shoulder_angle_.md)
+
+## PlayerCameraEventPayloads."PLAYER\_CAMERA.SET\_SHOULDER\_ANGLE" property
+
+Emitted when the shoulder angle of the camera is set.
+
+**Signature:**
+
+```typescript
+[PlayerCameraEvent.SET_SHOULDER_ANGLE]: {
+        playerCamera: PlayerCamera;
+        shoulderAngle: number;
+    };
+```

package/docs/server.playercameraeventpayloads.md

@@ -224,6 +224,25 @@ Emitted when the nodes of the model the camera is attached to are set to be hidd
 Emitted when the offset of the camera is set.
 
 
+</td></tr>
+<tr><td>
+
+["PLAYER\_CAMERA.SET\_SHOULDER\_ANGLE"](./server.playercameraeventpayloads._player_camera.set_shoulder_angle_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ playerCamera: [PlayerCamera](./server.playercamera.md)<!-- -->; shoulderAngle: number; }
+
+
+</td><td>
+
+Emitted when the shoulder angle of the camera is set.
+
+
 </td></tr>
 <tr><td>
 

package/docs/{server.rigidbody.createandaddchildcolliderstosimulation.md → server.rigidbody.createandaddchildcolliders.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; [createAndAddChildCollidersToSimulation](./server.rigidbody.createandaddchildcolliderstosimulation.md)
+[Home](./index.md) &gt; [server](./server.md) &gt; [RigidBody](./server.rigidbody.md) &gt; [createAndAddChildColliders](./server.rigidbody.createandaddchildcolliders.md)
 
-## RigidBody.createAndAddChildCollidersToSimulation() method
+## RigidBody.createAndAddChildColliders() method
 
 Creates and adds multiple child colliders to the rigid body for the simulation it belongs to.
 
 **Signature:**
 
 ```typescript
-createAndAddChildCollidersToSimulation(colliderOptions: ColliderOptions[]): Collider[];
+createAndAddChildColliders(colliderOptions: ColliderOptions[]): Collider[];
 ```
 
 ## Parameters
@@ -53,3 +53,7 @@ The options for the child colliders to add to the rigid body.
 
 The child colliders that were added to the rigid body.
 
+## Remarks
+
+If the rigid body is not simulated, the colliders will be added to the rigid body as pending child colliders and also simulated when the rigid body is simulated.
+

package/docs/server.rigidbody.md

@@ -1069,7 +1069,7 @@ Creates and adds a child collider to the rigid body for the simulation it belong
 </td></tr>
 <tr><td>
 
-[createAndAddChildCollidersToSimulation(colliderOptions)](./server.rigidbody.createandaddchildcolliderstosimulation.md)
+[createAndAddChildColliders(colliderOptions)](./server.rigidbody.createandaddchildcolliders.md)
 
 
 </td><td>