hytopia 0.3.9 → 0.3.11

package/docs/server.rigidbodyoptions.md

@@ -2,417 +2,14 @@
 
 [Home](./index.md) > [server](./server.md) > [RigidBodyOptions](./server.rigidbodyoptions.md)
 
-## RigidBodyOptions interface
+## RigidBodyOptions type
 
-Options for creating a RigidBody instance.
+The options for a rigid body.
 
 **Signature:**
 
 ```typescript
-export interface RigidBodyOptions 
+export type RigidBodyOptions = DynamicRigidBodyOptions | FixedRigidBodyOptions | KinematicPositionRigidBodyOptions | KinematicVelocityRigidBodyOptions;
 ```
+**References:** [DynamicRigidBodyOptions](./server.dynamicrigidbodyoptions.md)<!-- -->, [FixedRigidBodyOptions](./server.fixedrigidbodyoptions.md)<!-- -->, [KinematicPositionRigidBodyOptions](./server.kinematicpositionrigidbodyoptions.md)<!-- -->, [KinematicVelocityRigidBodyOptions](./server.kinematicvelocityrigidbodyoptions.md)
 
-## Properties
-
-<table><thead><tr><th>
-
-Property
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[additionalMass?](./server.rigidbodyoptions.additionalmass.md)
-
-
-</td><td>
-
-
-</td><td>
-
-number
-
-
-</td><td>
-
-_(Optional)_ The additional mass of the rigid body.
-
-
-</td></tr>
-<tr><td>
-
-[additionalMassProperties?](./server.rigidbodyoptions.additionalmassproperties.md)
-
-
-</td><td>
-
-
-</td><td>
-
-[RigidBodyAdditionalMassProperties](./server.rigidbodyadditionalmassproperties.md)
-
-
-</td><td>
-
-_(Optional)_ The additional mass properties of the rigid body.
-
-
-</td></tr>
-<tr><td>
-
-[additionalSolverIterations?](./server.rigidbodyoptions.additionalsolveriterations.md)
-
-
-</td><td>
-
-
-</td><td>
-
-number
-
-
-</td><td>
-
-_(Optional)_ The additional solver iterations of the rigid body.
-
-
-</td></tr>
-<tr><td>
-
-[angularDamping?](./server.rigidbodyoptions.angulardamping.md)
-
-
-</td><td>
-
-
-</td><td>
-
-number
-
-
-</td><td>
-
-_(Optional)_ The angular damping of the rigid body.
-
-
-</td></tr>
-<tr><td>
-
-[angularVelocity?](./server.rigidbodyoptions.angularvelocity.md)
-
-
-</td><td>
-
-
-</td><td>
-
-[Vector3Like](./server.vector3like.md)
-
-
-</td><td>
-
-_(Optional)_ The angular velocity of the rigid body.
-
-
-</td></tr>
-<tr><td>
-
-[ccdEnabled?](./server.rigidbodyoptions.ccdenabled.md)
-
-
-</td><td>
-
-
-</td><td>
-
-boolean
-
-
-</td><td>
-
-_(Optional)_ Whether the rigid body has continuous collision detection enabled.
-
-
-</td></tr>
-<tr><td>
-
-[colliders?](./server.rigidbodyoptions.colliders.md)
-
-
-</td><td>
-
-
-</td><td>
-
-[ColliderOptions](./server.collideroptions.md)<!-- -->\[\]
-
-
-</td><td>
-
-_(Optional)_ The colliders of the rigid body, provided as [ColliderOptions](./server.collideroptions.md)<!-- -->.
-
-
-</td></tr>
-<tr><td>
-
-[dominanceGroup?](./server.rigidbodyoptions.dominancegroup.md)
-
-
-</td><td>
-
-
-</td><td>
-
-number
-
-
-</td><td>
-
-_(Optional)_ The dominance group of the rigid body.
-
-
-</td></tr>
-<tr><td>
-
-[enabled?](./server.rigidbodyoptions.enabled.md)
-
-
-</td><td>
-
-
-</td><td>
-
-boolean
-
-
-</td><td>
-
-_(Optional)_ Whether the rigid body is enabled.
-
-
-</td></tr>
-<tr><td>
-
-[enabledPositions?](./server.rigidbodyoptions.enabledpositions.md)
-
-
-</td><td>
-
-
-</td><td>
-
-[Vector3Boolean](./server.vector3boolean.md)
-
-
-</td><td>
-
-_(Optional)_ The enabled axes of positional movement of the rigid body.
-
-
-</td></tr>
-<tr><td>
-
-[enabledRotations?](./server.rigidbodyoptions.enabledrotations.md)
-
-
-</td><td>
-
-
-</td><td>
-
-[Vector3Boolean](./server.vector3boolean.md)
-
-
-</td><td>
-
-_(Optional)_ The enabled rotations of the rigid body.
-
-
-</td></tr>
-<tr><td>
-
-[gravityScale?](./server.rigidbodyoptions.gravityscale.md)
-
-
-</td><td>
-
-
-</td><td>
-
-number
-
-
-</td><td>
-
-_(Optional)_ The gravity scale of the rigid body.
-
-
-</td></tr>
-<tr><td>
-
-[linearDamping?](./server.rigidbodyoptions.lineardamping.md)
-
-
-</td><td>
-
-
-</td><td>
-
-number
-
-
-</td><td>
-
-_(Optional)_ The linear damping of the rigid body.
-
-
-</td></tr>
-<tr><td>
-
-[linearVelocity?](./server.rigidbodyoptions.linearvelocity.md)
-
-
-</td><td>
-
-
-</td><td>
-
-[Vector3Like](./server.vector3like.md)
-
-
-</td><td>
-
-_(Optional)_ The linear velocity of the rigid body.
-
-
-</td></tr>
-<tr><td>
-
-[position?](./server.rigidbodyoptions.position.md)
-
-
-</td><td>
-
-
-</td><td>
-
-[Vector3Like](./server.vector3like.md)
-
-
-</td><td>
-
-_(Optional)_ The position of the rigid body.
-
-
-</td></tr>
-<tr><td>
-
-[rotation?](./server.rigidbodyoptions.rotation.md)
-
-
-</td><td>
-
-
-</td><td>
-
-[QuaternionLike](./server.quaternionlike.md)
-
-
-</td><td>
-
-_(Optional)_ The rotation of the rigid body.
-
-
-</td></tr>
-<tr><td>
-
-[simulation?](./server.rigidbodyoptions.simulation.md)
-
-
-</td><td>
-
-
-</td><td>
-
-[Simulation](./server.simulation.md)
-
-
-</td><td>
-
-_(Optional)_ The simulation the rigid body is in. If provided, the rigid body will be automatically added to the simulation.
-
-
-</td></tr>
-<tr><td>
-
-[sleeping?](./server.rigidbodyoptions.sleeping.md)
-
-
-</td><td>
-
-
-</td><td>
-
-boolean
-
-
-</td><td>
-
-_(Optional)_ Whether the rigid body is sleeping.
-
-
-</td></tr>
-<tr><td>
-
-[softCcdPrediction?](./server.rigidbodyoptions.softccdprediction.md)
-
-
-</td><td>
-
-
-</td><td>
-
-number
-
-
-</td><td>
-
-_(Optional)_ The soft continuous collision detection prediction of the rigid body.
-
-
-</td></tr>
-<tr><td>
-
-[type?](./server.rigidbodyoptions.type.md)
-
-
-</td><td>
-
-
-</td><td>
-
-[RigidBodyType](./server.rigidbodytype.md)
-
-
-</td><td>
-
-_(Optional)_ The type of the rigid body.
-
-
-</td></tr>
-</tbody></table>

