hytopia 0.1.1 → 0.1.2

package/docs/server.collideroptions.md

@@ -0,0 +1,361 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [ColliderOptions](./server.collideroptions.md)
+
+## ColliderOptions interface
+
+Options for creating a Collider instance.
+
+**Signature:**
+
+```typescript
+export interface ColliderOptions 
+```
+
+## 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>
+
+[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>
+
+[friction?](./server.collideroptions.friction.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+_(Optional)_ The friction of the collider.
+
+
+</td></tr>
+<tr><td>
+
+[halfExtents?](./server.collideroptions.halfextents.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[Vector3](./server.vector3.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>
+
+[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>
+
+[relativeRotation?](./server.collideroptions.relativerotation.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[Rotation](./server.rotation.md)
+
+
+</td><td>
+
+_(Optional)_ The relative rotation of the collider. Relative to parent rigid body.
+
+
+</td></tr>
+<tr><td>
+
+[relativeTranslation?](./server.collideroptions.relativetranslation.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[Vector3](./server.vector3.md)
+
+
+</td><td>
+
+_(Optional)_ The relative translation 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>
+</tbody></table>

package/docs/server.collideroptions.oncollision.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; [onCollision](./server.collideroptions.oncollision.md)
+
+## ColliderOptions.onCollision property
+
+The on collision callback for the collider.
+
+**Signature:**
+
+```typescript
+onCollision?: CollisionCallback;
+```

package/docs/server.collideroptions.parentrigidbody.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; [parentRigidBody](./server.collideroptions.parentrigidbody.md)
+
+## ColliderOptions.parentRigidBody property
+
+The parent rigid body of the collider.
+
+**Signature:**
+
+```typescript
+parentRigidBody?: RigidBody;
+```

package/docs/server.collideroptions.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; [ColliderOptions](./server.collideroptions.md) &gt; [radius](./server.collideroptions.radius.md)
+
+## ColliderOptions.radius property
+
+The radius of the collider if the shape is a ball, capsule, cone, cylinder, or round cylinder.
+
+**Signature:**
+
+```typescript
+radius?: number;
+```

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

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

package/docs/server.collideroptions.shape.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; [shape](./server.collideroptions.shape.md)
+
+## ColliderOptions.shape property
+
+The shape of the collider.
+
+**Signature:**
+
+```typescript
+shape: ColliderShape;
+```

package/docs/server.collideroptions.simulation.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; [simulation](./server.collideroptions.simulation.md)
+
+## ColliderOptions.simulation property
+
+The simulation the collider is in, if provided the collider will automatically be added to the simulation.
+
+**Signature:**
+
+```typescript
+simulation?: Simulation;
+```

package/docs/server.collideroptions.tag.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; [tag](./server.collideroptions.tag.md)
+
+## ColliderOptions.tag property
+
+An arbitrary identifier tag of the collider. Useful for your own logic.
+
+**Signature:**
+
+```typescript
+tag?: string;
+```

package/docs/server.collidershape.md

@@ -0,0 +1,117 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [ColliderShape](./server.collidershape.md)
+
+## ColliderShape enum
+
+The shapes a collider can be.
+
+**Signature:**
+
+```typescript
+export declare enum ColliderShape 
+```
+
+## Enumeration Members
+
+<table><thead><tr><th>
+
+Member
+
+
+</th><th>
+
+Value
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+BALL
+
+
+</td><td>
+
+`"ball"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+BLOCK
+
+
+</td><td>
+
+`"block"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+CAPSULE
+
+
+</td><td>
+
+`"capsule"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+CONE
+
+
+</td><td>
+
+`"cone"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+CYLINDER
+
+
+</td><td>
+
+`"cylinder"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+ROUND\_CYLINDER
+
+
+</td><td>
+
+`"round-cylinder"`
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>

package/docs/server.collisioncallback.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [CollisionCallback](./server.collisioncallback.md)
+
+## CollisionCallback type
+
+A callback function that is called when a collision occurs.
+
+**Signature:**
+
+```typescript
+export type CollisionCallback = (other: BlockType | Entity, started: boolean) => void;
+```
+**References:** [BlockType](./server.blocktype.md)<!-- -->, [Entity](./server.entity.md)
+

package/docs/server.collisiongroup.md

@@ -0,0 +1,116 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [CollisionGroup](./server.collisiongroup.md)
+
+## CollisionGroup enum
+
+The default collision groups.
+
+**Signature:**
+
+```typescript
+export declare enum CollisionGroup 
+```
+
+## Enumeration Members
+
+<table><thead><tr><th>
+
+Member
+
+
+</th><th>
+
+Value
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+ALL
+
+
+</td><td>
+
+`65535`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+BLOCK
+
+
+</td><td>
+
+`1`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+ENTITY
+
+
+</td><td>
+
+`2`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+ENTITY\_SENSOR
+
+
+</td><td>
+
+`4`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+PLAYER
+
+
+</td><td>
+
+`8`
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+
+## Remarks
+
+The collision groups are used to determine which objects collide and generate collision and contact force events. The default collision groups can be used for most entity and block interactions, but you may want to create your own for more complex scenarios. Up to 15 collision groups can be registered. Collision groups use pairwise filtering using bit masks.
+
+This filtering method is based on two 16-bit values: - The belongsTo groups (the 16 left-most bits of `self.0`<!-- -->). - The collidesWith mask (the 16 right-most bits of `self.0`<!-- -->).
+
+An interaction is allowed between two filters `a` and `b` two conditions are met simultaneously: - The belongsTo groups of `a` has at least one bit set to `1` in common with the collidesWith mask of `b`<!-- -->. - The belongsTo groups of `b` has at least one bit set to `1` in common with the collidesWith mask of `a`<!-- -->. In other words, interactions are allowed between two filter if the following condition is met:
+
+```
+((a >> 16) & b) != 0 && ((b >> 16) & a) != 0
+```
+