Class Leaderboard

No Self In File

Hierarchy

Handle<leaderboard>
- Leaderboard

Index

Constructors

constructor

new Leaderboard(): Leaderboard
Returns Leaderboard
Overrides Handle.constructor
- Defined in w3ts/handles/leaderboard.ts:8

Properties

`Readonly` handle

handle: leaderboard

Accessors

displayed

get displayed(): boolean
Returns boolean
- Defined in w3ts/handles/leaderboard.ts:32

id

get id(): number
Returns number
Inherited from Handle.id
- Defined in w3ts/handles/handle.ts:15

itemCount

get itemCount(): number
Returns number
- Defined in w3ts/handles/leaderboard.ts:36
set itemCount(count: number): void
Parameters
- count: number
Returns void
- Defined in w3ts/handles/leaderboard.ts:40

label

get label(): string
Returns string
- Defined in w3ts/handles/leaderboard.ts:112
set label(value: string): void
Parameters
- value: string
Returns void
- Defined in w3ts/handles/leaderboard.ts:108

Methods

addItem

addItem(label: string, value: number, p: MapPlayer): void
Parameters
- label: string
- value: number
- p: MapPlayer
Returns void
- Defined in w3ts/handles/leaderboard.ts:16

clear

clear(): void
Returns void
- Defined in w3ts/handles/leaderboard.ts:20

destroy

destroy(): void
Returns void
- Defined in w3ts/handles/leaderboard.ts:24

display

display(flag?: boolean): void
Parameters
- flag: boolean = true
Returns void
- Defined in w3ts/handles/leaderboard.ts:28

getPlayerIndex

getPlayerIndex(p: MapPlayer): number
Parameters
- p: MapPlayer
Returns number
- Defined in w3ts/handles/leaderboard.ts:44

hasPlayerItem

hasPlayerItem(p: MapPlayer): void
Parameters
- p: MapPlayer
Returns void
- Defined in w3ts/handles/leaderboard.ts:48

removeItem

removeItem(index: number): void
Parameters
- index: number
Returns void
- Defined in w3ts/handles/leaderboard.ts:52

removePlayerItem

removePlayerItem(p: MapPlayer): void
Parameters
- p: MapPlayer
Returns void
- Defined in w3ts/handles/leaderboard.ts:56

setItemLabel

setItemLabel(item: number, label: string): void
Parameters
- item: number
- label: string
Returns void
- Defined in w3ts/handles/leaderboard.ts:60

setItemLabelColor

setItemLabelColor(item: number, red: number, green: number, blue: number, alpha: number): void
Parameters
- item: number
- red: number
- green: number
- blue: number
- alpha: number
Returns void
- Defined in w3ts/handles/leaderboard.ts:64

setItemStyle

setItemStyle(item: number, showLabel?: boolean, showValues?: boolean, showIcons?: boolean): void
Parameters
- item: number
- showLabel: boolean = true
- showValues: boolean = true
- showIcons: boolean = true
Returns void
- Defined in w3ts/handles/leaderboard.ts:68

setItemValue

setItemValue(item: number, value: number): void
Parameters
- item: number
- value: number
Returns void
- Defined in w3ts/handles/leaderboard.ts:72

setItemValueColor

setItemValueColor(item: number, red: number, green: number, blue: number, alpha: number): void
Parameters
- item: number
- red: number
- green: number
- blue: number
- alpha: number
Returns void
- Defined in w3ts/handles/leaderboard.ts:76

setLabelColor

setLabelColor(red: number, green: number, blue: number, alpha: number): void
Parameters
- red: number
- green: number
- blue: number
- alpha: number
Returns void
- Defined in w3ts/handles/leaderboard.ts:80

setPlayerBoard

setPlayerBoard(p: MapPlayer): void
Parameters
- p: MapPlayer
Returns void
- Defined in w3ts/handles/leaderboard.ts:84

setStyle

setStyle(showLabel?: boolean, showNames?: boolean, showValues?: boolean, showIcons?: boolean): void
Parameters
- showLabel: boolean = true
- showNames: boolean = true
- showValues: boolean = true
- showIcons: boolean = true
Returns void
- Defined in w3ts/handles/leaderboard.ts:88

setValueColor

setValueColor(red: number, green: number, blue: number, alpha: number): void
Parameters
- red: number
- green: number
- blue: number
- alpha: number
Returns void
- Defined in w3ts/handles/leaderboard.ts:92

sortByLabel

sortByLabel(asc?: boolean): void
Parameters
- asc: boolean = true
Returns void
- Defined in w3ts/handles/leaderboard.ts:96

sortByPlayer

sortByPlayer(asc?: boolean): void
Parameters
- asc: boolean = true
Returns void
- Defined in w3ts/handles/leaderboard.ts:100

sortByValue

sortByValue(asc?: boolean): void
Parameters
- asc: boolean = true
Returns void
- Defined in w3ts/handles/leaderboard.ts:104

`Static` fromHandle

fromHandle(handle: leaderboard): Leaderboard
Parameters
- handle: leaderboard
Returns Leaderboard
- Defined in w3ts/handles/leaderboard.ts:116

`Static` fromPlayer

fromPlayer(p: MapPlayer): Leaderboard
Parameters
- p: MapPlayer
Returns Leaderboard
- Defined in w3ts/handles/leaderboard.ts:120

`Static` `Protected` getObject

getObject(handle: handle): any
Parameters
- handle: handle
Returns any
Inherited from Handle.getObject
- Defined in w3ts/handles/handle.ts:23

`Static` initFromHandle

initFromHandle(): boolean
Returns boolean
Inherited from Handle.initFromHandle
- Defined in w3ts/handles/handle.ts:19