IState | @mixer/interactive-node

Hierarchy

EventEmitter
- IState

Implemented by

State

Index

Properties

defaultMaxListeners

Properties

Static defaultMaxListeners

defaultMaxListeners: number

Methods

addListener

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

Inherited from EventEmitter.addListener

Overrides EventEmitter.addListener
- Defined in D:/dev/clients/interactive-node/node_modules/@types/node/index.d.ts:717
Parameters
- event: string | symbol
- listener: Function
Returns this

emit

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

Inherited from EventEmitter.emit

Overrides EventEmitter.emit
- Defined in D:/dev/clients/interactive-node/node_modules/@types/node/index.d.ts:727
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

eventNames

eventNames(): (string | symbol)[]

Inherited from EventEmitter.eventNames

Overrides EventEmitter.eventNames
- Defined in D:/dev/clients/interactive-node/node_modules/@types/node/index.d.ts:728
Returns (string | symbol)[]

getControl

getControl(id: string): IControl

- Defined in state/IState.ts:30
Parameters
- id: string
Returns IControl

getGroup

getGroup(id: string): IGroup

- Defined in state/IState.ts:21
Parameters
- id: string
Returns IGroup

getGroups

getGroups(): Map<string, IGroup>

- Defined in state/IState.ts:20
Returns Map<string, IGroup>

getMaxListeners

getMaxListeners(): number

Inherited from EventEmitter.getMaxListeners

Overrides EventEmitter.getMaxListeners
- Defined in D:/dev/clients/interactive-node/node_modules/@types/node/index.d.ts:725
Returns number

getParticipantBySessionID

getParticipantBySessionID(id: string): IParticipant

- Defined in state/IState.ts:35
Parameters
- id: string
Returns IParticipant

getParticipantByUserID

getParticipantByUserID(id: number): IParticipant

- Defined in state/IState.ts:33
Parameters
- id: number
Returns IParticipant

getParticipantByUsername

getParticipantByUsername(name: string): IParticipant

- Defined in state/IState.ts:34
Parameters
- name: string
Returns IParticipant

getParticipants

getParticipants(): Map<string, IParticipant>

- Defined in state/IState.ts:32
Returns Map<string, IParticipant>

getScene

getScene(id: string): IScene

- Defined in state/IState.ts:23
Parameters
- id: string
Returns IScene

getScenes

getScenes(): Map<string, IScene>

- Defined in state/IState.ts:22
Returns Map<string, IScene>

listenerCount

listenerCount(type: string | symbol): number

Inherited from EventEmitter.listenerCount

Overrides EventEmitter.listenerCount
- Defined in D:/dev/clients/interactive-node/node_modules/@types/node/index.d.ts:729
Parameters
- type: string | symbol
Returns number

listeners

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

Inherited from EventEmitter.listeners

Overrides EventEmitter.listeners
- Defined in D:/dev/clients/interactive-node/node_modules/@types/node/index.d.ts:726
Parameters
- event: string | symbol
Returns Function[]

on

on(event: "ready", listener: function): this
on(event: "selfUpdate", listener: function): this
on(event: "participantJoin", listener: function): this
on(event: "participantLeave", listener: function): this
on(event: "sceneDeleted", listener: function): this
on(event: "sceneCreated", listener: function): this
on(event: "groupDeleted", listener: function): this
on(event: "groupCreated", listener: function): this
on(event: "worldUpdated", listener: function): this
on(event: string, listener: Function): this

Overrides EventEmitter.on
- Defined in state/IState.ts:40
Fired when the ready state of the interactive session changes.

Parameters
- event: "ready"
- listener: function
  - - (ready: boolean): void
    - Parameters
      - ready: boolean
      Returns void
Returns this
Overrides EventEmitter.on
- Defined in state/IState.ts:45
Fired when the connected participant's state is updated

Parameters
- event: "selfUpdate"
- listener: function
  - - (self: IParticipant): void
    - Parameters
      - self: IParticipant
      Returns void
Returns this
Overrides EventEmitter.on
- Defined in state/IState.ts:49
Fired when a participant joins.

Parameters
- event: "participantJoin"
- listener: function
  - - (participant: IParticipant): void
    - Parameters
      - participant: IParticipant
      Returns void
Returns this
Overrides EventEmitter.on
- Defined in state/IState.ts:53
Fired when a participant leaves.

Parameters
- event: "participantLeave"
- listener: function
  - - (participantSessionID: string, participant: IParticipant): void
    - Parameters
      - participantSessionID: string
      - participant: IParticipant
      Returns void
Returns this
Overrides EventEmitter.on
- Defined in state/IState.ts:61
Fired when a scene is deleted.

Parameters
- event: "sceneDeleted"
- listener: function
  - - (sceneID: string, reassignSceneID: string): void
    - Parameters
      - sceneID: string
      - reassignSceneID: string
      Returns void
Returns this
Overrides EventEmitter.on
- Defined in state/IState.ts:65
Fired when a scene is created.

Parameters
- event: "sceneCreated"
- listener: function
  - - (scene: IScene): void
    - Parameters
      - scene: IScene
      Returns void
Returns this
Overrides EventEmitter.on
- Defined in state/IState.ts:70
Fired when a group is deleted.

