Class SpectatorCamera

Hierarchy (view full)

Properties

useKeys

Accessors

activeAndEnabled context destroyed enabled followers forward hideFlags isComponent isSpectating layer mode name right scene static tag target up worldEuler worldPosition worldQuaternion worldRotation

Methods

addEventListener awake destroy dispatchEvent earlyUpdate? isFollowedBy isSpectatingUser lateUpdate? onAfterRender onBeforeRender? onCollisionEnter? onCollisionExit? onCollisionStay? onDestroy onDisable onEnable onTriggerEnter? onTriggerExit? onTriggerStay? onValidate? removeEventListener requestAllFollowMe resolveGuids? setWorldPosition setWorldQuaternion setWorldRotation start? startCoroutine stopCoroutine stopSpectating update?

Properties

useKeys

useKeys: boolean = true

when enabled pressing F will send a request to all connected users to follow me, ESC to stop

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

followers

  • get followers(): string[]

  • list of other users that are following me

    Returns string[]

forward

  • get forward(): Vector3

  • Returns Vector3

hideFlags

  • get hideFlags(): HideFlags

  • Returns HideFlags

isComponent

  • get isComponent(): boolean

  • Returns boolean

isSpectating

  • get isSpectating(): boolean

  • if this user is currently spectating someone else

    Returns boolean

layer

  • get layer(): number

  • Returns number

mode

  • get mode(): SpectatorMode

  • Returns SpectatorMode

  • set mode(val): void

  • Parameters

    • val: SpectatorMode

    Returns void

name

  • get name(): string

  • Returns string

  • set name(str): void

  • Parameters

    • str: string

    Returns void

right

  • get right(): Vector3

  • 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

target

up

  • get up(): Vector3

  • 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

isFollowedBy

  • isFollowedBy(userId): boolean

  • Parameters

    • userId: string

    Returns boolean

isSpectatingUser

  • isSpectatingUser(userId): boolean

  • Parameters

    • userId: string

    Returns boolean

Optional lateUpdate

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 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

removeEventListener

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

  • Type Parameters

    Parameters

    • type: string
    • listener: ((arg) => any)
        • (arg): any

        • Parameters

          • arg: T

          Returns any

    Returns void

requestAllFollowMe

  • requestAllFollowMe(): void

  • 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

Optional start

startCoroutine

stopCoroutine

  • stopCoroutine(routine, evt?): void

  • Parameters

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

    Returns void

stopSpectating

  • stopSpectating(): void

  • Returns void

Optional update

Settings

Member Visibility

Theme

On This Page

useKeysactiveAndEnabledcontextdestroyedenabledfollowersforwardhideFlagsisComponentisSpectatinglayermodenamerightscenestatictagtargetupworldEulerworldPositionworldQuaternionworldRotationaddEventListenerawakedestroydispatchEventearlyUpdateisFollowedByisSpectatingUserlateUpdateonAfterRenderonBeforeRenderonCollisionEnteronCollisionExitonCollisionStayonDestroyonDisableonEnableonTriggerEnteronTriggerExitonTriggerStayonValidateremoveEventListenerrequestAllFollowMeresolveGuidssetWorldPositionsetWorldQuaternionsetWorldRotationstartstartCoroutinestopCoroutinestopSpectatingupdate

Generated using TypeDoc