hytopia 0.1.1 → 0.1.3

package/docs/server.hytopia.rigidbody.md

@@ -0,0 +1,1307 @@
+<!-- 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; [RigidBody](./server.hytopia.rigidbody.md)
+
+## HYTOPIA.RigidBody class
+
+Represents a rigid body in a world's physics simulation.
+
+**Signature:**
+
+```typescript
+export default class RigidBody 
+```
+
+## Remarks
+
+Rigid bodies are the core of the physics simulation. They are used to represent physical objects (IE: entities) that can interact with each other.
+
+## Constructors
+
+<table><thead><tr><th>
+
+Constructor
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[(constructor)(options)](./server.hytopia.rigidbody._constructor_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Constructs a new instance of the `RigidBody` 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>
+
+[colliders](./server.hytopia.rigidbody.colliders.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+Set&lt;[Collider](./server.collider.md)<!-- -->&gt;
+
+
+</td><td>
+
+The colliders of the rigid body.
+
+
+</td></tr>
+<tr><td>
+
+[isCcdEnabled](./server.hytopia.rigidbody.isccdenabled.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+Whether the rigid body has continuous collision detection enabled.
+
+
+</td></tr>
+<tr><td>
+
+[isDynamic](./server.hytopia.rigidbody.isdynamic.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+Whether the rigid body is dynamic.
+
+
+</td></tr>
+<tr><td>
+
+[isEnabled](./server.hytopia.rigidbody.isenabled.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+Whether the rigid body is enabled.
+
+
+</td></tr>
+<tr><td>
+
+[isFixed](./server.hytopia.rigidbody.isfixed.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+Whether the rigid body is fixed.
+
+
+</td></tr>
+<tr><td>
+
+[isKinematic](./server.hytopia.rigidbody.iskinematic.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+Whether the rigid body is kinematic.
+
+
+</td></tr>
+<tr><td>
+
+[isKinematicPositionBased](./server.hytopia.rigidbody.iskinematicpositionbased.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+Whether the rigid body is kinematic position based.
+
+
+</td></tr>
+<tr><td>
+
+[isKinematicVelocityBased](./server.hytopia.rigidbody.iskinematicvelocitybased.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+Whether the rigid body is kinematic velocity based.
+
+
+</td></tr>
+<tr><td>
+
+[isMoving](./server.hytopia.rigidbody.ismoving.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+Whether the rigid body is moving.
+
+
+</td></tr>
+<tr><td>
+
+[isRemoved](./server.hytopia.rigidbody.isremoved.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+Whether the rigid body has been removed from the simulation.
+
+
+</td></tr>
+<tr><td>
+
+[isSimulated](./server.hytopia.rigidbody.issimulated.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+Whether the rigid body is simulated.
+
+
+</td></tr>
+<tr><td>
+
+[isSleeping](./server.hytopia.rigidbody.issleeping.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+Whether the rigid body is sleeping.
+
+
+</td></tr>
+<tr><td>
+
+[numColliders](./server.hytopia.rigidbody.numcolliders.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+The number of colliders in the rigid body.
+
+
+</td></tr>
+<tr><td>
+
+[rawRigidBody](./server.hytopia.rigidbody.rawrigidbody.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+RAPIER.RigidBody \| undefined
+
+
+</td><td>
+
+The raw RAPIER rigid body instance.
+
+
+</td></tr>
+<tr><td>
+
+[tag](./server.hytopia.rigidbody.tag.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+string \| undefined
+
+
+</td><td>
+
+An arbitrary identifier tag of the rigid body. 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>
+
+[addChildColliderToSimulation(collider)](./server.hytopia.rigidbody.addchildcollidertosimulation.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Adds an unsimulated child collider to the rigid body for the simulation it belongs to.
+
+
+</td></tr>
+<tr><td>
+
+[addForce(force)](./server.hytopia.rigidbody.addforce.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Adds a force to the rigid body.
+
+
+</td></tr>
+<tr><td>
+
+[addTorque(torque)](./server.hytopia.rigidbody.addtorque.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Adds a torque to the rigid body.
+
+
+</td></tr>
+<tr><td>
+
+[addToSimulation(simulation)](./server.hytopia.rigidbody.addtosimulation.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Adds the rigid body to a simulation.
+
+
+</td></tr>
+<tr><td>
+
+[applyImpulse(impulse)](./server.hytopia.rigidbody.applyimpulse.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Applies an impulse to the rigid body.
+
+
+</td></tr>
+<tr><td>
+
+[applyImpulseAtPoint(impulse, point)](./server.hytopia.rigidbody.applyimpulseatpoint.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Applies an impulse to the rigid body at a point.
+
+
+</td></tr>
+<tr><td>
+
+[applyTorqueImpulse(impulse)](./server.hytopia.rigidbody.applytorqueimpulse.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Applies a torque impulse to the rigid body.
+
+
+</td></tr>
+<tr><td>
+
+[createAndAddChildCollidersToSimulation(colliderOptions)](./server.hytopia.rigidbody.createandaddchildcolliderstosimulation.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Creates and adds multiple child colliders to the rigid body for the simulation it belongs to.
+
+
+</td></tr>
+<tr><td>
+
+[createAndAddChildColliderToSimulation(colliderOptions)](./server.hytopia.rigidbody.createandaddchildcollidertosimulation.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Creates and adds a child collider to the rigid body for the simulation it belongs to.
+
+
+</td></tr>
+<tr><td>
+
+[getAdditionalMass()](./server.hytopia.rigidbody.getadditionalmass.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Gets the additional mass of the rigid body.
+
+
+</td></tr>
+<tr><td>
+
+[getAdditionalSolverIterations()](./server.hytopia.rigidbody.getadditionalsolveriterations.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Gets the additional solver iterations of the rigid body.
+
+
+</td></tr>
+<tr><td>
+
+[getAngularDamping()](./server.hytopia.rigidbody.getangulardamping.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Gets the angular damping of the rigid body.
+
+
+</td></tr>
+<tr><td>
+
+[getAngularVelocity()](./server.hytopia.rigidbody.getangularvelocity.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Gets the angular velocity of the rigid body.
+
+
+</td></tr>
+<tr><td>
+
+[getCollidersByTag(tag)](./server.hytopia.rigidbody.getcollidersbytag.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Gets the colliders of the rigid body by tag.
+
+
+</td></tr>
+<tr><td>
+
+[getDirectionFromRotation()](./server.hytopia.rigidbody.getdirectionfromrotation.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Gets the direction from the rotation of the rigid body.
+
+
+</td></tr>
+<tr><td>
+
+[getDominanceGroup()](./server.hytopia.rigidbody.getdominancegroup.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Gets the dominance group of the rigid body.
+
+
+</td></tr>
+<tr><td>
+
+[getEffectiveAngularInertia()](./server.hytopia.rigidbody.geteffectiveangularinertia.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Gets the effective angular inertia of the rigid body.
+
+
+</td></tr>
+<tr><td>
+
+[getEffectiveInverseMass()](./server.hytopia.rigidbody.geteffectiveinversemass.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Gets the effective inverse mass of the rigid body.
+
+
+</td></tr>
+<tr><td>
+
+[getEffectiveWorldInversePrincipalAngularInertiaSqrt()](./server.hytopia.rigidbody.geteffectiveworldinverseprincipalangularinertiasqrt.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Gets the effective world inverse principal angular inertia square root of the rigid body.
+
+
+</td></tr>
+<tr><td>
+
+[getEnabledRotations()](./server.hytopia.rigidbody.getenabledrotations.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Gets the enabled rotations of the rigid body.
+
+
+</td></tr>
+<tr><td>
+
+[getEnabledTranslations()](./server.hytopia.rigidbody.getenabledtranslations.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Gets the enabled translations of the rigid body.
+
+
+</td></tr>
+<tr><td>
+
+[getGravityScale()](./server.hytopia.rigidbody.getgravityscale.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Gets the gravity scale of the rigid body.
+
+
+</td></tr>
+<tr><td>
+
+[getInverseMass()](./server.hytopia.rigidbody.getinversemass.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Gets the inverse mass of the rigid body.
+
+
+</td></tr>
+<tr><td>
+
+[getInversePrincipalAngularInertiaSqrt()](./server.hytopia.rigidbody.getinverseprincipalangularinertiasqrt.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Gets the inverse principal angular inertia square root of the rigid body.
+
+
+</td></tr>
+<tr><td>
+
+[getLinearDamping()](./server.hytopia.rigidbody.getlineardamping.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Gets the linear damping of the rigid body.
+
+
+</td></tr>
+<tr><td>
+
+[getLinearVelocity()](./server.hytopia.rigidbody.getlinearvelocity.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Gets the linear velocity of the rigid body.
+
+
+</td></tr>
+<tr><td>
+
+[getLocalCenterOfMass()](./server.hytopia.rigidbody.getlocalcenterofmass.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Gets the local center of mass of the rigid body.
+
+
+</td></tr>
+<tr><td>
+
+[getMass()](./server.hytopia.rigidbody.getmass.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Gets the mass of the rigid body.
+
+
+</td></tr>
+<tr><td>
+
+[getNextKinematicRotation()](./server.hytopia.rigidbody.getnextkinematicrotation.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Gets the next kinematic rotation of the rigid body.
+
+
+</td></tr>
+<tr><td>
+
+[getNextKinematicTranslation()](./server.hytopia.rigidbody.getnextkinematictranslation.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Gets the next kinematic translation of the rigid body.
+
+
+</td></tr>
+<tr><td>
+
+[getPrincipalAngularInertia()](./server.hytopia.rigidbody.getprincipalangularinertia.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Gets the principal angular inertia of the rigid body.
+
+
+</td></tr>
+<tr><td>
+
+[getPrincipalAngularInertiaLocalFrame()](./server.hytopia.rigidbody.getprincipalangularinertialocalframe.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Gets the principal angular inertia local frame of the rigid body.
+
+
+</td></tr>
+<tr><td>
+
+[getRotation()](./server.hytopia.rigidbody.getrotation.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Gets the rotation of the rigid body.
+
+
+</td></tr>
+<tr><td>
+
+[getSoftCcdPrediction()](./server.hytopia.rigidbody.getsoftccdprediction.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Gets the soft ccd prediction of the rigid body.
+
+
+</td></tr>
+<tr><td>
+
+[getTranslation()](./server.hytopia.rigidbody.gettranslation.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Gets the translation of the rigid body.
+
+
+</td></tr>
+<tr><td>
+
+[getType()](./server.hytopia.rigidbody.gettype.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Gets the type of the rigid body.
+
+
+</td></tr>
+<tr><td>
+
+[getWorldCenterOfMass()](./server.hytopia.rigidbody.getworldcenterofmass.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Gets the world center of mass of the rigid body.
+
+
+</td></tr>
+<tr><td>
+
+[lockAllRotations()](./server.hytopia.rigidbody.lockallrotations.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Locks all rotations of the rigid body.
+
+
+</td></tr>
+<tr><td>
+
+[lockAllTranslations()](./server.hytopia.rigidbody.lockalltranslations.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Locks all translations of the rigid body.
+
+
+</td></tr>
+<tr><td>
+
+[removeFromSimulation()](./server.hytopia.rigidbody.removefromsimulation.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Removes the rigid body from the simulation it belongs to.
+
+
+</td></tr>
+<tr><td>
+
+[setAdditionalMass(additionalMass)](./server.hytopia.rigidbody.setadditionalmass.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Sets the additional mass of the rigid body.
+
+
+</td></tr>
+<tr><td>
+
+[setAdditionalMassProperties(additionalMassProperties)](./server.hytopia.rigidbody.setadditionalmassproperties.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Sets the additional mass properties of the rigid body.
+
+
+</td></tr>
+<tr><td>
+
+[setAdditionalSolverIterations(solverIterations)](./server.hytopia.rigidbody.setadditionalsolveriterations.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Sets the additional solver iterations of the rigid body.
+
+
+</td></tr>
+<tr><td>
+
+[setAngularDamping(angularDamping)](./server.hytopia.rigidbody.setangulardamping.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Sets the angular damping of the rigid body.
+
+
+</td></tr>
+<tr><td>
+
+[setAngularVelocity(angularVelocity)](./server.hytopia.rigidbody.setangularvelocity.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Sets the angular velocity of the rigid body.
+
+
+</td></tr>
+<tr><td>
+
+[setCcdEnabled(ccdEnabled)](./server.hytopia.rigidbody.setccdenabled.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Sets whether the rigid body has continuous collision detection enabled.
+
+
+</td></tr>
+<tr><td>
+
+[setCollisionGroupsForSolidColliders(collisionGroups)](./server.hytopia.rigidbody.setcollisiongroupsforsolidcolliders.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Sets the collision groups for solid colliders (non-sensor) of the rigid body.
+
+
+</td></tr>
+<tr><td>
+
+[setDominanceGroup(dominanceGroup)](./server.hytopia.rigidbody.setdominancegroup.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Sets the dominance group of the rigid body.
+
+
+</td></tr>
+<tr><td>
+
+[setEnabled(enabled)](./server.hytopia.rigidbody.setenabled.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Sets whether the rigid body is enabled.
+
+
+</td></tr>
+<tr><td>
+
+[setEnabledRotations(enabledRotations)](./server.hytopia.rigidbody.setenabledrotations.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Sets whether the rigid body has enabled rotations.
+
+
+</td></tr>
+<tr><td>
+
+[setEnabledTranslations(enabledTranslations)](./server.hytopia.rigidbody.setenabledtranslations.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Sets whether the rigid body has enabled translations.
+
+
+</td></tr>
+<tr><td>
+
+[setGravityScale(gravityScale)](./server.hytopia.rigidbody.setgravityscale.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Sets the gravity scale of the rigid body.
+
+
+</td></tr>
+<tr><td>
+
+[setLinearDamping(linearDamping)](./server.hytopia.rigidbody.setlineardamping.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Sets the linear damping of the rigid body.
+
+
+</td></tr>
+<tr><td>
+
+[setLinearVelocity(linearVelocity)](./server.hytopia.rigidbody.setlinearvelocity.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Sets the linear velocity of the rigid body.
+
+
+</td></tr>
+<tr><td>
+
+[setNextKinematicRotation(nextKinematicRotation)](./server.hytopia.rigidbody.setnextkinematicrotation.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Sets the next kinematic rotation of the rigid body.
+
+
+</td></tr>
+<tr><td>
+
+[setNextKinematicTranslation(nextKinematicTranslation)](./server.hytopia.rigidbody.setnextkinematictranslation.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Sets the next kinematic translation of the rigid body.
+
+
+</td></tr>
+<tr><td>
+
+[setRotation(rotation)](./server.hytopia.rigidbody.setrotation.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Sets the rotation of the rigid body.
+
+
+</td></tr>
+<tr><td>
+
+[setSleeping(sleeping)](./server.hytopia.rigidbody.setsleeping.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Sets whether the rigid body is sleeping.
+
+
+</td></tr>
+<tr><td>
+
+[setSoftCcdPrediction(softCcdPrediction)](./server.hytopia.rigidbody.setsoftccdprediction.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Sets the soft ccd prediction of the rigid body.
+
+
+</td></tr>
+<tr><td>
+
+[setTag(tag)](./server.hytopia.rigidbody.settag.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Sets the tag of the rigid body.
+
+
+</td></tr>
+<tr><td>
+
+[setTranslation(translation)](./server.hytopia.rigidbody.settranslation.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Sets the translation of the rigid body.
+
+
+</td></tr>
+<tr><td>
+
+[setType(type)](./server.hytopia.rigidbody.settype.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Sets the type of the rigid body.
+
+
+</td></tr>
+<tr><td>
+
+[sleep()](./server.hytopia.rigidbody.sleep.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Explicitly puts the rigid body to sleep. Physics otherwise optimizes sleeping.
+
+
+</td></tr>
+<tr><td>
+
+[wakeUp()](./server.hytopia.rigidbody.wakeup.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Wakes up the rigid body. Physics otherwise optimizes waking it when necessary.
+
+
+</td></tr>
+</tbody></table>