Class: Leaderboard#

Hierarchy#

Handle<leaderboard>
↳ Leaderboard

Constructors#

constructor#

new Leaderboard(): Leaderboard

Create a Leaderboard object

note Leaderboards initially have 0 rows, 0 columns, and no label.

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

Returns: Leaderboard

_{Defined in: handles/leaderboard.ts:6}

Properties#

handle#

• Readonly handle: leaderboard

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

Accessors#

displayed#

displayed(): boolean

Returns: boolean

_{Defined in: handles/leaderboard.ts:36}

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}

itemCount#

itemCount(): number

Returns: number

_{Defined in: handles/leaderboard.ts:40}

itemCount(count: number): void

Parameters:#

Name	Type
`count`	number

Returns: void

_{Defined in: handles/leaderboard.ts:44}

label#

label(): string

Returns: string

_{Defined in: handles/leaderboard.ts:116}

label(value: string): void

Parameters:#

Name	Type
`value`	string

Returns: void

_{Defined in: handles/leaderboard.ts:112}

Methods#

addItem#

addItem(label: string, value: number, p: MapPlayer): void

Parameters:#

Name	Type
`label`	string
`value`	number
`p`	MapPlayer

Returns: void

_{Defined in: handles/leaderboard.ts:20}

clear#

clear(): void

Returns: void

_{Defined in: handles/leaderboard.ts:24}

destroy#

destroy(): void

Returns: void

_{Defined in: handles/leaderboard.ts:28}

display#

display(flag?: boolean): void

Parameters:#

Name	Type	Default value
`flag`	boolean	true

Returns: void

_{Defined in: handles/leaderboard.ts:32}

getPlayerIndex#

getPlayerIndex(p: MapPlayer): number

Parameters:#

Name	Type
`p`	MapPlayer

Returns: number

_{Defined in: handles/leaderboard.ts:48}

hasPlayerItem#

hasPlayerItem(p: MapPlayer): void

Parameters:#

Name	Type
`p`	MapPlayer

Returns: void

_{Defined in: handles/leaderboard.ts:52}

removeItem#

removeItem(index: number): void

Parameters:#

Name	Type
`index`	number

Returns: void

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

removePlayerItem#

removePlayerItem(p: MapPlayer): void

Parameters:#

Name	Type
`p`	MapPlayer

Returns: void

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

setItemLabel#

setItemLabel(item: number, label: string): void

Parameters:#

Name	Type
`item`	number
`label`	string

Returns: void

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

setItemLabelColor#

setItemLabelColor(item: number, red: number, green: number, blue: number, alpha: number): void

Parameters:#

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

Returns: void

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

setItemStyle#

setItemStyle(item: number, showLabel?: boolean, showValues?: boolean, showIcons?: boolean): void

Parameters:#

Name	Type	Default value
`item`	number	-
`showLabel`	boolean	true
`showValues`	boolean	true
`showIcons`	boolean	true

Returns: void

_{Defined in: handles/leaderboard.ts:72}

setItemValue#

setItemValue(item: number, value: number): void

Parameters:#

Name	Type
`item`	number
`value`	number

Returns: void

_{Defined in: handles/leaderboard.ts:76}

setItemValueColor#

setItemValueColor(item: number, red: number, green: number, blue: number, alpha: number): void

Parameters:#

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

Returns: void

_{Defined in: handles/leaderboard.ts:80}

setLabelColor#

setLabelColor(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/leaderboard.ts:84}

setPlayerBoard#

setPlayerBoard(p: MapPlayer): void

Parameters:#

Name	Type
`p`	MapPlayer

Returns: void

_{Defined in: handles/leaderboard.ts:88}

setStyle#

setStyle(showLabel?: boolean, showNames?: boolean, showValues?: boolean, showIcons?: boolean): void

Parameters:#

Name	Type	Default value
`showLabel`	boolean	true
`showNames`	boolean	true
`showValues`	boolean	true
`showIcons`	boolean	true

Returns: void

_{Defined in: handles/leaderboard.ts:92}

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/leaderboard.ts:96}

sortByLabel#

sortByLabel(asc?: boolean): void

Parameters:#

Name	Type	Default value
`asc`	boolean	true

Returns: void

_{Defined in: handles/leaderboard.ts:100}

sortByPlayer#

sortByPlayer(asc?: boolean): void

Parameters:#

Name	Type	Default value
`asc`	boolean	true

Returns: void

_{Defined in: handles/leaderboard.ts:104}

sortByValue#

sortByValue(asc?: boolean): void

Parameters:#

Name	Type	Default value
`asc`	boolean	true

Returns: void

_{Defined in: handles/leaderboard.ts:108}

fromHandle#

static fromHandle(handle: leaderboard): Leaderboard

Parameters:#

Name	Type
`handle`	leaderboard

Returns: Leaderboard

_{Defined in: handles/leaderboard.ts:120}

fromPlayer#

static fromPlayer(p: MapPlayer): Leaderboard

Parameters:#

Name	Type
`p`	MapPlayer

Returns: Leaderboard

_{Defined in: handles/leaderboard.ts:124}