Screen | @mixer/interactive-node

Screen can be used to get mouse input

Hierarchy

Control<IScreenData>
- Screen

Implements

Index

Constructors

constructor

Properties

Constructors

constructor

new Screen(control: IScreenData): Screen

Inherited from Control.constructor
- Defined in state/controls/Control.ts:44
Parameters
- control: IScreenData
Returns Screen

Properties

client

client: IClient

controlID

controlID: string

disabled

disabled: boolean

etag

etag: string

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

kind

kind: string

moveThrottle

moveThrottle: number

The throttle rate for input sent

position

position: IGridPlacement[]

Protected scene

scene: Scene

sendMouseDownEvent

sendMouseDownEvent: boolean

Whether the control sends the mouse down event.

sendMouseUpEvent

sendMouseUpEvent: boolean

Whether the control sends the mouse up event.

sendMoveEvents

sendMoveEvents: MoveEventType

How the control will handle move events

Static defaultMaxListeners

defaultMaxListeners: number

Methods

addListener

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

Implementation of IScreen.addListener

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

destroy

destroy(): void

Implementation of IScreen.destroy

Inherited from Control.destroy
- Defined in state/controls/Control.ts:116
Returns void

disable

disable(): Promise<void>

Implementation of IScreen.disable

Inherited from Control.disable
- Defined in state/controls/Control.ts:71
Disables this control, preventing participant interaction.

Returns Promise<void>

emit

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

Implementation of IScreen.emit

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

enable

enable(): Promise<void>

Implementation of IScreen.enable

Inherited from Control.enable
- Defined in state/controls/Control.ts:77
Enables this control, allowing participant interaction.

Returns Promise<void>

eventNames

eventNames(): (string | symbol)[]

Implementation of IScreen.eventNames

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)[]

getMaxListeners

getMaxListeners(): number

Implementation of IScreen.getMaxListeners

Inherited from EventEmitter.getMaxListeners

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

giveInput

giveInput(input: IScreenInput): Promise<void>

Implementation of IScreen.giveInput

Overrides Control.giveInput
- Defined in state/controls/Screen.ts:29
Sends an input event from a participant to the server for consumption.

Parameters
- input: IScreenInput
Returns Promise<void>

listenerCount

listenerCount(type: string | symbol): number

Implementation of IScreen.listenerCount

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

Implementation of IScreen.listeners

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: string | symbol, listener: Function): this

Inherited from EventEmitter.on

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

onUpdate

onUpdate(controlData: IControlData): void

Implementation of IScreen.onUpdate

Inherited from Control.onUpdate
- Defined in state/controls/Control.ts:96
Merges in values from the server in response to an update operation from the server.

Parameters
- controlData: IControlData
Returns void

once

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

Implementation of IScreen.once

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

Implementation of IScreen.prependListener

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

Implementation of IScreen.prependOnceListener

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

receiveInput

receiveInput<T>(inputEvent: IInputEvent<T>, participant: IParticipant): void

Implementation of IScreen.receiveInput

Inherited from Control.receiveInput
- Defined in state/controls/Control.ts:57
Called by client when it receives an input event for this control from the server.

Type parameters
- T: IInput
Parameters
- inputEvent: IInputEvent<T>
- participant: IParticipant
Returns void

removeAllListeners

removeAllListeners(event?: string | symbol): this

Implementation of IScreen.removeAllListeners

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

Implementation of IScreen.removeListener

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

Protected sendInput

sendInput<K>(input: K): Promise<void>

Inherited from Control.sendInput
- Defined in state/controls/Control.ts:61
Type parameters
- K: IInput
Parameters
- input: K
Returns Promise<void>

setClient

setClient(client: IClient): void

Inherited from Control.setClient
- Defined in state/controls/Control.ts:42
Sets the client instance this control can use to execute methods.

Parameters
- client: IClient
Returns void

setMaxListeners

setMaxListeners(n: number): this

Implementation of IScreen.setMaxListeners

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

setScene

setScene(scene: Scene): void

Inherited from Control.setScene
- Defined in state/controls/Control.ts:36
Sets the scene this control belongs to.

Parameters
- scene: Scene
Returns void

update

update<T2>(controlUpdate: T2): Promise<void>

Inherited from Control.update
- Defined in state/controls/Control.ts:104
Update this control on the server.

Type parameters
- T2: IControlUpdate
Parameters
- controlUpdate: T2
Returns Promise<void>

Protected updateAttribute

updateAttribute<K>(attribute: K, value: T[K]): Promise<void>

Inherited from Control.updateAttribute
- Defined in state/controls/Control.ts:81
Type parameters
- K: keyof IScreenData
Parameters
- attribute: K
- value: T[K]
Returns Promise<void>

Static listenerCount

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

Implementation of IScreen.listenerCount

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

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

control: IScreenData

Returns Screen

Properties

client

controlID

disabled

etag

kind

meta

moveThrottle

position

Protected scene

sendMouseDownEvent

sendMouseUpEvent

sendMoveEvents

Static defaultMaxListeners

Methods

addListener

Parameters

event: string | symbol

listener: Function

Returns this

destroy

Returns void

disable

Returns Promise<void>

emit

Parameters

event: string | symbol

Rest ...args: any[]

Returns boolean

enable

Returns Promise<void>

eventNames

Returns (string | symbol)[]

getMaxListeners

Returns number

giveInput

Parameters

input: IScreenInput

Returns Promise<void>

listenerCount

Parameters

type: string | symbol

Returns number

listeners

Parameters

event: string | symbol

Returns Function[]

on

Parameters

event: string | symbol

listener: Function

Returns this

onUpdate

Parameters

controlData: IControlData

Returns void

once

Parameters

event: string | symbol

listener: Function

Returns this

prependListener

Parameters

event: string | symbol

listener: Function

Returns this

prependOnceListener

Parameters

event: string | symbol