hytopia 0.1.53 → 0.1.55

package/docs/server.collideroptions.md

@@ -322,7 +322,7 @@ _(Optional)_ The radius of the collider if the shape is a ball, capsule, cone, c
 </td></tr>
 <tr><td>
 
-[relativeRotation?](./server.collideroptions.relativerotation.md)
+[relativePosition?](./server.collideroptions.relativeposition.md)
 
 
 </td><td>
@@ -330,18 +330,18 @@ _(Optional)_ The radius of the collider if the shape is a ball, capsule, cone, c
 
 </td><td>
 
-[QuaternionLike](./server.quaternionlike.md)
+[Vector3Like](./server.vector3like.md)
 
 
 </td><td>
 
-_(Optional)_ The relative rotation of the collider. Relative to parent rigid body.
+_(Optional)_ The relative position of the collider. Relative to parent rigid body.
 
 
 </td></tr>
 <tr><td>
 
-[relativeTranslation?](./server.collideroptions.relativetranslation.md)
+[relativeRotation?](./server.collideroptions.relativerotation.md)
 
 
 </td><td>
@@ -349,12 +349,12 @@ _(Optional)_ The relative rotation of the collider. Relative to parent rigid bod
 
 </td><td>
 
-[Vector3Like](./server.vector3like.md)
+[QuaternionLike](./server.quaternionlike.md)
 
 
 </td><td>
 
-_(Optional)_ The relative translation of the collider. Relative to parent rigid body.
+_(Optional)_ The relative rotation of the collider. Relative to parent rigid body.
 
 
 </td></tr>

package/docs/server.collideroptions.relativeposition.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; [ColliderOptions](./server.collideroptions.md) &gt; [relativePosition](./server.collideroptions.relativeposition.md)
+
+## ColliderOptions.relativePosition property
+
+The relative position of the collider. Relative to parent rigid body.
+
+**Signature:**
+
+```typescript
+relativePosition?: Vector3Like;
+```

package/docs/server.entityeventpayload.md

@@ -90,7 +90,7 @@ Description
 </td></tr>
 <tr><td>
 
-[UpdateRotation](./server.entityeventpayload.updaterotation.md)
+[UpdatePosition](./server.entityeventpayload.updateposition.md)
 
 
 </td><td>
@@ -99,7 +99,7 @@ Description
 </td></tr>
 <tr><td>
 
-[UpdateTranslation](./server.entityeventpayload.updatetranslation.md)
+[UpdateRotation](./server.entityeventpayload.updaterotation.md)
 
 
 </td><td>

package/docs/server.entityeventpayload.updateposition.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; [UpdatePosition](./server.entityeventpayload.updateposition.md) &gt; [entity](./server.entityeventpayload.updateposition.entity.md)
+
+## EntityEventPayload.UpdatePosition.entity property
+
+**Signature:**
+
+```typescript
+entity: Entity;
+```

package/docs/{server.entityeventpayload.updatetranslation.md → server.entityeventpayload.updateposition.md}

@@ -1,13 +1,13 @@
 <!-- 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; [UpdateTranslation](./server.entityeventpayload.updatetranslation.md)
+[Home](./index.md) &gt; [server](./server.md) &gt; [EntityEventPayload](./server.entityeventpayload.md) &gt; [UpdatePosition](./server.entityeventpayload.updateposition.md)
 
-## EntityEventPayload.UpdateTranslation interface
+## EntityEventPayload.UpdatePosition interface
 
 **Signature:**
 
 ```typescript
-interface UpdateTranslation 
+interface UpdatePosition 
 ```
 
 ## Properties
@@ -35,7 +35,7 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
-[entity](./server.entityeventpayload.updatetranslation.entity.md)
+[entity](./server.entityeventpayload.updateposition.entity.md)
 
 
 </td><td>
@@ -52,7 +52,7 @@ Description
 </td></tr>
 <tr><td>
 
-[translation](./server.entityeventpayload.updatetranslation.translation.md)
+[position](./server.entityeventpayload.updateposition.position.md)
 
 
 </td><td>

package/docs/server.entityeventpayload.updateposition.position.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; [UpdatePosition](./server.entityeventpayload.updateposition.md) &gt; [position](./server.entityeventpayload.updateposition.position.md)
+
+## EntityEventPayload.UpdatePosition.position property
+
+**Signature:**
+
+```typescript
+position: Vector3Like;
+```