Parameters
- event: "groupDeleted"
- listener: function
  - - (groupID: string, reassignGroupID: string): void
    - Parameters
      - groupID: string
      - reassignGroupID: string
      Returns void
Returns this
Overrides EventEmitter.on
- Defined in state/IState.ts:74
Fired when a group is created.

Parameters
- event: "groupCreated"
- listener: function
  - - (group: Group): void
    - Parameters
      - group: Group
      Returns void
Returns this
Overrides EventEmitter.on
- Defined in state/IState.ts:78
Fired when the world is updated.

Parameters
- event: "worldUpdated"
- listener: function
  - - (world: IRawValues): void
    - Parameters
      - world: IRawValues
      Returns void
Returns this
Overrides EventEmitter.on
- Defined in state/IState.ts:79
Parameters
- event: string
- listener: Function
Returns this

onSceneCreate

onSceneCreate(data: ISceneData): IScene

- Defined in state/IState.ts:24
Parameters
- data: ISceneData
Returns IScene

onWorldUpdate

onWorldUpdate(data: IRawValues): void

- Defined in state/IState.ts:28
Parameters
- data: IRawValues
Returns void

once

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

Inherited from EventEmitter.once

Overrides EventEmitter.once
- Defined in D:/dev/clients/interactive-node/node_modules/@types/node/index.d.ts:719
Parameters
- event: string | symbol
- listener: Function
Returns this

prependListener

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

Inherited from EventEmitter.prependListener

Overrides EventEmitter.prependListener
- Defined in D:/dev/clients/interactive-node/node_modules/@types/node/index.d.ts:720
Parameters
- event: string | symbol
- listener: Function
Returns this

prependOnceListener

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

Inherited from EventEmitter.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in D:/dev/clients/interactive-node/node_modules/@types/node/index.d.ts:721
Parameters
- event: string | symbol
- listener: Function
Returns this

processMethod

processMethod(method: Method<any>): void | Reply

- Defined in state/IState.ts:14
Parameters
- method: Method<any>
Returns void | Reply

removeAllListeners

removeAllListeners(event?: string | symbol): this

Inherited from EventEmitter.removeAllListeners

Overrides EventEmitter.removeAllListeners
- Defined in D:/dev/clients/interactive-node/node_modules/@types/node/index.d.ts:723
Parameters
- Optional event: string | symbol
Returns this

removeListener

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

Inherited from EventEmitter.removeListener

Overrides EventEmitter.removeListener
- Defined in D:/dev/clients/interactive-node/node_modules/@types/node/index.d.ts:722
Parameters
- event: string | symbol
- listener: Function
Returns this

reset

reset(): void

- Defined in state/IState.ts:18
Returns void

setClient

setClient(client: IClient): void

- Defined in state/IState.ts:13
Parameters
- client: IClient
Returns void

setMaxListeners

setMaxListeners(n: number): this

Inherited from EventEmitter.setMaxListeners

Overrides EventEmitter.setMaxListeners
- Defined in D:/dev/clients/interactive-node/node_modules/@types/node/index.d.ts:724
Parameters
- n: number
Returns this

synchronizeGroups

synchronizeGroups(data: IGroupDataArray): IGroup[]

- Defined in state/IState.ts:26
Parameters
- data: IGroupDataArray
Returns IGroup[]

synchronizeLocalTime

synchronizeLocalTime(time?: Date | number): Date

- Defined in state/IState.ts:15
Parameters
- Optional time: Date | number
Returns Date

synchronizeRemoteTime

synchronizeRemoteTime(time?: Date | number): Date

- Defined in state/IState.ts:16
Parameters
- Optional time: Date | number
Returns Date

synchronizeScenes

synchronizeScenes(data: ISceneDataArray): IScene[]

- Defined in state/IState.ts:25
Parameters
- data: ISceneDataArray
Returns IScene[]

Static listenerCount

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

Inherited from EventEmitter.listenerCount
- Defined in D:/dev/clients/interactive-node/node_modules/@types/node/index.d.ts:714
Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number

Hierarchy

Implemented by

Index

Properties

Methods

Properties

Static defaultMaxListeners

Methods

addListener

Parameters

event: string | symbol

listener: Function

Returns this

emit

Parameters

event: string | symbol

Rest ...args: any[]

Returns boolean

eventNames

Returns (string | symbol)[]

getControl

Parameters

id: string

Returns IControl

getGroup

Parameters

id: string

Returns IGroup

getGroups

Returns Map<string, IGroup>

getMaxListeners

Returns number

getParticipantBySessionID

Parameters

id: string

Returns IParticipant

getParticipantByUserID

Parameters

id: number

Returns IParticipant

getParticipantByUsername

Parameters

name: string

Returns IParticipant

getParticipants

Returns Map<string, IParticipant>

getScene

Parameters

id: string

Returns IScene

getScenes

Returns Map<string, IScene>

listenerCount

Parameters

type: string | symbol

Returns number

listeners

Parameters

event: string | symbol

Returns Function[]

on

Parameters

event: "ready"

listener: function

Parameters

ready: boolean

Returns void

Returns this

Parameters

event: "selfUpdate"

listener: function

Parameters

self: IParticipant

Returns void

Returns this

Parameters

event: "participantJoin"

listener: function

Parameters

participant: IParticipant