hytopia 0.3.10 → 0.3.11

package/docs/server.collideroptions.md

@@ -2,455 +2,14 @@
 
 [Home](./index.md) > [server](./server.md) > [ColliderOptions](./server.collideroptions.md)
 
-## ColliderOptions interface
+## ColliderOptions type
 
-Options for creating a Collider instance.
+The options for a collider.
 
 **Signature:**
 
 ```typescript
-export interface ColliderOptions 
+export type ColliderOptions = BallColliderOptions | BlockColliderOptions | CapsuleColliderOptions | ConeColliderOptions | CylinderColliderOptions | RoundCylinderColliderOptions | TrimeshColliderOptions | NoneColliderOptions;
 ```
+**References:** [BallColliderOptions](./server.ballcollideroptions.md)<!-- -->, [BlockColliderOptions](./server.blockcollideroptions.md)<!-- -->, [CapsuleColliderOptions](./server.capsulecollideroptions.md)<!-- -->, [ConeColliderOptions](./server.conecollideroptions.md)<!-- -->, [CylinderColliderOptions](./server.cylindercollideroptions.md)<!-- -->, [RoundCylinderColliderOptions](./server.roundcylindercollideroptions.md)<!-- -->, [TrimeshColliderOptions](./server.trimeshcollideroptions.md)<!-- -->, [NoneColliderOptions](./server.nonecollideroptions.md)
 
