Class PlayableDirector

Hierarchy (view full)

Properties

animationCallbackReceivers waitForAudio

Accessors

activeAndEnabled audioTracks context destroyed duration enabled forward hideFlags isComponent isPaused isPlaying layer name right scene speed static tag time up weight worldEuler worldPosition worldQuaternion worldRotation

Methods

addEventListener awake destroy dispatchEvent earlyUpdate? evaluate forEachTrack isValid lateUpdate? onAfterRender? onBeforeRender? onCollisionEnter? onCollisionExit? onCollisionStay? onDestroy onDisable onEnable onPausedChanged? onTriggerEnter? onTriggerExit? onTriggerStay? onValidate? pause play rebuildGraph registerAnimationCallback removeEventListener resolveGuids setWorldPosition setWorldQuaternion setWorldRotation start? startCoroutine stop stopCoroutine unregisterAnimationCallback update? registerCreateTrack

Properties

Readonly animationCallbackReceivers

animationCallbackReceivers: ITimelineAnimationOverride[] = []

Experimental support for overriding timeline animation data (position or rotation)

waitForAudio

waitForAudio: boolean = true

When enabled the timeline will wait for audio tracks to load at the current time before starting to play

Accessors

activeAndEnabled

  • get activeAndEnabled(): boolean

  • Returns boolean

audioTracks

context

  • get context(): Context

  • Returns Context

  • set context(context): void

  • Parameters

    Returns void

destroyed

  • get destroyed(): boolean

  • Returns boolean

duration

  • get duration(): number

  • Returns number

  • set duration(value): void

  • Parameters

    • value: number

    Returns void

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

isPaused

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

speed

  • get speed(): number

  • Returns number

  • set speed(value): void

  • Parameters

    • value: number

    Returns void

static

  • get static(): any

  • Returns any

tag

  • get tag(): string

  • Returns string

  • set tag(str): void

  • Parameters

    • str: string

    Returns void

time

  • get time(): number

  • Returns number

  • set time(value): void

  • Parameters

    • value: number

    Returns void

up

  • get up(): Vector3

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

    Returns Vector3

weight

  • get weight(): number

  • Returns number

  • set weight(value): void

  • Parameters

    • value: number

    Returns void

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

evaluate

  • evaluate(): void

  • Returns void

forEachTrack

isValid

  • isValid(): boolean

  • Returns boolean

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

pause

  • pause(): void

  • Returns void

play

rebuildGraph

  • rebuildGraph(): void

  • Returns void

registerAnimationCallback

  • registerAnimationCallback(receiver): void

  • Experimental: Receive callbacks for timeline animation. Allows modification of final value

    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

resolveGuids

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

    • map: 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

Optional start

startCoroutine

stop

  • stop(): void

  • Returns void

stopCoroutine

  • stopCoroutine(routine, evt?): void

  • Parameters

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

    Returns void

unregisterAnimationCallback

  • unregisterAnimationCallback(receiver): void

  • Experimental: Unregister callbacks for timeline animation. Allows modification of final value

    Parameters

    Returns void

Optional update

Static registerCreateTrack

  • registerCreateTrack(type, fn): void

  • Parameters

    • type: string
    • fn: CreateTrackFunction

    Returns void

Settings

Member Visibility

Theme

On This Page

animationCallbackReceiverswaitForAudioactiveAndEnabledaudioTrackscontextdestroyeddurationenabledforwardhideFlagsisComponentisPausedisPlayinglayernamerightscenespeedstatictagtimeupweightworldEulerworldPositionworldQuaternionworldRotationaddEventListenerawakedestroydispatchEventearlyUpdateevaluateforEachTrackisValidlateUpdateonAfterRenderonBeforeRenderonCollisionEnteronCollisionExitonCollisionStayonDestroyonDisableonEnableonPausedChangedonTriggerEnteronTriggerExitonTriggerStayonValidatepauseplayrebuildGraphregisterAnimationCallbackremoveEventListenerresolveGuidssetWorldPositionsetWorldQuaternionsetWorldRotationstartstartCoroutinestopstopCoroutineunregisterAnimationCallbackupdateregisterCreateTrack

Generated using TypeDoc