Class EventSystem

Hierarchy (view full)

Constructors

constructor

Accessors

activeAndEnabled context destroyed enabled forward hasActiveUI hideFlags isComponent isHoveringObjects layer name right scene static tag up worldEuler worldPosition worldQuaternion worldRotation instance systems

Methods

addEventListener awake destroy dispatchEvent earlyUpdate? lateUpdate? onAfterRender? onBeforeRender onCollisionEnter? onCollisionExit? onCollisionStay? onDestroy onDisable onEnable onHandleEvents onTriggerEnter? onTriggerExit? onTriggerStay? onValidate? register removeEventListener resolveGuids? setWorldPosition setWorldQuaternion setWorldRotation start startCoroutine stopCoroutine unregister update? createIfNoneExists ensureUpdateMeshUI get markUIDirty

Constructors

constructor

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

hasActiveUI

  • get hasActiveUI(): boolean

  • Returns boolean

hideFlags

  • get hideFlags(): HideFlags

  • Returns HideFlags

isComponent

  • get isComponent(): boolean

  • Returns boolean

isHoveringObjects

  • get isHoveringObjects(): 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

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

worldEuler

  • get worldEuler(): Euler

  • Returns Euler

  • set worldEuler(val): void

  • Parameters

    Returns void

worldPosition

  • get worldPosition(): Vector3

  • Returns Vector3

  • set worldPosition(val): void

  • Parameters

    Returns void

worldQuaternion

  • get worldQuaternion(): Quaternion

  • Returns Quaternion

  • set worldQuaternion(val): void

  • Parameters

    Returns void

worldRotation

  • get worldRotation(): Vector3

  • Returns Vector3

  • set worldRotation(val): void

  • Parameters

    Returns void

Static instance

Static systems

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

destroy

dispatchEvent

Optional earlyUpdate

Optional lateUpdate

Optional onAfterRender

onBeforeRender

Optional onCollisionEnter

Optional onCollisionExit

Optional onCollisionStay

onDestroy

onDisable

onEnable

  • onEnable(): void

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

    Returns void

onHandleEvents

  • onHandleEvents(): void

  • Returns void

Optional onTriggerEnter

Optional onTriggerExit

Optional onTriggerStay

Optional onValidate

  • onValidate(prop?): void

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

    Parameters

    • Optional prop: string

    Returns void

register

  • register(rc): void

  • Parameters

    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

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

start

startCoroutine

stopCoroutine

  • stopCoroutine(routine, evt?): void

  • Parameters

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

    Returns void

unregister

  • unregister(rc): void

  • Parameters

    Returns void

Optional update

Static createIfNoneExists

  • createIfNoneExists(context): void

  • Parameters

    Returns void

Static ensureUpdateMeshUI

  • ensureUpdateMeshUI(instance, context): void

  • Parameters

    Returns void

Static get

Static markUIDirty

  • markUIDirty(_context): void

  • Parameters

    Returns void

Settings

Member Visibility

Theme

On This Page

constructoractiveAndEnabledcontextdestroyedenabledforwardhasActiveUIhideFlagsisComponentisHoveringObjectslayernamerightscenestatictagupworldEulerworldPositionworldQuaternionworldRotationinstancesystemsaddEventListenerawakedestroydispatchEventearlyUpdatelateUpdateonAfterRenderonBeforeRenderonCollisionEnteronCollisionExitonCollisionStayonDestroyonDisableonEnableonHandleEventsonTriggerEnteronTriggerExitonTriggerStayonValidateregisterremoveEventListenerresolveGuidssetWorldPositionsetWorldQuaternionsetWorldRotationstartstartCoroutinestopCoroutineunregisterupdatecreateIfNoneExistsensureUpdateMeshUIgetmarkUIDirty

Generated using TypeDoc