package/docs/server.entityeventtype.md

@@ -130,12 +130,12 @@ STOP\_MODEL\_ANIMATIONS
 </td></tr>
 <tr><td>
 
-UPDATE\_ROTATION
+UPDATE\_POSITION
 
 
 </td><td>
 
-`"ENTITY.UPDATE_ROTATION"`
+`"ENTITY.UPDATE_POSITION"`
 
 
 </td><td>
@@ -144,12 +144,12 @@ UPDATE\_ROTATION
 </td></tr>
 <tr><td>
 
-UPDATE\_TRANSLATION
+UPDATE\_ROTATION
 
 
 </td><td>
 
-`"ENTITY.UPDATE_TRANSLATION"`
+`"ENTITY.UPDATE_ROTATION"`
 
 
 </td><td>

package/docs/server.md

@@ -472,6 +472,8 @@ Event types a PlayerCamera can emit.
 
 </td><td>
 
+The mode of the camera.
+
 
 </td></tr>
 <tr><td>
@@ -492,7 +494,7 @@ Event types a Player can emit.
 
 </td><td>
 
-Event types a
+Event types a PlayerUI can emit.
 
 
 </td></tr>
@@ -1029,7 +1031,7 @@ Options for the [SimpleCharacterController.face()](./server.simplecharactercontr
 
 </td><td>
 
-A callback function called when the entity associated with the SimpleCharacterController updates its translation as it is attempting to move to a target coordinate.
+A callback function called when the entity associated with the SimpleCharacterController updates its position as it is attempting to move to a target coordinate.
 
 
 </td></tr>
@@ -1095,6 +1097,8 @@ A raw set of collision groups represented as a 32-bit number.
 
 </td><td>
 
+A hit result from a raycast.
+
 
 </td></tr>
 <tr><td>

package/docs/server.movecallback.md

@@ -4,12 +4,12 @@
 
 ## MoveCallback type
 
-A callback function called when the entity associated with the SimpleCharacterController updates its translation as it is attempting to move to a target coordinate.
+A callback function called when the entity associated with the SimpleCharacterController updates its position as it is attempting to move to a target coordinate.
 
 **Signature:**
 
 ```typescript
-export type MoveCallback = (currentTranslation: Vector3Like, targetTranslation: Vector3Like) => void;
+export type MoveCallback = (currentPosition: Vector3Like, targetPosition: Vector3Like) => void;
 ```
 **References:** [Vector3Like](./server.vector3like.md)
 

package/docs/server.movecompletecallback.md

@@ -9,7 +9,7 @@ A callback function called when the entity associated with the SimpleCharacterCo
 **Signature:**
 
 ```typescript
-export type MoveCompleteCallback = (endTranslation: Vector3Like) => void;
+export type MoveCompleteCallback = (endPosition: Vector3Like) => void;
 ```
 **References:** [Vector3Like](./server.vector3like.md)
 

package/docs/server.player.md

@@ -61,27 +61,6 @@ Description
 The camera for the player.
 
 
-</td></tr>
-<tr><td>
-
-[cameraOrientation](./server.player.cameraorientation.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-Readonly&lt;[PlayerCameraOrientation](./server.playercameraorientation.md)<!-- -->&gt;
-
-
-</td><td>
-
-The current [PlayerCameraOrientation](./server.playercameraorientation.md) of the player.
-
-
 </td></tr>
 <tr><td>
 

package/docs/server.playercamera.facingdirection.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; [facingDirection](./server.playercamera.facingdirection.md)
+
+## PlayerCamera.facingDirection property
+
+The facing direction vector of the camera based on its current orientation.
+
+**Signature:**
+
+```typescript
+get facingDirection(): Vector3Like;
+```

package/docs/server.playercamera.md

@@ -90,6 +90,27 @@ The entity the camera is attached to.
 The position the camera is attached to.
 
 
+</td></tr>
+<tr><td>
+
+[facingDirection](./server.playercamera.facingdirection.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+[Vector3Like](./server.vector3like.md)
+
+
+</td><td>
+
+The facing direction vector of the camera based on its current orientation.
+
+
 </td></tr>
 <tr><td>
 
@@ -216,6 +237,27 @@ The nodes of the model the camera is attached to that will not be rendered for t
 The relative offset of the camera from the entity or position it is attached to.
 
 
+</td></tr>
+<tr><td>
+
+[orientation](./server.playercamera.orientation.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+[PlayerCameraOrientation](./server.playercameraorientation.md)
+
+
+</td><td>
+
+The current orientation of the camera.
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.playercamera.orientation.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; [orientation](./server.playercamera.orientation.md)
+
+## PlayerCamera.orientation property
+
+The current orientation of the camera.
+
+**Signature:**
+
+```typescript
+get orientation(): PlayerCameraOrientation;
+```

package/docs/server.playercameramode.md

@@ -4,6 +4,8 @@
 
 ## PlayerCameraMode enum
 
+The mode of the camera.
+
 **Signature:**
 
 ```typescript

package/docs/server.playeruieventtype.md

@@ -4,7 +4,7 @@
 
 ## PlayerUIEventType enum
 
-Event types a
+Event types a PlayerUI can emit.
 
 **Signature:**
 

package/docs/server.raycasthit.md

@@ -4,11 +4,14 @@
 
 ## RaycastHit type
 
+A hit result from a raycast.
+
 **Signature:**
 
 ```typescript
 export type RaycastHit = {
-    hitObject: Block | Entity;
+    hitBlock?: Block;
+    hitEntity?: Entity;
     hitPoint: Vector3Like;
     hitDistance: number;
 };

package/docs/server.rigidbody.additionalmass.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; [RigidBody](./server.rigidbody.md) &gt; [additionalMass](./server.rigidbody.additionalmass.md)
+
+## RigidBody.additionalMass property
+
+The additional mass of the rigid body.
+
+**Signature:**
+
+```typescript
+get additionalMass(): number;
+```

package/docs/server.rigidbody.additionalsolveriterations.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; [RigidBody](./server.rigidbody.md) &gt; [additionalSolverIterations](./server.rigidbody.additionalsolveriterations.md)
+
+## RigidBody.additionalSolverIterations property
+
+The additional solver iterations of the rigid body.
+
+**Signature:**
+
+```typescript
+get additionalSolverIterations(): number;
+```

package/docs/server.rigidbody.angulardamping.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; [RigidBody](./server.rigidbody.md) &gt; [angularDamping](./server.rigidbody.angulardamping.md)
+
+## RigidBody.angularDamping property
+
+The angular damping of the rigid body.
+
+**Signature:**
+
+```typescript
+get angularDamping(): number;
+```

package/docs/server.rigidbody.angularvelocity.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; [RigidBody](./server.rigidbody.md) &gt; [angularVelocity](./server.rigidbody.angularvelocity.md)
+
+## RigidBody.angularVelocity property
+
+The angular velocity of the rigid body.
+
+**Signature:**
+
+```typescript
+get angularVelocity(): Vector3Like;
+```

package/docs/server.rigidbody.directionfromrotation.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; [RigidBody](./server.rigidbody.md) &gt; [directionFromRotation](./server.rigidbody.directionfromrotation.md)
+
+## RigidBody.directionFromRotation property
+
+The direction from the rotation of the rigid body.
+
+**Signature:**
+
+```typescript
+get directionFromRotation(): Vector3Like;
+```

package/docs/server.rigidbody.dominancegroup.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; [RigidBody](./server.rigidbody.md) &gt; [dominanceGroup](./server.rigidbody.dominancegroup.md)
+
+## RigidBody.dominanceGroup property
+
+The dominance group of the rigid body.
+
+**Signature:**
+
+```typescript
+get dominanceGroup(): number;
+```

package/docs/server.rigidbody.effectiveangularinertia.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; [RigidBody](./server.rigidbody.md) &gt; [effectiveAngularInertia](./server.rigidbody.effectiveangularinertia.md)
+
+## RigidBody.effectiveAngularInertia property
+
+The effective angular inertia of the rigid body.
+
+**Signature:**
+
+```typescript
+get effectiveAngularInertia(): SpdMatrix3 | undefined;
+```

package/docs/server.rigidbody.effectiveinversemass.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; [RigidBody](./server.rigidbody.md) &gt; [effectiveInverseMass](./server.rigidbody.effectiveinversemass.md)
+
+## RigidBody.effectiveInverseMass property
+
+The effective inverse mass of the rigid body.
+
+**Signature:**
+
+```typescript
+get effectiveInverseMass(): Vector3Like | undefined;
+```

package/docs/server.rigidbody.effectiveworldinverseprincipalangularinertiasqrt.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; [RigidBody](./server.rigidbody.md) &gt; [effectiveWorldInversePrincipalAngularInertiaSqrt](./server.rigidbody.effectiveworldinverseprincipalangularinertiasqrt.md)
+
+## RigidBody.effectiveWorldInversePrincipalAngularInertiaSqrt property
+
+The effective world inverse principal angular inertia square root of the rigid body.
+
+**Signature:**
+
+```typescript
+get effectiveWorldInversePrincipalAngularInertiaSqrt(): SpdMatrix3 | undefined;
+```

package/docs/server.rigidbody.enabledpositions.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; [RigidBody](./server.rigidbody.md) &gt; [enabledPositions](./server.rigidbody.enabledpositions.md)
+
+## RigidBody.enabledPositions property
+
+The enabled axes of positional movement of the rigid body.
+
+**Signature:**
+
+```typescript
+get enabledPositions(): Vector3Boolean;
+```

package/docs/server.rigidbody.enabledrotations.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; [RigidBody](./server.rigidbody.md) &gt; [enabledRotations](./server.rigidbody.enabledrotations.md)
+
+## RigidBody.enabledRotations property
+
+The enabled axes of rotational movement of the rigid body.
+
+**Signature:**
+
+```typescript
+get enabledRotations(): Vector3Boolean;
+```

package/docs/server.rigidbody.gravityscale.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; [RigidBody](./server.rigidbody.md) &gt; [gravityScale](./server.rigidbody.gravityscale.md)
+
+## RigidBody.gravityScale property
+
+The gravity scale of the rigid body.
+
+**Signature:**
+
+```typescript
+get gravityScale(): number;
+```

package/docs/server.rigidbody.inversemass.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; [RigidBody](./server.rigidbody.md) &gt; [inverseMass](./server.rigidbody.inversemass.md)
+
+## RigidBody.inverseMass property
+
+The inverse mass of the rigid body.
+
+**Signature:**
+
+```typescript
+get inverseMass(): number | undefined;
+```

package/docs/server.rigidbody.inverseprincipalangularinertiasqrt.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; [RigidBody](./server.rigidbody.md) &gt; [inversePrincipalAngularInertiaSqrt](./server.rigidbody.inverseprincipalangularinertiasqrt.md)
+
+## RigidBody.inversePrincipalAngularInertiaSqrt property
+
+The inverse principal angular inertia square root of the rigid body.
+
+**Signature:**
+
+```typescript
+get inversePrincipalAngularInertiaSqrt(): Vector3Like | undefined;
+```

package/docs/server.rigidbody.lineardamping.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; [RigidBody](./server.rigidbody.md) &gt; [linearDamping](./server.rigidbody.lineardamping.md)
+
+## RigidBody.linearDamping property
+
+The linear damping of the rigid body.
+
+**Signature:**
+
+```typescript
+get linearDamping(): number;
+```

package/docs/server.rigidbody.linearvelocity.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; [RigidBody](./server.rigidbody.md) &gt; [linearVelocity](./server.rigidbody.linearvelocity.md)
+
+## RigidBody.linearVelocity property
+
+The linear velocity of the rigid body.
+
+**Signature:**
+
+```typescript
+get linearVelocity(): Vector3Like;
+```

package/docs/server.rigidbody.localcenterofmass.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; [RigidBody](./server.rigidbody.md) &gt; [localCenterOfMass](./server.rigidbody.localcenterofmass.md)
+
+## RigidBody.localCenterOfMass property
+
+The local center of mass of the rigid body.
+
+**Signature:**
+
+```typescript
+get localCenterOfMass(): Vector3Like;
+```

package/docs/server.rigidbody.lockallpositions.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; [lockAllPositions](./server.rigidbody.lockallpositions.md)
+
+## RigidBody.lockAllPositions() method
+
+Locks all positional movement of the rigid body.
+
+**Signature:**
+
+```typescript
+lockAllPositions(): void;
+```
+**Returns:**
+
+void
+