Class Rigidbody

Hierarchy (view full)

Implements

  • IRigidbody

Properties

angularDrag autoMass collisionDetectionMode dominanceGroup drag sleepThreshold

Accessors

activeAndEnabled context destroyed enabled forward gravityScale hideFlags isComponent layer lockPositionX lockPositionY lockPositionZ lockRotationX lockRotationY lockRotationZ mass name right scene smoothedVelocity static tag up worldEuler worldPosition worldQuaternion worldRotation

Methods

addEventListener applyForce applyImpulse awake beforePhysics destroy dispatchEvent earlyUpdate? getAngularVelocity getVelocity lateUpdate? onAfterRender? onBeforeRender? onCollisionEnter? onCollisionExit? onCollisionStay? onDestroy onDisable onEnable onPausedChanged? onTriggerEnter? onTriggerExit? onTriggerStay? onValidate removeEventListener resetForces resetForcesAndTorques resetTorques resetVelocities resolveGuids? setAngularVelocity setBodyFromGameObject setForce setTorque setVelocity setWorldPosition setWorldQuaternion setWorldRotation start? startCoroutine stopCoroutine teleport update? wakeUp

Properties

angularDrag

angularDrag: number = 1

Link

https://rapier.rs/docs/user_guides/javascript/rigid_bodies#damping

autoMass

autoMass: boolean = true

When true the mass will be automatically calculated by the attached colliders

collisionDetectionMode

collisionDetectionMode: CollisionDetectionMode = CollisionDetectionMode.Discrete

Link

https://rapier.rs/docs/user_guides/javascript/rigid_bodies#continuous-collision-detection

dominanceGroup

dominanceGroup: number = 0

Rigidbodies with higher dominance will be immune to forces originating from contacts with rigidbodies of lower dominance.

Link

https://rapier.rs/docs/user_guides/javascript/rigid_bodies#dominance

drag

drag: number = 0

Link

https://rapier.rs/docs/user_guides/javascript/rigid_bodies#damping

sleepThreshold

sleepThreshold: number = 0.01

Link

https://rapier.rs/docs/user_guides/javascript/rigid_bodies#sleeping

Accessors

activeAndEnabled

  • get activeAndEnabled(): boolean

  • Returns boolean

context

  • get context(): Context

  • Returns Context

  • set context(context): void

  • Parameters

    Returns void

destroyed

  • get destroyed(): boolean

  • Returns boolean

enabled

  • get enabled(): boolean

  • Returns boolean

  • set enabled(val): void

  • Parameters

    • val: boolean

    Returns void

forward

  • get forward(): Vector3

  • Forward (0,0,-1) vector in world space

    Returns Vector3

gravityScale

  • get gravityScale(): number

  • Returns number

  • set gravityScale(val): void

  • Gravity is such a common force that it is implemented as a special case (even if it could easily be implemented by the user using force application). Note however that a change of gravity won't automatically wake-up the sleeping bodies so keep in mind that you may want to wake them up manually before a gravity change.

    It is possible to change the way gravity affects a specific rigid-body by setting the rigid-body's gravity scale to a value other than 1.0. The magnitude of the gravity applied to this body will be multiplied by this scaling factor. Therefore, a gravity scale set to 0.0 will disable gravity for the rigid-body whereas a gravity scale set to 2.0 will make it twice as strong. A negative value will flip the direction of the gravity for this rigid-body.

    Parameters

    • val: number

    Returns void

    Link

    https://rapier.rs/docs/user_guides/javascript/rigid_bodies#gravity

hideFlags

  • get hideFlags(): HideFlags

  • Returns HideFlags

isComponent

  • get isComponent(): boolean

  • Returns boolean

layer

  • get layer(): number

  • Returns number

lockPositionX

lockPositionY

lockPositionZ

lockRotationX

lockRotationY

lockRotationZ