-## Properties
-
-<table><thead><tr><th>
-
-Property
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[borderRadius?](./server.collideroptions.borderradius.md)
-
-
-</td><td>
-
-
-</td><td>
-
-number
-
-
-</td><td>
-
-_(Optional)_ The border radius of the collider if the shape is a round cylinder.
-
-
-</td></tr>
-<tr><td>
-
-[bounciness?](./server.collideroptions.bounciness.md)
-
-
-</td><td>
-
-
-</td><td>
-
-number
-
-
-</td><td>
-
-_(Optional)_ The bounciness of the collider.
-
-
-</td></tr>
-<tr><td>
-
-[bouncinessCombineRule?](./server.collideroptions.bouncinesscombinerule.md)
-
-
-</td><td>
-
-
-</td><td>
-
-[CoefficientCombineRule](./server.coefficientcombinerule.md)
-
-
-</td><td>
-
-_(Optional)_ The bounciness combine rule of the collider.
-
-
-</td></tr>
-<tr><td>
-
-[collisionGroups?](./server.collideroptions.collisiongroups.md)
-
-
-</td><td>
-
-
-</td><td>
-
-[CollisionGroups](./server.collisiongroups.md)
-
-
-</td><td>
-
-_(Optional)_ The collision groups the collider belongs to.
-
-
-</td></tr>
-<tr><td>
-
-[enabled?](./server.collideroptions.enabled.md)
-
-
-</td><td>
-
-
-</td><td>
-
-boolean
-
-
-</td><td>
-
-_(Optional)_ Whether the collider is enabled.
-
-
-</td></tr>
-<tr><td>
-
-[flags?](./server.collideroptions.flags.md)
-
-
-</td><td>
-
-
-</td><td>
-
-number
-
-
-</td><td>
-
-_(Optional)_ The flags of the collider if the shape is a trimesh
-
-
-</td></tr>
-<tr><td>
-
-[friction?](./server.collideroptions.friction.md)
-
-
-</td><td>
-
-
-</td><td>
-
-number
-
-
-</td><td>
-
-_(Optional)_ The friction of the collider.
-
-
-</td></tr>
-<tr><td>
-
-[frictionCombineRule?](./server.collideroptions.frictioncombinerule.md)
-
-
-</td><td>
-
-
-</td><td>
-
-[CoefficientCombineRule](./server.coefficientcombinerule.md)
-
-
-</td><td>
-
-_(Optional)_ The friction combine rule of the collider.
-
-
-</td></tr>
-<tr><td>
-
-[halfExtents?](./server.collideroptions.halfextents.md)
-
-
-</td><td>
-
-
-</td><td>
-
-[Vector3Like](./server.vector3like.md)
-
-
-</td><td>
-
-_(Optional)_ The half extents of the collider if the shape is a block.
-
-
-</td></tr>
-<tr><td>
-
-[halfHeight?](./server.collideroptions.halfheight.md)
-
-
-</td><td>
-
-
-</td><td>
-
-number
-
-
-</td><td>
-
-_(Optional)_ The half height of the collider if the shape is a capsule, cone, cylinder, or round cylinder.
-
-
-</td></tr>
-<tr><td>
-
-[indices?](./server.collideroptions.indices.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Uint32Array
-
-
-</td><td>
-
-_(Optional)_ The indices of the collider if the shape is a trimesh.
-
-
-</td></tr>
-<tr><td>
-
-[isSensor?](./server.collideroptions.issensor.md)
-
-
-</td><td>
-
-
-</td><td>
-
-boolean
-
-
-</td><td>
-
-_(Optional)_ Whether the collider is a sensor.
-
-
-</td></tr>
-<tr><td>
-
-[mass?](./server.collideroptions.mass.md)
-
-
-</td><td>
-
-
-</td><td>
-
-number
-
-
-</td><td>
-
-_(Optional)_ The mass of the collider.
-
-
-</td></tr>
-<tr><td>
-
-[onCollision?](./server.collideroptions.oncollision.md)
-
-
-</td><td>
-
-
-</td><td>
-
-[CollisionCallback](./server.collisioncallback.md)
-
-
-</td><td>
-
-_(Optional)_ The on collision callback for the collider.
-
-
-</td></tr>
-<tr><td>
-
-[parentRigidBody?](./server.collideroptions.parentrigidbody.md)
-
-
-</td><td>
-
-
-</td><td>
-
-[RigidBody](./server.rigidbody.md)
-
-
-</td><td>
-
-_(Optional)_ The parent rigid body of the collider.
-
-
-</td></tr>
-<tr><td>
-
-[radius?](./server.collideroptions.radius.md)
-
-
-</td><td>
-
-
-</td><td>
-
-number
-
-
-</td><td>
-
-_(Optional)_ The radius of the collider if the shape is a ball, capsule, cone, cylinder, or round cylinder.
-
-
-</td></tr>
-<tr><td>
-
-[relativePosition?](./server.collideroptions.relativeposition.md)
-
-
-</td><td>
-
-
-</td><td>
-
-[Vector3Like](./server.vector3like.md)
-
-
-</td><td>
-
-_(Optional)_ The relative position of the collider. Relative to parent rigid body.
-
-
-</td></tr>
-<tr><td>
-
-[relativeRotation?](./server.collideroptions.relativerotation.md)
-
-
-</td><td>
-
-
-</td><td>
-
-[QuaternionLike](./server.quaternionlike.md)
-
-
-</td><td>
-
-_(Optional)_ The relative rotation of the collider. Relative to parent rigid body.
-
-
-</td></tr>
-<tr><td>
-
-[shape](./server.collideroptions.shape.md)
-
-
-</td><td>
-
-
-</td><td>
-
-[ColliderShape](./server.collidershape.md)
-
-
-</td><td>
-
-The shape of the collider.
-
-
-</td></tr>
-<tr><td>
-
-[simulation?](./server.collideroptions.simulation.md)
-
-
-</td><td>
-
-
-</td><td>
-
-[Simulation](./server.simulation.md)
-
-
-</td><td>
-
-_(Optional)_ The simulation the collider is in, if provided the collider will automatically be added to the simulation.
-
-
-</td></tr>
-<tr><td>
-
-[tag?](./server.collideroptions.tag.md)
-
-
-</td><td>
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-_(Optional)_ An arbitrary identifier tag of the collider. Useful for your own logic.
-
-
-</td></tr>
-<tr><td>
-
-[vertices?](./server.collideroptions.vertices.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Float32Array
-
-
-</td><td>
-
-_(Optional)_ The vertices of the collider if the shape is a trimesh.
-
-
-</td></tr>
-</tbody></table>

package/docs/server.collidershape.md

@@ -99,6 +99,20 @@ CYLINDER
 </td><td>
 
 
+</td></tr>
+<tr><td>
+
+NONE
+
+
+</td><td>
+
+`"none"`
+
+
+</td><td>
+
+
 </td></tr>
 <tr><td>
 

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

package/docs/server.conecollideroptions.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; [ConeColliderOptions](./server.conecollideroptions.md)
+
+## ConeColliderOptions interface
+
+The options for a cone collider.
+
+**Signature:**
+
+```typescript
+export interface ConeColliderOptions 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>
+
+[halfHeight?](./server.conecollideroptions.halfheight.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+_(Optional)_ The half height of the cone collider.
+
+
+</td></tr>
+<tr><td>
+
+[radius?](./server.conecollideroptions.radius.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+_(Optional)_ The radius of the cone collider.
+
+
+</td></tr>
+<tr><td>
+
+[shape](./server.conecollideroptions.shape.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[ColliderShape.CONE](./server.collidershape.md)
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>

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

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

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

package/docs/server.cylindercollideroptions.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; [CylinderColliderOptions](./server.cylindercollideroptions.md)
+
+## CylinderColliderOptions interface
+
+The options for a cylinder collider.
+
+**Signature:**
+
+```typescript
+export interface CylinderColliderOptions 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>
+
+[halfHeight?](./server.cylindercollideroptions.halfheight.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+_(Optional)_ The half height of the cylinder collider.
+
+
+</td></tr>
+<tr><td>
+
+[radius?](./server.cylindercollideroptions.radius.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+_(Optional)_ The radius of the cylinder collider.
+
+
+</td></tr>
+<tr><td>
+
+[shape](./server.cylindercollideroptions.shape.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[ColliderShape.CYLINDER](./server.collidershape.md)
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>