Class: MultiboardItem#

Hierarchy#

Handle<multiboarditem>
↳ MultiboardItem

Constructors#

constructor#

new MultiboardItem(board: Multiboard, x: number, y: number): MultiboardItem

Parameters:#

Name	Type
`board`	Multiboard
`x`	number
`y`	number

Returns: MultiboardItem

_{Defined in: handles/multiboard.ts:5}

Properties#

handle#

• Readonly handle: multiboarditem

_{Inherited from: Handle.handle
Defined in: handles/handle.ts:6}

Accessors#

id#

id(): number

Get the unique ID of the handle. The ID is recycled once you destroy the object.

Returns: number

The unique ID of a handle object.

_{Defined in: handles/handle.ts:18}

Methods#

destroy#

destroy(): void

Returns: void

_{Defined in: handles/multiboard.ts:14}

setIcon#

setIcon(icon: string): void

Parameters:#

Name	Type
`icon`	string

Returns: void

_{Defined in: handles/multiboard.ts:18}

setStyle#

setStyle(showValue: boolean, showIcon: boolean): void

Parameters:#

Name	Type
`showValue`	boolean
`showIcon`	boolean

Returns: void

_{Defined in: handles/multiboard.ts:22}

setValue#

setValue(val: string): void

Parameters:#

Name	Type
`val`	string

Returns: void

_{Defined in: handles/multiboard.ts:26}

setValueColor#

setValueColor(red: number, green: number, blue: number, alpha: number): void

Parameters:#

Name	Type
`red`	number
`green`	number
`blue`	number
`alpha`	number

Returns: void

_{Defined in: handles/multiboard.ts:30}

setWidth#

setWidth(width: number): void

Parameters:#

Name	Type
`width`	number

Returns: void

_{Defined in: handles/multiboard.ts:34}

fromHandle#

static fromHandle(handle: multiboarditem): MultiboardItem

Parameters:#

Name	Type
`handle`	multiboarditem

Returns: MultiboardItem

_{Defined in: handles/multiboard.ts:38}