Button | @mixer/interactive-node

Buttons can be pushed by participants with their mouse or activated with their keyboards.

Hierarchy

Control<IButtonData>
- Button

Implements

Index

Constructors

constructor

Properties

Constructors

constructor

new Button(control: IButtonData): Button

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

Properties

accentColor

accentColor: string

The color of the cooldown spinner and progress bar on the button. Set this value using setAccentColor

backgroundColor

backgroundColor: string

The color of the background of the button. Set this value using setBackgroundColor

borderColor

borderColor: string

The color of the border on the button. Set this value using setBorderColor

client

client: IClient

controlID

controlID: string

cooldown

cooldown: number

If set this value is the Unix Timestamp at which this button's cooldown will expire. Set this value using setCooldown

cost

cost: number

The spark cost of this button in sparks. Set this value using setCost

disabled

disabled: boolean

etag

etag: string

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

focusColor

focusColor: string

The color around the border of the button when in focus. Set this value using setFocusColor

keyCode

keyCode: number

A keycode which will trigger this button if pressed on a participant's keyboard.

kind

kind: string

position

position: IGridPlacement[]

progress

progress: number

A decimalized percentage (0.0 - 1.0) which controls how wide this button's progress bar is.

Set this value using setProgress

Protected scene

scene: Scene

text

text: string

The text displayed on a button, presented to the participants. Set this value using setText

textColor

textColor: string

The color of the text displayed on the button. Set this value using setTextColor

tooltip

tooltip: string

The tooltip text displayed when the participant hovers over the button. Set this value using setTooltip

Static defaultMaxListeners

defaultMaxListeners: number

Methods

addListener

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

Implementation of IButton.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 IButton.destroy

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

disable

disable(): Promise<void>

Implementation of IButton.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 IButton.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 IButton.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 IButton.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 IButton.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: IButtonInput): Promise<void>

Implementation of IButton.giveInput

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

Parameters
- input: IButtonInput
Returns Promise<void>

listenerCount

listenerCount(type: string | symbol): number

Implementation of IButton.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 IButton.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 IButton.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 IButton.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 IButton.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 IButton.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 IButton.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 IButton.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 IButton.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>

setAccentColor

setAccentColor(accentColor: string): Promise<void>

Implementation of IButton.setAccentColor
- Defined in state/controls/Button.ts:110
Sets a new accent color for this button.

Parameters
- accentColor: string
Returns Promise<void>

setBackgroundColor

setBackgroundColor(backgroundColor: string): Promise<void>

Implementation of IButton.setBackgroundColor
- Defined in state/controls/Button.ts:96
Sets a new background color for this button.

Parameters
- backgroundColor: string
Returns Promise<void>

setBorderColor

setBorderColor(borderColor: string): Promise<void>

Implementation of IButton.setBorderColor
- Defined in state/controls/Button.ts:89
Sets a new border color for this button.

Parameters
- borderColor: string
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

setCooldown

setCooldown(duration: number): Promise<void>

Implementation of IButton.setCooldown
- Defined in state/controls/Button.ts:140
Sets the cooldown for this button. Specified in Milliseconds. The Client will convert this to a Unix timestamp for you.

Parameters
- duration: number
Returns Promise<void>

setCost

setCost(cost: number): Promise<void>

Implementation of IButton.setCost
- Defined in state/controls/Button.ts:149
Sets the spark cost for this button. An Integer greater than 0

Parameters
- cost: number
Returns Promise<void>

setFocusColor

setFocusColor(focusColor: string): Promise<void>

Implementation of IButton.setFocusColor
- Defined in state/controls/Button.ts:103
Sets a new focus color for this button.

Parameters
- focusColor: string
Returns Promise<void>

setMaxListeners

setMaxListeners(n: number): this

Implementation of IButton.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

setProgress

setProgress(progress: number): Promise<void>

Implementation of IButton.setProgress
- Defined in state/controls/Button.ts:132
Sets a progress value for this button. A decimalized percentage (0.0 - 1.0)

Parameters
- progress: number
Returns Promise<void>

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

setText

setText(text: string): Promise<void>

Implementation of IButton.setText
- Defined in state/controls/Button.ts:74
Sets a new text value for this button.

Parameters
- text: string
Returns Promise<void>

setTextColor

setTextColor(textColor: string): Promise<void>

Implementation of IButton.setTextColor
- Defined in state/controls/Button.ts:117
Sets a new text color for this button.

Parameters
- textColor: string
Returns Promise<void>

setTextSize

setTextSize(textSize: string): Promise<void>

Implementation of IButton.setTextSize
- Defined in state/controls/Button.ts:82
Sets a progress value for this button. A decimalized percentage (0.0 - 1.0)

Parameters
- textSize: string
Returns Promise<void>

setTooltip

setTooltip(tooltip: string): Promise<void>

- Defined in state/controls/Button.ts:124
Sets a new tooltip value for this button.

Parameters
- tooltip: string
Returns Promise<void>

update

update(controlUpdate: IButtonUpdate): Promise<void>

Implementation of IButton.update

Overrides Control.update
- Defined in state/controls/Button.ts:163
Update this button on the server.

Parameters
- controlUpdate: IButtonUpdate
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 IButtonData
Parameters
- attribute: K
- value: T[K]
Returns Promise<void>

Static listenerCount

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

Implementation of IButton.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: IButtonData

Returns Button

Properties

accentColor

backgroundColor

borderColor

client

controlID

cooldown

cost

disabled

etag

focusColor

keyCode

kind

meta

position

progress

Protected scene

text

textColor

textSize

tooltip

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

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