Interface IComponent

interface IComponent {
    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

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

gameObject

gameObject: IGameObject

the object this component is attached to

Accessors

activeAndEnabled

  • get activeAndEnabled(): boolean

  • Returns boolean

destroyed

  • get destroyed(): boolean

  • Returns boolean

forward

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

worldQuaternion

Methods

awake

  • awake(): any

  • Returns any

destroy

  • destroy(): any

  • Returns any

OptionalearlyUpdate

  • earlyUpdate(): void

  • Returns void

OptionallateUpdate

  • lateUpdate(): void

  • Returns void

OptionalonAfterRender

  • onAfterRender(): void

  • Returns void

OptionalonBeforeRender

  • onBeforeRender(frame): void

  • Parameters

    • frame: null | XRFrame

    Returns void

OptionalonCollisionEnter

  • onCollisionEnter(col): any

  • Parameters

    Returns any

OptionalonCollisionExit

  • onCollisionExit(col): any

  • Parameters

    Returns any

OptionalonCollisionStay

  • onCollisionStay(col): any

  • Parameters

    Returns any

onDestroy

  • onDestroy(): any

  • Returns any

onDisable

  • onDisable(): any

  • Returns any

onEnable

  • onEnable(): any

  • Returns any

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

  • onTriggerEnter(col): any

  • Parameters

    Returns any

OptionalonTriggerExit

  • onTriggerExit(col): any

  • Parameters

    Returns any

OptionalonTriggerStay

  • onTriggerStay(col): any

  • Parameters

    Returns any

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

  • start(): void

  • Returns void

Optionalupdate

  • update(): void

  • Returns void

Settings

Member Visibility

On This Page

Properties
Accessors
Methods