hytopia 0.1.1 → 0.1.3

package/docs/server.hytopia.collider.setfriction.md

@@ -0,0 +1,53 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [HYTOPIA](./server.hytopia.md) &gt; [Collider](./server.hytopia.collider.md) &gt; [setFriction](./server.hytopia.collider.setfriction.md)
+
+## HYTOPIA.Collider.setFriction() method
+
+Sets the friction of the collider.
+
+**Signature:**
+
+```typescript
+setFriction(friction: number): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+friction
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+The friction of the collider.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

package/docs/server.hytopia.collider.setmass.md

@@ -0,0 +1,53 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [HYTOPIA](./server.hytopia.md) &gt; [Collider](./server.hytopia.collider.md) &gt; [setMass](./server.hytopia.collider.setmass.md)
+
+## HYTOPIA.Collider.setMass() method
+
+Sets the mass of the collider.
+
+**Signature:**
+
+```typescript
+setMass(mass: number): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+mass
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+The mass of the collider.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

package/docs/server.hytopia.collider.setoncollision.md

@@ -0,0 +1,53 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [HYTOPIA](./server.hytopia.md) &gt; [Collider](./server.hytopia.collider.md) &gt; [setOnCollision](./server.hytopia.collider.setoncollision.md)
+
+## HYTOPIA.Collider.setOnCollision() method
+
+Sets the on collision callback for the collider.
+
+**Signature:**
+
+```typescript
+setOnCollision(callback: CollisionCallback | undefined): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+callback
+
+
+</td><td>
+
+[CollisionCallback](./server.collisioncallback.md) \| undefined
+
+
+</td><td>
+
+The on collision callback for the collider.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

package/docs/server.hytopia.collider.setrelativerotation.md

@@ -0,0 +1,53 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [HYTOPIA](./server.hytopia.md) &gt; [Collider](./server.hytopia.collider.md) &gt; [setRelativeRotation](./server.hytopia.collider.setrelativerotation.md)
+
+## HYTOPIA.Collider.setRelativeRotation() method
+
+Sets the relative rotation of the collider.
+
+**Signature:**
+
+```typescript
+setRelativeRotation(rotation: Rotation): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+rotation
+
+
+</td><td>
+
+[Rotation](./server.rotation.md)
+
+
+</td><td>
+
+The relative rotation of the collider.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

package/docs/server.hytopia.collider.setrelativetranslation.md

@@ -0,0 +1,53 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [HYTOPIA](./server.hytopia.md) &gt; [Collider](./server.hytopia.collider.md) &gt; [setRelativeTranslation](./server.hytopia.collider.setrelativetranslation.md)
+
+## HYTOPIA.Collider.setRelativeTranslation() method
+
+Sets the relative translation of the collider to its parent rigid body.
+
+**Signature:**
+
+```typescript
+setRelativeTranslation(translation: Vector3): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+translation
+
+
+</td><td>
+
+[Vector3](./server.vector3.md)
+
+
+</td><td>
+
+The relative translation of the collider.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

package/docs/server.hytopia.collider.setsensor.md

@@ -0,0 +1,53 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [HYTOPIA](./server.hytopia.md) &gt; [Collider](./server.hytopia.collider.md) &gt; [setSensor](./server.hytopia.collider.setsensor.md)
+
+## HYTOPIA.Collider.setSensor() method
+
+Sets whether the collider is a sensor.
+
+**Signature:**
+
+```typescript
+setSensor(sensor: boolean): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+sensor
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+Whether the collider is a sensor.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

package/docs/server.hytopia.collider.settag.md

@@ -0,0 +1,53 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [HYTOPIA](./server.hytopia.md) &gt; [Collider](./server.hytopia.collider.md) &gt; [setTag](./server.hytopia.collider.settag.md)
+
+## HYTOPIA.Collider.setTag() method
+
+Sets the tag of the collider.
+
+**Signature:**
+
+```typescript
+setTag(tag: string): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+tag
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+The tag of the collider.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

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

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

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

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

package/docs/server.hytopia.collideroptions.enabled.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; [HYTOPIA](./server.hytopia.md) &gt; [ColliderOptions](./server.hytopia.collideroptions.md) &gt; [enabled](./server.hytopia.collideroptions.enabled.md)
+
+## HYTOPIA.ColliderOptions.enabled property
+
+Whether the collider is enabled.
+
+**Signature:**
+
+```typescript
+enabled?: boolean;
+```

package/docs/server.hytopia.collideroptions.friction.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; [HYTOPIA](./server.hytopia.md) &gt; [ColliderOptions](./server.hytopia.collideroptions.md) &gt; [friction](./server.hytopia.collideroptions.friction.md)
+
+## HYTOPIA.ColliderOptions.friction property
+
+The friction of the collider.
+
+**Signature:**
+
+```typescript
+friction?: number;
+```

package/docs/server.hytopia.collideroptions.halfextents.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; [HYTOPIA](./server.hytopia.md) &gt; [ColliderOptions](./server.hytopia.collideroptions.md) &gt; [halfExtents](./server.hytopia.collideroptions.halfextents.md)
+
+## HYTOPIA.ColliderOptions.halfExtents property
+
+The half extents of the collider if the shape is a block.
+
+**Signature:**
+
+```typescript
+halfExtents?: Vector3;
+```

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

package/docs/server.hytopia.collideroptions.issensor.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; [HYTOPIA](./server.hytopia.md) &gt; [ColliderOptions](./server.hytopia.collideroptions.md) &gt; [isSensor](./server.hytopia.collideroptions.issensor.md)
+
+## HYTOPIA.ColliderOptions.isSensor property
+
+Whether the collider is a sensor.
+
+**Signature:**
+
+```typescript
+isSensor?: boolean;
+```

package/docs/server.hytopia.collideroptions.mass.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; [HYTOPIA](./server.hytopia.md) &gt; [ColliderOptions](./server.hytopia.collideroptions.md) &gt; [mass](./server.hytopia.collideroptions.mass.md)
+
+## HYTOPIA.ColliderOptions.mass property
+
+The mass of the collider.
+
+**Signature:**
+
+```typescript
+mass?: number;
+```