Class Animator

Hierarchy (view full)

Accessors

activeAndEnabled context destroyed enabled forward hideFlags isComponent isDirty layer minMaxOffsetNormalized minMaxSpeed name parametersAreDirty right runtimeAnimatorController scene static tag up worldEuler worldPosition worldQuaternion worldRotation

Methods

GetBool GetFloat GetInteger GetTrigger IsInTransition Play Reset ResetTrigger SetBool SetFloat SetInteger SetSpeed SetTrigger addEventListener awake destroy dispatchEvent earlyUpdate? getBool getFloat getInteger getTrigger initializeRuntimeAnimatorController isInTransition lateUpdate? onAfterRender? onBeforeRender onCollisionEnter? onCollisionExit? onCollisionStay? onDestroy onDisable onEnable onPausedChanged? onTriggerEnter? onTriggerExit? onTriggerStay? onValidate? play removeEventListener reset resetTrigger resolveGuids? setBool setFloat setInteger setSpeed setTrigger setWorldPosition setWorldQuaternion setWorldRotation start? startCoroutine stopCoroutine toggleBool 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

isDirty

  • get isDirty(): boolean

  • Returns boolean

layer

  • get layer(): number

  • Returns number

minMaxOffsetNormalized

  • set minMaxOffsetNormalized(minMax): void

  • Parameters

    • minMax: {
          x: number;
          y: number;
      }
      • x: number
      • y: number

    Returns void

minMaxSpeed

  • set minMaxSpeed(minMax): void

  • Parameters

    • minMax: {
          x: number;
          y: number;
      }
      • x: number
      • y: number

    Returns void

name

  • get name(): string

  • Returns string

  • set name(str): void

  • Parameters

    • str: string

    Returns void

parametersAreDirty

  • get parametersAreDirty(): boolean

  • Returns boolean

right

  • get right(): Vector3

  • Right (1,0,0) vector in world space

    Returns Vector3

runtimeAnimatorController

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

GetBool

  • GetBool(name): boolean

  • Parameters

    • name: string | number

    Returns boolean

    Deprecated

    use getBool

GetFloat

  • GetFloat(name): number

  • Parameters

    • name: string | number

    Returns number

    Deprecated

    use getFloat

GetInteger

  • GetInteger(name): number

  • Parameters

    • name: string | number

    Returns number

    Deprecated

    use getInteger

GetTrigger

  • GetTrigger(name): void

  • Parameters

    • name: string | number

    Returns void

    Deprecated

    use getTrigger

IsInTransition

  • IsInTransition(): boolean

  • Returns boolean

    Deprecated

    use isInTransition

Play

  • Play(name, layer?, normalizedTime?, transitionDurationInSec?): void

  • Parameters

    • name: string | number
    • layer: number = -1
    • normalizedTime: number = Number.NEGATIVE_INFINITY
    • transitionDurationInSec: number = 0

    Returns void

    Deprecated

    use play

Reset

  • Reset(): void

  • Returns void

    Deprecated

    use reset

ResetTrigger

  • ResetTrigger(name): void

  • Parameters

    • name: string | number

    Returns void

    Deprecated

    use resetTrigger

SetBool

  • SetBool(name, val): void

  • Parameters

    • name: string | number
    • val: boolean

    Returns void

    Deprecated

    use setBool

SetFloat

  • SetFloat(name, val): void

  • Parameters

    • name: string | number
    • val: number

    Returns void

    Deprecated

    use setFloat

SetInteger

  • SetInteger(name, val): void

  • Parameters

    • name: string | number
    • val: number

    Returns void

    Deprecated

    use setInteger

SetSpeed

  • SetSpeed(speed): void

  • Parameters

    • speed: number

    Returns void

    Deprecated

    use setSpeed

SetTrigger

  • SetTrigger(name): void

  • Parameters

    • name: string | number

    Returns void

    Deprecated

    use setTrigger

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

getBool

  • getBool(name): boolean

  • Parameters

    • name: string | number

    Returns boolean

getFloat

  • getFloat(name): number

  • Parameters

    • name: string | number

    Returns number

getInteger

  • getInteger(name): number

  • Parameters

    • name: string | number

    Returns number

getTrigger

  • getTrigger(name): boolean

  • Parameters

    • name: string | number

    Returns boolean

initializeRuntimeAnimatorController

  • initializeRuntimeAnimatorController(force?): void

  • Parameters

    • force: boolean = false

    Returns void

isInTransition

  • isInTransition(): boolean

  • Returns boolean

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

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(name, layer?, normalizedTime?, transitionDurationInSec?): void

  • Parameters

    • name: string | number
    • layer: number = -1
    • normalizedTime: number = Number.NEGATIVE_INFINITY
    • transitionDurationInSec: number = 0

    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

reset

  • reset(): void

  • Returns void

resetTrigger

  • resetTrigger(name): void

  • Parameters

    • name: string | number

    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

setBool

  • setBool(name, value): void

  • Parameters

    • name: string | number
    • value: boolean

    Returns void

setFloat

  • setFloat(name, val): void

  • Parameters

    • name: string | number
    • val: number

    Returns void

setInteger

  • setInteger(name, val): void

  • Parameters

    • name: string | number
    • val: number

    Returns void

setSpeed

  • setSpeed(speed): void

  • Parameters

    • speed: number

    Returns void

setTrigger

  • setTrigger(name): void

  • Parameters

    • name: string | number

    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

Optional start

startCoroutine

stopCoroutine

  • stopCoroutine(routine, evt?): void

  • Parameters

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

    Returns void

toggleBool

  • toggleBool(name): void

  • Parameters

    • name: string | number

    Returns void

Optional update

Settings

Member Visibility

Theme

On This Page

activeAndEnabledcontextdestroyedenabledforwardhideFlagsisComponentisDirtylayerminMaxOffsetNormalizedminMaxSpeednameparametersAreDirtyrightruntimeAnimatorControllerscenestatictagupworldEulerworldPositionworldQuaternionworldRotationGetBoolGetFloatGetIntegerGetTriggerIsInTransitionPlayResetResetTriggerSetBoolSetFloatSetIntegerSetSpeedSetTriggeraddEventListenerawakedestroydispatchEventearlyUpdategetBoolgetFloatgetIntegergetTriggerinitializeRuntimeAnimatorControllerisInTransitionlateUpdateonAfterRenderonBeforeRenderonCollisionEnteronCollisionExitonCollisionStayonDestroyonDisableonEnableonPausedChangedonTriggerEnteronTriggerExitonTriggerStayonValidateplayremoveEventListenerresetresetTriggerresolveGuidssetBoolsetFloatsetIntegersetSpeedsetTriggersetWorldPositionsetWorldQuaternionsetWorldRotationstartstartCoroutinestopCoroutinetoggleBoolupdate

Generated using TypeDoc