Class: Multiboard#

Hierarchy#

Handle<multiboard>
↳ Multiboard

Constructors#

constructor#

new Multiboard(): Multiboard

Create a Multiboard object

bug Do not use this in a global initialisation as it crashes the game there.

Returns: Multiboard

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

Properties#

handle#

• Readonly handle: multiboard

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

Accessors#

columns#

columns(): number

Returns: number

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

columns(count: number): void

Parameters:#

Name	Type
`count`	number

Returns: void

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

displayed#

displayed(): boolean

Returns: boolean

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

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}

rows#

rows(): number

Returns: number

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

rows(count: number): void

bug It is only safe to change the row count by one. Use multiple calls for bigger values.

Parameters:#

Name	Type
`count`	number

Returns: void

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

title#

title(): string

Returns: string

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

title(label: string): void

Parameters:#

Name	Type
`label`	string

Returns: void

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

Methods#

clear#

clear(): void

Returns: void

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

createItem#

createItem(x: number, y: number): MultiboardItem

Parameters:#

Name	Type
`x`	number
`y`	number

Returns: MultiboardItem

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

destroy#

destroy(): void

Returns: void

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

display#

display(show: boolean): void

note Multiboards can not be shown at map-init. Use a wait or a zero-timer to display as soon as possible.

Parameters:#

Name	Type
`show`	boolean

Returns: void

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

minimize#

minimize(flag: boolean): void

Parameters:#

Name	Type
`flag`	boolean

Returns: void

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

minimized#

minimized(): boolean

async

Returns: boolean

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

setItemsIcons#

setItemsIcons(icon: string): void

Parameters:#

Name	Type
`icon`	string

Returns: void

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

setItemsStyle#

setItemsStyle(showValues: boolean, showIcons: boolean): void

Parameters:#

Name	Type
`showValues`	boolean
`showIcons`	boolean

Returns: void

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

setItemsValue#

setItemsValue(value: string): void

Parameters:#

Name	Type
`value`	string

Returns: void

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

setItemsValueColor#

setItemsValueColor(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:129}

setItemsWidth#

setItemsWidth(width: number): void

Parameters:#

Name	Type
`width`	number

Returns: void

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

setTitleTextColor#

setTitleTextColor(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:137}

fromHandle#

static fromHandle(handle: multiboard): Multiboard

Parameters:#

Name	Type
`handle`	multiboard

Returns: Multiboard

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

suppressDisplay#

static suppressDisplay(flag: boolean): void

Meant to unequivocally suspend display of existing and subsequently displayed multiboards.

Parameters:#

Name	Type
`flag`	boolean

Returns: void

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