mass

  • get mass(): number

  • Returns number

  • set mass(value): void

  • By default the mass will be automatically calculated (see autoMass) by the physics engine using the collider sizes
    To set the mass manually you can either set the mass value or set autoMass to false

    Parameters

    • value: number

    Returns void

name

  • get name(): string

  • Returns string

  • set name(str): void

  • Parameters

    • str: string

    Returns void

right

  • get right(): Vector3

  • Right (1,0,0) vector in world space

    Returns Vector3

scene

  • get scene(): Scene

  • Returns Scene

smoothedVelocity

  • get smoothedVelocity(): Vector3

  • Returns the rigidbody velocity smoothed over ~ 10 frames

    Returns Vector3

static

  • get static(): any

  • Returns any

tag

  • get tag(): string

  • Returns string

  • set tag(str): void

  • Parameters

    • str: string

    Returns void

up

  • get up(): Vector3

  • Up (0,1,0) vector in world space

    Returns Vector3

worldEuler

  • get worldEuler(): Euler

  • Returns Euler

  • set worldEuler(val): void

  • Parameters

    • val: Euler

    Returns void

worldPosition

  • get worldPosition(): Vector3

  • Returns Vector3

  • set worldPosition(val): void

  • Parameters

    • val: Vector3

    Returns void

worldQuaternion

  • get worldQuaternion(): Quaternion

  • Returns Quaternion

  • set worldQuaternion(val): void

  • Parameters

    • val: Quaternion

    Returns void

worldRotation

  • get worldRotation(): Vector3

  • Returns Vector3

  • set worldRotation(val): void

  • Parameters

    • val: Vector3

    Returns void

Methods

addEventListener

  • addEventListener<T>(type, listener): void

  • Type Parameters

    Parameters

    • type: string
    • listener: ((evt) => any)
        • (evt): any

        • Parameters

          • evt: T

          Returns any

    Returns void

applyForce

applyImpulse

awake

  • awake(): void

  • called once when the component becomes active for the first time

    Returns void

beforePhysics

destroy

  • destroy(): void

  • Returns void

dispatchEvent

Optional earlyUpdate

  • earlyUpdate(): void

  • Returns void

getAngularVelocity

getVelocity

Optional lateUpdate

  • lateUpdate(): void

  • Returns void

Optional onAfterRender

  • onAfterRender(): void

  • Returns void

Optional onBeforeRender

  • onBeforeRender(frame): void

  • Parameters

    • frame: any

    Returns void

Optional onCollisionEnter

Optional onCollisionExit

Optional onCollisionStay

onDestroy

  • onDestroy(): void

  • Returns void

onDisable

  • onDisable(): void

  • Returns void

onEnable

  • onEnable(): void

  • called every time when the component gets enabled (this is invoked after awake and before start)

    Returns void

Optional onPausedChanged

  • onPausedChanged(isPaused, wasPaused): void

  • Called for all scripts when the context gets paused or unpaused

    Parameters

    • isPaused: boolean
    • wasPaused: boolean

    Returns void

Optional onTriggerEnter

  • onTriggerEnter(col): any

  • Parameters

    • col: ICollider

    Returns any

Optional onTriggerExit

  • onTriggerExit(col): any

  • Parameters

    • col: ICollider

    Returns any

Optional onTriggerStay

  • onTriggerStay(col): any

  • Parameters

    • col: ICollider

    Returns any

onValidate

  • onValidate(): void

  • called when you decorate fields with the @validate() decorator

    Returns void

removeEventListener

  • removeEventListener<T>(type, listener): void

  • Type Parameters

    Parameters

    • type: string
    • listener: ((arg) => any)
        • (arg): any

        • Parameters

          • arg: T

          Returns any

    Returns void

resetForces

  • resetForces(wakeup?): void

  • Parameters

    • wakeup: boolean = true

    Returns void

resetForcesAndTorques

  • resetForcesAndTorques(): void

  • Returns void

resetTorques

  • resetTorques(wakeup?): void

  • Parameters

    • wakeup: boolean = true

    Returns void

