Class HingeJoint

Hierarchy

  • Joint
    • HingeJoint

Accessors

activeAndEnabled context destroyed enabled forward hideFlags isComponent layer name right rigidBody scene static tag up worldEuler worldPosition worldQuaternion worldRotation

Methods

addEventListener awake createJoint destroy dispatchEvent earlyUpdate? lateUpdate? onAfterRender? onBeforeRender? onCollisionEnter? onCollisionExit? onCollisionStay? onDestroy onDisable onEnable onPausedChanged? onTriggerEnter? onTriggerExit? onTriggerStay? onValidate? removeEventListener resolveGuids? setWorldPosition setWorldQuaternion setWorldRotation start? startCoroutine stopCoroutine update?

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

hideFlags

  • get hideFlags(): HideFlags

  • Returns HideFlags

isComponent

  • get isComponent(): boolean

  • Returns boolean

layer

  • get layer(): number

  • Returns number

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

rigidBody

scene

  • get scene(): Scene

  • Returns Scene

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

awake

  • awake(): void

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

    Returns void

Protected createJoint

  • createJoint(self, other): void

  • Parameters

    Returns void

destroy

  • destroy(): void

  • Returns void

dispatchEvent

  • dispatchEvent(evt): boolean

  • Parameters

    Returns boolean

Optional earlyUpdate

  • earlyUpdate(): void

  • Returns void

Optional lateUpdate

  • lateUpdate(): void

  • Returns void

Optional onAfterRender

  • onAfterRender(): void

  • Returns void

Optional onBeforeRender

  • onBeforeRender(frame): void

  • Parameters

    • frame: any

    Returns void

Optional onCollisionEnter

  • onCollisionEnter(col): any

  • Parameters

    Returns any

Optional onCollisionExit

  • onCollisionExit(col): any

  • Parameters

    Returns any

Optional onCollisionStay

  • onCollisionStay(col): any

  • Parameters

    Returns any

onDestroy

  • onDestroy(): void

  • Returns void

onDisable

  • onDisable(): void

  • Returns void

onEnable

  • onEnable(): void

  • 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

Optional onValidate

  • onValidate(prop?): void

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

    Parameters

    • Optional prop: string

    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

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

setWorldPosition

  • setWorldPosition(x, y, z): void

  • Parameters

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

    Returns void

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

  • startCoroutine(routine, evt?): Generator<unknown, any, unknown>

  • Parameters

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

    Returns Generator<unknown, any, unknown>

stopCoroutine

  • stopCoroutine(routine, evt?): void

  • Parameters

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

    Returns void

Optional update

  • update(): void

  • Returns void

Settings

Member Visibility

Theme

On This Page

activeAndEnabledcontextdestroyedenabledforwardhideFlagsisComponentlayernamerightrigidBodyscenestatictagupworldEulerworldPositionworldQuaternionworldRotationaddEventListenerawakecreateJointdestroydispatchEventearlyUpdatelateUpdateonAfterRenderonBeforeRenderonCollisionEnteronCollisionExitonCollisionStayonDestroyonDisableonEnableonPausedChangedonTriggerEnteronTriggerExitonTriggerStayonValidateremoveEventListenerresolveGuidssetWorldPositionsetWorldQuaternionsetWorldRotationstartstartCoroutinestopCoroutineupdate

Generated using TypeDoc