Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Scene

A Scene is a collection of controls within an interactive experience. Groups can be set to a scene. Which Scene a group is set to determine which controls they see.

You can use scenes to logically group together controls for some meaning.

Hierarchy

  • EventEmitter
    • Scene

Implements

Index

Constructors

constructor

Properties

controls

controls: Map<string, IControl> = new Map<string, IControl>()

etag

etag: string
deprecated

etags are no longer used, you can always omit/ignore this

groups

groups: any

meta

meta: IMeta

sceneID

sceneID: string

Static defaultMaxListeners

defaultMaxListeners: number

Methods

addListener

  • addListener(event: string | symbol, listener: Function): this
  • Parameters

    • event: string | symbol
    • listener: Function

    Returns this

createControl

createControls

deleteAllControls

  • deleteAllControls(): Promise<void>

deleteControl

  • deleteControl(controlId: string): Promise<void>

deleteControls

  • deleteControls(controlIDs: string[]): Promise<void>

destroy

  • destroy(): void

emit

  • emit(event: string | symbol, ...args: any[]): boolean
  • Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

eventNames

  • eventNames(): (string | symbol)[]
  • Returns (string | symbol)[]

getControl

getControls

getMaxListeners

  • getMaxListeners(): number
  • Returns number

listenerCount

  • listenerCount(type: string | symbol): number
  • Parameters

    • type: string | symbol

    Returns number

listeners

  • listeners(event: string | symbol): Function[]
  • Parameters

    • event: string | symbol

    Returns Function[]

on

  • on(event: string | symbol, listener: Function): this
  • Parameters

    • event: string | symbol
    • listener: Function

    Returns this

onControlsCreated

onControlsDeleted

onControlsUpdated

once

  • once(event: string | symbol, listener: Function): this
  • Parameters

    • event: string | symbol
    • listener: Function

    Returns this

prependListener

  • prependListener(event: string | symbol, listener: Function): this
  • Parameters

    • event: string | symbol
    • listener: Function

    Returns this

prependOnceListener

  • prependOnceListener(event: string | symbol, listener: Function): this
  • Parameters

    • event: string | symbol
    • listener: Function

    Returns this

removeAllListeners

  • removeAllListeners(event?: string | symbol): this
  • Parameters

    • Optional event: string | symbol

    Returns this

removeListener

  • removeListener(event: string | symbol, listener: Function): this
  • Parameters

    • event: string | symbol
    • listener: Function

    Returns this

setClient

setMaxListeners

  • setMaxListeners(n: number): this
  • Parameters

    • n: number

    Returns this

update

updateControls

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string | symbol): number
  • Parameters

    • emitter: EventEmitter
    • event: string | symbol

    Returns number

Generated using TypeDoc