hytopia 0.1.1 → 0.1.3

package/docs/server.hytopia.collider.md

@@ -0,0 +1,509 @@
+<!-- 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)
+
+## HYTOPIA.Collider class
+
+Represents a collider in a world's physics simulation.
+
+**Signature:**
+
+```typescript
+export default class Collider 
+```
+
+## Remarks
+
+Colliders make up the foundation of the physical interactions in a world. They are highly configurable and have many aspects that can be adjusted both before simulation and while simulated. Colliders will most often be used through passing [ColliderOptions](./server.collideroptions.md) to a [RigidBody](./server.rigidbody.md) or an entity's [EntityOptions](./server.entityoptions.md)<!-- -->.
+
+## Constructors
+
+<table><thead><tr><th>
+
+Constructor
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[(constructor)(colliderOptions)](./server.hytopia.collider._constructor_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Constructs a new instance of the `Collider` class
+
+
+</td></tr>
+</tbody></table>
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[isEnabled](./server.hytopia.collider.isenabled.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+Whether the collider is enabled.
+
+
+</td></tr>
+<tr><td>
+
+[isRemoved](./server.hytopia.collider.isremoved.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+Whether the collider has been removed from the simulation.
+
+
+</td></tr>
+<tr><td>
+
+[isSensor](./server.hytopia.collider.issensor.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+Whether the collider is a sensor.
+
+
+</td></tr>
+<tr><td>
+
+[isSimulated](./server.hytopia.collider.issimulated.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+Whether the collider is simulated.
+
+
+</td></tr>
+<tr><td>
+
+[parentRigidBody](./server.hytopia.collider.parentrigidbody.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+[RigidBody](./server.rigidbody.md) \| undefined
+
+
+</td><td>
+
+The parent rigid body of the collider.
+
+
+</td></tr>
+<tr><td>
+
+[rawCollider](./server.hytopia.collider.rawcollider.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+RAPIER.Collider \| undefined
+
+
+</td><td>
+
+The raw collider object from the Rapier physics engine.
+
+
+</td></tr>
+<tr><td>
+
+[tag](./server.hytopia.collider.tag.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+string \| undefined
+
+
+</td><td>
+
+An arbitrary identifier tag of the collider. Useful for your own logic.
+
+
+</td></tr>
+</tbody></table>
+
+## Methods
+
+<table><thead><tr><th>
+
+Method
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[addToSimulation(simulation, parentRigidBody)](./server.hytopia.collider.addtosimulation.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Adds the collider to the simulation.
+
+
+</td></tr>
+<tr><td>
+
+[enableCollisionEvents(enabled)](./server.hytopia.collider.enablecollisionevents.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Enables or disables collision events for the collider. This is automatically enabled if an on collision callback is set.
+
+
+</td></tr>
+<tr><td>
+
+[enableContactForceEvents(enabled)](./server.hytopia.collider.enablecontactforceevents.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Enables or disables contact force events for the collider. This is automatically enabled if an on contact force callback is set.
+
+
+</td></tr>
+<tr><td>
+
+[getBounciness()](./server.hytopia.collider.getbounciness.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Gets the bounciness of the collider.
+
+
+</td></tr>
+<tr><td>
+
+[getCollisionGroups()](./server.hytopia.collider.getcollisiongroups.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Gets the collision groups the collider belongs to.
+
+
+</td></tr>
+<tr><td>
+
+[getFriction()](./server.hytopia.collider.getfriction.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Gets the friction of the collider.
+
+
+</td></tr>
+<tr><td>
+
+[getRelativeRotation()](./server.hytopia.collider.getrelativerotation.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Gets the relative rotation of the collider.
+
+
+</td></tr>
+<tr><td>
+
+[getRelativeTranslation()](./server.hytopia.collider.getrelativetranslation.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Gets the relative translation of the collider to its parent rigid body.
+
+
+</td></tr>
+<tr><td>
+
+[removeFromSimulation()](./server.hytopia.collider.removefromsimulation.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Removes the collider from the simulation.
+
+
+</td></tr>
+<tr><td>
+
+[setBounciness(bounciness)](./server.hytopia.collider.setbounciness.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Sets the bounciness of the collider.
+
+
+</td></tr>
+<tr><td>
+
+[setCollisionGroups(collisionGroups)](./server.hytopia.collider.setcollisiongroups.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Sets the collision groups of the collider.
+
+
+</td></tr>
+<tr><td>
+
+[setEnabled(enabled)](./server.hytopia.collider.setenabled.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Sets whether the collider is enabled.
+
+
+</td></tr>
+<tr><td>
+
+[setFriction(friction)](./server.hytopia.collider.setfriction.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Sets the friction of the collider.
+
+
+</td></tr>
+<tr><td>
+
+[setMass(mass)](./server.hytopia.collider.setmass.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Sets the mass of the collider.
+
+
+</td></tr>
+<tr><td>
+
+[setOnCollision(callback)](./server.hytopia.collider.setoncollision.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Sets the on collision callback for the collider.
+
+
+</td></tr>
+<tr><td>
+
+[setRelativeRotation(rotation)](./server.hytopia.collider.setrelativerotation.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Sets the relative rotation of the collider.
+
+
+</td></tr>
+<tr><td>
+
+[setRelativeTranslation(translation)](./server.hytopia.collider.setrelativetranslation.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Sets the relative translation of the collider to its parent rigid body.
+
+
+</td></tr>
+<tr><td>
+
+[setSensor(sensor)](./server.hytopia.collider.setsensor.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Sets whether the collider is a sensor.
+
+
+</td></tr>
+<tr><td>
+
+[setTag(tag)](./server.hytopia.collider.settag.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Sets the tag of the collider.
+
+
+</td></tr>
+</tbody></table>

package/docs/server.hytopia.collider.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; [HYTOPIA](./server.hytopia.md) &gt; [Collider](./server.hytopia.collider.md) &gt; [parentRigidBody](./server.hytopia.collider.parentrigidbody.md)
+
+## HYTOPIA.Collider.parentRigidBody property
+
+The parent rigid body of the collider.
+
+**Signature:**
+
+```typescript
+get parentRigidBody(): RigidBody | undefined;
+```

package/docs/server.hytopia.collider.rawcollider.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; [rawCollider](./server.hytopia.collider.rawcollider.md)
+
+## HYTOPIA.Collider.rawCollider property
+
+The raw collider object from the Rapier physics engine.
+
+**Signature:**
+
+```typescript
+get rawCollider(): RAPIER.Collider | undefined;
+```

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

@@ -0,0 +1,17 @@
+<!-- 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; [removeFromSimulation](./server.hytopia.collider.removefromsimulation.md)
+
+## HYTOPIA.Collider.removeFromSimulation() method
+
+Removes the collider from the simulation.
+
+**Signature:**
+
+```typescript
+removeFromSimulation(): void;
+```
+**Returns:**
+
+void
+

package/docs/server.hytopia.collider.setbounciness.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; [setBounciness](./server.hytopia.collider.setbounciness.md)
+
+## HYTOPIA.Collider.setBounciness() method
+
+Sets the bounciness of the collider.
+
+**Signature:**
+
+```typescript
+setBounciness(bounciness: number): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+bounciness
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+The bounciness of the collider.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

package/docs/server.hytopia.collider.setcollisiongroups.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; [setCollisionGroups](./server.hytopia.collider.setcollisiongroups.md)
+
+## HYTOPIA.Collider.setCollisionGroups() method
+
+Sets the collision groups of the collider.
+
+**Signature:**
+
+```typescript
+setCollisionGroups(collisionGroups: CollisionGroups): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+collisionGroups
+
+
+</td><td>
+
+[CollisionGroups](./server.collisiongroups.md)
+
+
+</td><td>
+
+The collision groups of the collider.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

package/docs/server.hytopia.collider.setenabled.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; [setEnabled](./server.hytopia.collider.setenabled.md)
+
+## HYTOPIA.Collider.setEnabled() method
+
+Sets whether the collider is enabled.
+
+**Signature:**
+
+```typescript
+setEnabled(enabled: boolean): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+enabled
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+Whether the collider is enabled.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+