resetVelocities

  • resetVelocities(): void

  • Returns void

Optional resolveGuids

  • resolveGuids(guidsMap): void

  • called on a component with a map of old to new guids (e.g. when instantiate generated new guids and e.g. timeline track bindings needs to remape them)

    Parameters

    • guidsMap: GuidsMap

    Returns void

setAngularVelocity

  • setAngularVelocity(x, y?, z?, wakeup?): void

  • Parameters

    • x: any
    • Optional y: number
    • Optional z: number
    • wakeup: boolean = true

    Returns void

setBodyFromGameObject

  • setBodyFromGameObject(_velocity?): void

  • d

    Parameters

    • _velocity: any = null

    Returns void

    Deprecated

    not used anymore and will be removed in a future update

setForce

setTorque

  • setTorque(x, y, z): void

  • Set the angular velocity of a rigidbody (equivalent to calling setAngularVelocity)

    Parameters

    • x: any
    • y: number
    • z: number

    Returns void

setVelocity

  • setVelocity(x, y?, z?, wakeup?): void

  • Parameters

    • x: any
    • Optional y: number
    • Optional z: number
    • wakeup: boolean = true

    Returns void

setWorldPosition

setWorldQuaternion

  • setWorldQuaternion(x, y, z, w): void

  • Parameters

    • x: number
    • y: number
    • z: number
    • w: number

    Returns void

setWorldRotation

  • setWorldRotation(x, y, z, degrees?): void

  • Parameters

    • x: number
    • y: number
    • z: number
    • degrees: boolean = true

    Returns void

Optional start

  • start(): void

  • Returns void

startCoroutine

stopCoroutine

  • stopCoroutine(routine, evt?): void

  • Parameters

    • routine: Generator<unknown, any, unknown>
    • evt: FrameEvent = FrameEvent.Update

    Returns void

teleport

  • teleport(pt, localspace?): void

  • Will reset forces before setting the object world position

    Parameters

    • pt: {
          x: number;
          y: number;
          z: number;
      }
      • x: number
      • y: number
      • z: number
    • localspace: boolean = true

    Returns void

Optional update

  • update(): void

  • Returns void

wakeUp

  • wakeUp(): void

  • When a dynamic rigid-body doesn't move (or moves very slowly) during a few seconds, it will be marked as sleeping by the physics pipeline. Rigid-bodies marked as sleeping are no longer simulated by the physics engine until they are woken up. That way the physics engine doesn't waste any computational resources simulating objects that don't actually move. They are woken up automatically whenever another non-sleeping rigid-body starts interacting with them (either with a joint, or with one of its attached colliders generating contacts).

    Returns void

    Link

    https://rapier.rs/docs/user_guides/javascript/rigid_bodies#sleeping

Settings

Member Visibility

Theme

On This Page

angularDragautoMasscollisionDetectionModedominanceGroupdragsleepThresholdactiveAndEnabledcontextdestroyedenabledforwardgravityScalehideFlagsisComponentlayerlockPositionXlockPositionYlockPositionZlockRotationXlockRotationYlockRotationZmassnamerightscenesmoothedVelocitystatictagupworldEulerworldPositionworldQuaternionworldRotationaddEventListenerapplyForceapplyImpulseawakebeforePhysicsdestroydispatchEventearlyUpdategetAngularVelocitygetVelocitylateUpdateonAfterRenderonBeforeRenderonCollisionEnteronCollisionExitonCollisionStayonDestroyonDisableonEnableonPausedChangedonTriggerEnteronTriggerExitonTriggerStayonValidateremoveEventListenerresetForcesresetForcesAndTorquesresetTorquesresetVelocitiesresolveGuidssetAngularVelocitysetBodyFromGameObjectsetForcesetTorquesetVelocitysetWorldPositionsetWorldQuaternionsetWorldRotationstartstartCoroutinestopCoroutineteleportupdatewakeUp

Generated using TypeDoc