Class Rigidbody

Hierarchy (view full)

Implements

  • IRigidbody

Properties

autoMass dominanceGroup

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 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

autoMass

autoMass: boolean = true

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

dominanceGroup

dominanceGroup: number = 0

Rigidbodies with higher dominance will be immune to forces originating from contacts with rigidbodies of lower dominance.
Read more here: https://rapier.rs/docs/user_guides/javascript/rigid_bodies#dominance

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

  • Returns Vector3

gravityScale

  • get gravityScale(): number

  • Returns number

  • set gravityScale(val): void

  • Parameters

    • val: number

    Returns void

hideFlags

  • get hideFlags(): HideFlags

  • Returns HideFlags

isComponent

  • get isComponent(): boolean

  • Returns boolean

layer

  • get layer(): number

  • Returns number

lockPositionX

  • get lockPositionX(): boolean

  • Returns boolean

  • set lockPositionX(v): void

  • Parameters

    • v: boolean

    Returns void

lockPositionY

  • get lockPositionY(): boolean

  • Returns boolean

  • set lockPositionY(v): void

  • Parameters

    • v: boolean

    Returns void

lockPositionZ

  • get lockPositionZ(): boolean

  • Returns boolean

  • set lockPositionZ(v): void

  • Parameters

    • v: boolean

    Returns void

lockRotationX

  • get lockRotationX(): boolean

  • Returns boolean

  • set lockRotationX(v): void

  • Parameters

    • v: boolean

    Returns void

lockRotationY

  • get lockRotationY(): boolean

  • Returns boolean

  • set lockRotationY(v): void

  • Parameters

    • v: boolean

    Returns void

lockRotationZ

  • get lockRotationZ(): boolean

  • Returns boolean

  • set lockRotationZ(v): void

  • Parameters

    • v: boolean

    Returns void

mass

  • get mass(): number

  • Returns number

  • set mass(value): void

  • Parameters

    • value: number

    Returns void

name

  • get name(): string

  • Returns string

  • set name(str): void

  • Parameters

    • str: string

    Returns void

right

  • get right(): Vector3

  • Returns Vector3

scene

  • get scene(): Scene

  • Returns Scene

smoothedVelocity

  • get smoothedVelocity(): Vector3

  • 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

  • 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

  • applyForce(vec, _rel?, wakeup?): void

  • Parameters

    • vec: any
    • Optional _rel: Vector3
    • wakeup: boolean = true

    Returns void

applyImpulse

  • applyImpulse(vec, wakeup?): void

  • Parameters

    • vec: any
    • wakeup: boolean = true

    Returns void

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

  • getAngularVelocity(): Vector3

  • Returns Vector3

getVelocity

  • getVelocity(): Vector3

  • Returns Vector3

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 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

setForce

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

  • Parameters

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

    Returns void

setTorque

  • setTorque(x, y, z): void

  • 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

  • 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

  • Returns void

Settings

Member Visibility

Theme

On This Page

autoMassdominanceGroupactiveAndEnabledcontextdestroyedenabledforwardgravityScalehideFlagsisComponentlayerlockPositionXlockPositionYlockPositionZlockRotationXlockRotationYlockRotationZmassnamerightscenesmoothedVelocitystatictagupworldEulerworldPositionworldQuaternionworldRotationaddEventListenerapplyForceapplyImpulseawakebeforePhysicsdestroydispatchEventearlyUpdategetAngularVelocitygetVelocitylateUpdateonAfterRenderonBeforeRenderonCollisionEnteronCollisionExitonCollisionStayonDestroyonDisableonEnableonTriggerEnteronTriggerExitonTriggerStayonValidateremoveEventListenerresetForcesresetForcesAndTorquesresetTorquesresetVelocitiesresolveGuidssetAngularVelocitysetBodyFromGameObjectsetForcesetTorquesetVelocitysetWorldPositionsetWorldQuaternionsetWorldRotationstartstartCoroutinestopCoroutineteleportupdatewakeUp

Generated using TypeDoc