Class MaskableGraphic

Static textureCache

activeAndEnabled

• get activeAndEnabled(): boolean

• Returns boolean

alphaFactor

• get alphaFactor(): number

• Returns number

canvas

• get canvas(): ICanvas

• Returns ICanvas

color

• get color(): RGBAColor

• Returns RGBAColor

• set color(col): void

• Parameters

  • col: RGBAColor

  Returns void

context

• get context(): Context

• Returns Context

• set context(context): void

• Parameters

  • context: Context

  Returns void

controlsChildLayout

• get controlsChildLayout(): boolean

• Returns boolean

• set controlsChildLayout(val): void

• Parameters

  • val: boolean

  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

isGraphic

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

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

__internalNewInstanceCreated

• __internalNewInstanceCreated(): void

• Returns void

addEventListener

• addEventListener<T>(type, listener): void

• Type Parameters

  • T extends Event

  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

• destroy(): void

• Returns void

dispatchEvent

• dispatchEvent(evt): boolean

• Parameters

  • evt: Event

  Returns boolean

Optional earlyUpdate

• earlyUpdate(): void

• Returns void

isRoot

• isRoot(): boolean

• Returns boolean

Optional lateUpdate

• lateUpdate(): void

• Returns void

markDirty

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

  • col: Collision

  Returns any

Optional onCollisionExit

• onCollisionExit(col): any

• Parameters

  • col: Collision

  Returns any

Optional onCollisionStay

• onCollisionStay(col): any

• Parameters

  • col: Collision

  Returns any

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

onParentRectTransformChanged

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

  • T extends Event

  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

set

• set(_state): void

• Parameters

  • _state: object

  Returns void

setAlphaFactor

• setAlphaFactor(factor): void

• Parameters

  • factor: number

  Returns void

setInteractable

• setInteractable(value): void

• Parameters

  • value: boolean

  Returns void

setOptions

• setOptions(opts): void

• Parameters

  • opts: object

  Returns void

setState

• setState(state): void

• Parameters

  • state: string

  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

setupState

• setupState(state): void

• Parameters

  • state: object

  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