hytopia 0.1.53 → 0.1.55

package/docs/server.block.getneighborglobalcoordinatefromhitpoint.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; [Block](./server.block.md) &gt; [getNeighborGlobalCoordinateFromHitPoint](./server.block.getneighborglobalcoordinatefromhitpoint.md)
+
+## Block.getNeighborGlobalCoordinateFromHitPoint() method
+
+Gets the most adjacent neighbor global coordinate of this block based on a relative hit point, typically from a raycast.
+
+**Signature:**
+
+```typescript
+getNeighborGlobalCoordinateFromHitPoint(hitPoint: Vector3Like): Vector3Like;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+hitPoint
+
+
+</td><td>
+
+[Vector3Like](./server.vector3like.md)
+
+
+</td><td>
+
+The hit point on this block to get the neighbor coordinate from.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+[Vector3Like](./server.vector3like.md)
+
+A neighbor global coordinate of this block based on the hit point.
+

package/docs/server.block.md

@@ -82,5 +82,39 @@ The block type of the block.
 The global coordinate of the block.
 
 
+</td></tr>
+</tbody></table>
+
+## Methods
+
+<table><thead><tr><th>
+
+Method
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[getNeighborGlobalCoordinateFromHitPoint(hitPoint)](./server.block.getneighborglobalcoordinatefromhitpoint.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Gets the most adjacent neighbor global coordinate of this block based on a relative hit point, typically from a raycast.
+
+
 </td></tr>
 </tbody></table>

package/docs/server.collider.bounciness.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; [Collider](./server.collider.md) &gt; [bounciness](./server.collider.bounciness.md)
+
+## Collider.bounciness property
+
+The bounciness of the collider.
+
+**Signature:**
+
+```typescript
+get bounciness(): number;
+```

package/docs/server.collider.bouncinesscombinerule.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; [Collider](./server.collider.md) &gt; [bouncinessCombineRule](./server.collider.bouncinesscombinerule.md)
+
+## Collider.bouncinessCombineRule property
+
+The bounciness combine rule of the collider.
+
+**Signature:**
+
+```typescript
+get bouncinessCombineRule(): CoefficientCombineRule;
+```

package/docs/server.collider.collisiongroups.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; [Collider](./server.collider.md) &gt; [collisionGroups](./server.collider.collisiongroups.md)
+
+## Collider.collisionGroups property
+
+The collision groups the collider belongs to.
+
+**Signature:**
+
+```typescript
+get collisionGroups(): CollisionGroups;
+```

package/docs/{server.collider.getfriction.md → server.collider.friction.md}

@@ -1,19 +1,13 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [server](./server.md) &gt; [Collider](./server.collider.md) &gt; [getFriction](./server.collider.getfriction.md)
+[Home](./index.md) &gt; [server](./server.md) &gt; [Collider](./server.collider.md) &gt; [friction](./server.collider.friction.md)
 
-## Collider.getFriction() method
+## Collider.friction property
 
-Gets the friction of the collider.
+The friction of the collider.
 
 **Signature:**
 
 ```typescript
