Interface IRigidbody

interface IRigidbody {
    autoMass: boolean;
    gameObject: IGameObject;
    get activeAndEnabled(): boolean;
    get destroyed(): boolean;
    get forward(): Vector3;
    get isComponent(): boolean;
    get layer(): number;
    get name(): string;
    get tag(): string;
    get worldPosition(): Vector3;
    get worldQuaternion(): Quaternion;
    awake(): any;
    destroy(): any;
    earlyUpdate?(): void;
    lateUpdate?(): void;
    onAfterRender?(): void;
    onBeforeRender?(frame: null | XRFrame): void;
    onCollisionEnter?(col: Collision): any;
    onCollisionExit?(col: Collision): any;
    onCollisionStay?(col: Collision): any;
    onDestroy(): any;
    onDisable(): any;
    onEnable(): any;
    onPausedChanged?(isPaused: boolean, wasPaused: boolean): any;
    onTriggerEnter?(col: ICollider): any;
    onTriggerExit?(col: ICollider): any;
    onTriggerStay?(col: ICollider): any;
    onValidate?(property?: string): any;
    registering?(): any;
    start?(): void;
    update?(): void;
}

Hierarchy (view full)

Implemented by

Properties

autoMass gameObject

Accessors

activeAndEnabled destroyed forward isComponent layer name tag worldPosition worldQuaternion

Methods

awake destroy earlyUpdate? lateUpdate? onAfterRender? onBeforeRender? onCollisionEnter? onCollisionExit? onCollisionStay? onDestroy onDisable onEnable onPausedChanged? onTriggerEnter? onTriggerExit? onTriggerStay? onValidate? registering? start? update?

Properties

autoMass

autoMass: boolean

When true the mass will automatically calculated by attached colliders

gameObject

gameObject: IGameObject

the object this component is attached to

Accessors

activeAndEnabled

  • get activeAndEnabled(): boolean

  • Returns boolean

destroyed

  • get destroyed(): boolean

  • Returns boolean

forward

  • get forward(): Vector3

  • Returns Vector3

isComponent

  • get isComponent(): boolean

  • Returns boolean

layer

  • get layer(): number

  • Returns number

name

  • get name(): string

  • Returns string

tag

  • get tag(): string

  • Returns string

worldPosition

  • get worldPosition(): Vector3

  • Returns Vector3

worldQuaternion

Methods

awake

destroy

OptionalearlyUpdate

OptionallateUpdate

OptionalonAfterRender

OptionalonBeforeRender

OptionalonCollisionEnter

OptionalonCollisionExit

OptionalonCollisionStay

onDestroy

onDisable

onEnable

OptionalonPausedChanged

  • onPausedChanged(isPaused, wasPaused): any

  • called when this.context.isPaused changes or when rendering loop changes due to changing DOM element visibility e.g. when the DOM element becomes hidden or out ot view

    Parameters

    • isPaused: boolean
    • wasPaused: boolean

    Returns any

OptionalonTriggerEnter

OptionalonTriggerExit

OptionalonTriggerStay

OptionalonValidate

  • onValidate(property?): any

  • called for properties decorated with the

    Parameters

    • Optionalproperty: string

    Returns any

    Validate

    decorator

Optionalregistering

  • registering(): any

  • experimental, called when the script is registered for the first time, this is called even if the component is not enabled.

    Returns any

Optionalstart

Optionalupdate

Settings

Member Visibility

On This Page

Properties
Accessors
Methods