Class Animation

Hierarchy (view full)

Accessors

actions activeAndEnabled animations clip clips context currentAction currentActions destroyed enabled forward hideFlags isComponent isPlaying layer name right scene static tag up worldEuler worldPosition worldQuaternion worldRotation

Methods

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

Accessors

actions

  • get actions(): AnimationAction[]

  • Returns AnimationAction[]

  • set actions(val): void

  • Parameters

    • val: AnimationAction[]

    Returns void

activeAndEnabled

  • get activeAndEnabled(): boolean

  • Returns boolean

animations

  • get animations(): AnimationClip[]

  • Returns AnimationClip[]

  • set animations(animations): void

  • Parameters

    • animations: AnimationClip[]

    Returns void

clip

  • get clip(): any

  • Returns any

  • set clip(val): void

  • Parameters

    • val: any

    Returns void

clips

  • set clips(animations): void

  • Parameters

    • animations: AnimationClip[]

    Returns void

context

  • get context(): Context

  • Returns Context

  • set context(context): void

  • Parameters

    Returns void

currentAction

  • get currentAction(): any

  • Returns any

    Deprecated

    Currently unsupported

currentActions

  • get currentActions(): AnimationAction[]

  • Returns AnimationAction[]

    Deprecated

    Currently unsupported

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

isPlaying

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

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

getAction

  • getAction(name): any

  • Parameters

    • name: string

    Returns any

init

  • init(): void

  • Returns void

internalOnPlay

  • internalOnPlay(action, options?): Promise<AnimationAction>

  • Parameters

    • action: AnimationAction
    • Optional options: PlayOptions

    Returns Promise<AnimationAction>

Optional lateUpdate

Optional onAfterRender

Optional 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

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

Optional onTriggerExit

Optional onTriggerStay

Optional onValidate

  • onValidate(prop?): void

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

    Parameters

    • Optional prop: string

    Returns void

play

  • play(clipOrNumber?, options?): void | Promise<AnimationAction>

  • Parameters

    • clipOrNumber: any = 0
    • Optional options: PlayOptions

    Returns void | Promise<AnimationAction>

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

update

Settings

Member Visibility

Theme

On This Page

actionsactiveAndEnabledanimationsclipclipscontextcurrentActioncurrentActionsdestroyedenabledforwardhideFlagsisComponentisPlayinglayernamerightscenestatictagupworldEulerworldPositionworldQuaternionworldRotationaddEventListenerawakedestroydispatchEventearlyUpdategetActioninitinternalOnPlaylateUpdateonAfterRenderonBeforeRenderonCollisionEnteronCollisionExitonCollisionStayonDestroyonDisableonEnableonPausedChangedonTriggerEnteronTriggerExitonTriggerStayonValidateplayremoveEventListenerresolveGuidssetWorldPositionsetWorldQuaternionsetWorldRotationstartstartCoroutinestopCoroutineupdate

Generated using TypeDoc