package/docs/server.roundcylindercollideroptions.borderradius.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; [RoundCylinderColliderOptions](./server.roundcylindercollideroptions.md) &gt; [borderRadius](./server.roundcylindercollideroptions.borderradius.md)
+
+## RoundCylinderColliderOptions.borderRadius property
+
+The border radius of the round cylinder collider.
+
+**Signature:**
+
+```typescript
+borderRadius?: number;
+```

package/docs/server.roundcylindercollideroptions.halfheight.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; [RoundCylinderColliderOptions](./server.roundcylindercollideroptions.md) &gt; [halfHeight](./server.roundcylindercollideroptions.halfheight.md)
+
+## RoundCylinderColliderOptions.halfHeight property
+
+The half height of the round cylinder collider.
+
+**Signature:**
+
+```typescript
+halfHeight?: number;
+```

package/docs/server.roundcylindercollideroptions.md

@@ -0,0 +1,113 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [RoundCylinderColliderOptions](./server.roundcylindercollideroptions.md)
+
+## RoundCylinderColliderOptions interface
+
+The options for a round cylinder collider.
+
+**Signature:**
+
+```typescript
+export interface RoundCylinderColliderOptions extends BaseColliderOptions 
+```
+**Extends:** [BaseColliderOptions](./server.basecollideroptions.md)
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[borderRadius?](./server.roundcylindercollideroptions.borderradius.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+_(Optional)_ The border radius of the round cylinder collider.
+
+
+</td></tr>
+<tr><td>
+
+[halfHeight?](./server.roundcylindercollideroptions.halfheight.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+_(Optional)_ The half height of the round cylinder collider.
+
+
+</td></tr>
+<tr><td>
+
+[radius?](./server.roundcylindercollideroptions.radius.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+_(Optional)_ The radius of the round cylinder collider.
+
+
+</td></tr>
+<tr><td>
+
+[shape](./server.roundcylindercollideroptions.shape.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[ColliderShape.ROUND\_CYLINDER](./server.collidershape.md)
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>

package/docs/server.roundcylindercollideroptions.radius.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; [RoundCylinderColliderOptions](./server.roundcylindercollideroptions.md) &gt; [radius](./server.roundcylindercollideroptions.radius.md)
+
+## RoundCylinderColliderOptions.radius property
+
+The radius of the round cylinder collider.
+
+**Signature:**
+
+```typescript
+radius?: number;
+```

package/docs/server.roundcylindercollideroptions.shape.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; [RoundCylinderColliderOptions](./server.roundcylindercollideroptions.md) &gt; [shape](./server.roundcylindercollideroptions.shape.md)
+
+## RoundCylinderColliderOptions.shape property
+
+**Signature:**
+
+```typescript
+shape: ColliderShape.ROUND_CYLINDER;
+```

package/docs/server.trimeshcollideroptions.indices.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; [TrimeshColliderOptions](./server.trimeshcollideroptions.md) &gt; [indices](./server.trimeshcollideroptions.indices.md)
+
+## TrimeshColliderOptions.indices property
+
+The indices of the trimesh collider.
+
+**Signature:**
+
+```typescript
+indices?: Uint32Array;
+```

package/docs/server.trimeshcollideroptions.md

@@ -0,0 +1,94 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [TrimeshColliderOptions](./server.trimeshcollideroptions.md)
+
+## TrimeshColliderOptions interface
+
+The options for a trimesh collider.
+
+**Signature:**
+
+```typescript
+export interface TrimeshColliderOptions extends BaseColliderOptions 
+```
+**Extends:** [BaseColliderOptions](./server.basecollideroptions.md)
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[indices?](./server.trimeshcollideroptions.indices.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Uint32Array
+
+
+</td><td>
+
+_(Optional)_ The indices of the trimesh collider.
+
+
+</td></tr>
+<tr><td>
+
+[shape](./server.trimeshcollideroptions.shape.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[ColliderShape.TRIMESH](./server.collidershape.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[vertices?](./server.trimeshcollideroptions.vertices.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Float32Array
+
+
+</td><td>
+
+_(Optional)_ The vertices of the trimesh collider.
+
+
+</td></tr>
+</tbody></table>

package/docs/server.trimeshcollideroptions.shape.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; [TrimeshColliderOptions](./server.trimeshcollideroptions.md) &gt; [shape](./server.trimeshcollideroptions.shape.md)
+
+## TrimeshColliderOptions.shape property
+
+**Signature:**
+
+```typescript
+shape: ColliderShape.TRIMESH;
+```

package/docs/server.trimeshcollideroptions.vertices.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; [TrimeshColliderOptions](./server.trimeshcollideroptions.md) &gt; [vertices](./server.trimeshcollideroptions.vertices.md)
+
+## TrimeshColliderOptions.vertices property
+
+The vertices of the trimesh collider.
+
+**Signature:**
+
+```typescript
+vertices?: Float32Array;
+```