Class Scoreboard

Velt's Scoreboard utility

Hierarchy

Scoreboard

Index

Constructors

constructor

Properties

name
slot

Methods

Constructors

constructor

new Scoreboard(name: string | ScoreboardOpts): Scoreboard
new Scoreboard(name: string, opts: ScoreboardOpts): Scoreboard
new Scoreboard(name: string, slot: number, opts: ScoreboardOpts): Scoreboard
new Scoreboard(name: string, slot: number, type: string): Scoreboard
new Scoreboard(name: string, slot: number, type: string, scores: any): Scoreboard

- Defined in helpers.d.ts:145
Create a scoreboard from the given name, slot, type, scores, and options

Parameters
- name: string | ScoreboardOpts
  
  The name of the scoreboard, or the given options
Returns Scoreboard
- Defined in helpers.d.ts:153
Parameters
- name: string
- opts: ScoreboardOpts
Returns Scoreboard
- Defined in helpers.d.ts:154
Parameters
- name: string
- slot: number
- opts: ScoreboardOpts
Returns Scoreboard
- Defined in helpers.d.ts:155
Parameters
- name: string
- slot: number
- type: string
Returns Scoreboard
- Defined in helpers.d.ts:156
Parameters
- name: string
- slot: number
- type: string
- scores: any
Returns Scoreboard

Properties

name

name: string

The name of the scoreboard

slot

slot: number

The display slot of the scoreboard

Methods

set

set(index: number, text: string): Scoreboard
set(scores: {}): Scoreboard
set(scores: (string | [number, string])[]): void | Scoreboard

- Defined in helpers.d.ts:185
Set one or more scores of the scoreboard to replacement values

Parameters
- index: number
- text: string
Returns Scoreboard
- Defined in helpers.d.ts:186
Parameters
- scores: {}
  - [prop: number]: string
Returns Scoreboard
- Defined in helpers.d.ts:187
Parameters
- scores: (string | [number, string])[]
Returns void | Scoreboard

setName

setName(name: string): Scoreboard

- Defined in helpers.d.ts:175
Set the name of the scoreboard to the given replacement name

Parameters
- name: string
  
  The name to change the scoreboard to
Returns Scoreboard

setScore

setScore(index: number, text: string): Scoreboard

- Defined in helpers.d.ts:181
Set a score of the scoreboard to a new value

Parameters
- index: number
  
  The score of the scoreboard to replace
- text: string
  
  The new value to replace the score with
Returns Scoreboard

setSlot

setSlot(slot: number): Scoreboard

- Defined in helpers.d.ts:166
Set the display slot of the scoreboard to a different slot

Parameters
- slot: number
  
  The slot to set the scoreboard to
Returns Scoreboard

show

show(...players: any[]): Scoreboard

- Defined in helpers.d.ts:192
Show this scoreboard to one or more players

Parameters
- Rest ...players: any[]
  
  The players to show the scoreboard to
Returns Scoreboard

Generated using TypeDoc