-getFriction(): number;
+get friction(): number;
 ```
-**Returns:**
-
-number
-
-The friction of the collider.
-

package/docs/server.collider.frictioncombinerule.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; [Collider](./server.collider.md) &gt; [frictionCombineRule](./server.collider.frictioncombinerule.md)
+
+## Collider.frictionCombineRule property
+
+The friction combine rule of the collider.
+
+**Signature:**
+
+```typescript
+get frictionCombineRule(): CoefficientCombineRule;
+```

package/docs/server.collider.md

@@ -75,7 +75,7 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
-[isEnabled](./server.collider.isenabled.md)
+[bounciness](./server.collider.bounciness.md)
 
 
 </td><td>
@@ -85,18 +85,18 @@ Description
 
 </td><td>
 
-boolean
+number
 
 
 </td><td>
 
-Whether the collider is enabled.
+The bounciness of the collider.
 
 
 </td></tr>
 <tr><td>
 
-[isRemoved](./server.collider.isremoved.md)
+[bouncinessCombineRule](./server.collider.bouncinesscombinerule.md)
 
 
 </td><td>
@@ -106,18 +106,18 @@ Whether the collider is enabled.
 
 </td><td>
 
-boolean
+[CoefficientCombineRule](./server.coefficientcombinerule.md)
 
 
 </td><td>
 
-Whether the collider has been removed from the simulation.
+The bounciness combine rule of the collider.
 
 
 </td></tr>
 <tr><td>
 
-[isSensor](./server.collider.issensor.md)
+[collisionGroups](./server.collider.collisiongroups.md)
 
 
 </td><td>
@@ -127,18 +127,18 @@ Whether the collider has been removed from the simulation.
 
 </td><td>
 
-boolean
+[CollisionGroups](./server.collisiongroups.md)
 
 
 </td><td>
 
-Whether the collider is a sensor.
+The collision groups the collider belongs to.
 
 
 </td></tr>
 <tr><td>
 
-[isSimulated](./server.collider.issimulated.md)
+[friction](./server.collider.friction.md)
 
 
 </td><td>
@@ -148,18 +148,18 @@ Whether the collider is a sensor.
 
 </td><td>
 
-boolean
+number
 
 
 </td><td>
 
-Whether the collider is simulated.
+The friction of the collider.
 
 
 </td></tr>
 <tr><td>
 
-[parentRigidBody](./server.collider.parentrigidbody.md)
+[frictionCombineRule](./server.collider.frictioncombinerule.md)
 
 
 </td><td>
@@ -169,18 +169,18 @@ Whether the collider is simulated.
 
 </td><td>
 
-[RigidBody](./server.rigidbody.md) \| undefined
+[CoefficientCombineRule](./server.coefficientcombinerule.md)
 
 
 </td><td>
 
-The parent rigid body of the collider.
+The friction combine rule of the collider.
 
 
 </td></tr>
 <tr><td>
 
-[rawCollider](./server.collider.rawcollider.md)
+[isEnabled](./server.collider.isenabled.md)
 
 
 </td><td>
@@ -190,18 +190,18 @@ The parent rigid body of the collider.
 
 </td><td>
 
-RAPIER.Collider \| undefined
+boolean
 
 
 </td><td>
 
-The raw collider object from the Rapier physics engine.
+Whether the collider is enabled.
 
 
 </td></tr>
 <tr><td>
 
-[shape](./server.collider.shape.md)
+[isRemoved](./server.collider.isremoved.md)
 
 
 </td><td>
@@ -211,18 +211,18 @@ The raw collider object from the Rapier physics engine.
 
 </td><td>
 
-[ColliderShape](./server.collidershape.md)
+boolean
 
 
 </td><td>
 
-The shape of the collider.
+Whether the collider has been removed from the simulation.
 
 
 </td></tr>
 <tr><td>
 
-[tag](./server.collider.tag.md)
+[isSensor](./server.collider.issensor.md)
 
 
 </td><td>
@@ -232,136 +232,185 @@ The shape of the collider.
 
 </td><td>
 
-string \| undefined
+boolean
 
 
 </td><td>
 
-An arbitrary identifier tag of the collider. Useful for your own logic.
+Whether the collider is a sensor.
 
 
 </td></tr>
-</tbody></table>
+<tr><td>
 
-## Methods
+[isSimulated](./server.collider.issimulated.md)
 
-<table><thead><tr><th>
 
-Method
+</td><td>
 
+`readonly`
 
-</th><th>
 
-Modifiers
+</td><td>
 
+boolean
 
-</th><th>
 
-Description
+</td><td>
 
+Whether the collider is simulated.
 
-</th></tr></thead>
-<tbody><tr><td>
 
-[addToSimulation(simulation, parentRigidBody)](./server.collider.addtosimulation.md)
+</td></tr>
+<tr><td>
+
+[parentRigidBody](./server.collider.parentrigidbody.md)
 
 
 </td><td>
 
+`readonly`
+
 
 </td><td>
 
-Adds the collider to the simulation.
+[RigidBody](./server.rigidbody.md) \| undefined
+
+
+</td><td>
+
+The parent rigid body of the collider.
 
 
 </td></tr>
 <tr><td>
 
-[enableCollisionEvents(enabled)](./server.collider.enablecollisionevents.md)
+[rawCollider](./server.collider.rawcollider.md)
+
+
+</td><td>
+
+`readonly`
 
 
 </td><td>
 
+RAPIER.Collider \| undefined
+
 
 </td><td>
 
-Enables or disables collision events for the collider. This is automatically enabled if an on collision callback is set.
+The raw collider object from the Rapier physics engine.
 
 
 </td></tr>
 <tr><td>
 
-[enableContactForceEvents(enabled)](./server.collider.enablecontactforceevents.md)
+[relativePosition](./server.collider.relativeposition.md)
 
 
 </td><td>
 
+`readonly`
+
 
 </td><td>
 
-Enables or disables contact force events for the collider. This is automatically enabled if an on contact force callback is set.
+[Vector3Like](./server.vector3like.md)
+
+
+</td><td>
+
+The relative position of the collider to its parent rigid body.
 
 
 </td></tr>
 <tr><td>
 
-[getBounciness()](./server.collider.getbounciness.md)
+[relativeRotation](./server.collider.relativerotation.md)
+
+
+</td><td>
+
+`readonly`
 
 
 </td><td>
 
+[QuaternionLike](./server.quaternionlike.md)
+
 
 </td><td>
 
-Gets the bounciness of the collider.
+The relative rotation of the collider.
 
 
 </td></tr>
 <tr><td>
 
-[getBouncinessCombineRule()](./server.collider.getbouncinesscombinerule.md)
+[shape](./server.collider.shape.md)
 
 
 </td><td>
 
+`readonly`
+
 
 </td><td>
 
-Gets the bounciness combine rule of the collider.
+[ColliderShape](./server.collidershape.md)
+
+
+</td><td>
+
+The shape of the collider.
 
 
 </td></tr>
 <tr><td>
 
-[getCollisionGroups()](./server.collider.getcollisiongroups.md)
+[tag](./server.collider.tag.md)
+
+
+</td><td>
+
+`readonly`
 
 
 </td><td>
 
+string \| undefined
+
 
 </td><td>
 
-Gets the collision groups the collider belongs to.
+An arbitrary identifier tag of the collider. Useful for your own logic.
 
 
 </td></tr>
-<tr><td>
+</tbody></table>
 
-[getFriction()](./server.collider.getfriction.md)
+## Methods
 
+<table><thead><tr><th>
 
-</td><td>
+Method
 
 
-</td><td>
+</th><th>
 
-Gets the friction of the collider.
+Modifiers
 
 
-</td></tr>
-<tr><td>
+</th><th>
+
+Description
 
-[getFrictionCombineRule()](./server.collider.getfrictioncombinerule.md)
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[addToSimulation(simulation, parentRigidBody)](./server.collider.addtosimulation.md)
 
 
 </td><td>
@@ -369,13 +418,13 @@ Gets the friction of the collider.
 
 </td><td>
 
-Gets the friction combine rule of the collider.
+Adds the collider to the simulation.
 
 
 </td></tr>
 <tr><td>
 
-[getRelativeRotation()](./server.collider.getrelativerotation.md)
+[enableCollisionEvents(enabled)](./server.collider.enablecollisionevents.md)
 
 
 </td><td>
@@ -383,13 +432,13 @@ Gets the friction combine rule of the collider.
 
 </td><td>
 
-Gets the relative rotation of the collider.
+Enables or disables collision events for the collider. This is automatically enabled if an on collision callback is set.
 
 
 </td></tr>
 <tr><td>
 
-[getRelativeTranslation()](./server.collider.getrelativetranslation.md)
+[enableContactForceEvents(enabled)](./server.collider.enablecontactforceevents.md)
 
 
 </td><td>
@@ -397,7 +446,7 @@ Gets the relative rotation of the collider.
 
 </td><td>
 
-Gets the relative translation of the collider to its parent rigid body.
+Enables or disables contact force events for the collider. This is automatically enabled if an on contact force callback is set.
 
 
 </td></tr>
@@ -529,7 +578,7 @@ Sets the on collision callback for the collider.
 </td></tr>
 <tr><td>
 
-[setRelativeRotation(rotation)](./server.collider.setrelativerotation.md)
+[setRelativePosition(position)](./server.collider.setrelativeposition.md)
 
 
 </td><td>
@@ -537,13 +586,13 @@ Sets the on collision callback for the collider.
 
 </td><td>
 
-Sets the relative rotation of the collider.
+Sets the relative position of the collider to its parent rigid body.
 
 
 </td></tr>
 <tr><td>
 
-[setRelativeTranslation(translation)](./server.collider.setrelativetranslation.md)
+[setRelativeRotation(rotation)](./server.collider.setrelativerotation.md)
 
 
 </td><td>
@@ -551,7 +600,7 @@ Sets the relative rotation of the collider.
 
 </td><td>
 
-Sets the relative translation of the collider to its parent rigid body.
+Sets the relative rotation of the collider.
 
 
 </td></tr>

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

package/docs/server.collider.relativerotation.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; [Collider](./server.collider.md) &gt; [relativeRotation](./server.collider.relativerotation.md)
+
+## Collider.relativeRotation property
+
+The relative rotation of the collider.
+
+**Signature:**
+
+```typescript
+get relativeRotation(): QuaternionLike;
+```

package/docs/{server.collider.setrelativetranslation.md → server.collider.setrelativeposition.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; [Collider](./server.collider.md) &gt; [setRelativeTranslation](./server.collider.setrelativetranslation.md)
+[Home](./index.md) &gt; [server](./server.md) &gt; [Collider](./server.collider.md) &gt; [setRelativePosition](./server.collider.setrelativeposition.md)
 
-## Collider.setRelativeTranslation() method
+## Collider.setRelativePosition() method
 
-Sets the relative translation of the collider to its parent rigid body.
+Sets the relative position of the collider to its parent rigid body.
 
 **Signature:**
 
 ```typescript
-setRelativeTranslation(translation: Vector3Like): void;
+setRelativePosition(position: Vector3Like): void;
 ```
 
 ## Parameters
@@ -32,7 +32,7 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
-translation
+position
 
 
 </td><td>
@@ -42,7 +42,7 @@ translation
 
 </td><td>
 
-The relative translation of the collider.
+The relative position of the collider.
 
 
 </td></tr>