Class ScoreboardObjective`Beta`

Contains objectives and participants for the scoreboard.

Hierarchy

ScoreboardObjective

Index

Constructors

Properties

Methods

getParticipants getScore getScores removeParticipant setScore

Constructors

`Protected` constructor

new ScoreboardObjective(): ScoreboardObjective
Returns ScoreboardObjective
- Defined in index.d.ts:14241

Properties

`Readonly` displayName

displayName: string

Returns the player-visible name of this scoreboard objective.

Throws

This property can throw when used.

`Readonly` id

id: string

Identifier of the scoreboard objective.

Throws

This property can throw when used.

Methods

getParticipants

getParticipants(): ScoreboardIdentity[]
Returns ScoreboardIdentity[]

Remarks
Returns all objective participant identities.

Throws
This function can throw errors.
- Defined in index.d.ts:14258

getScore

getScore(participant): number
Parameters
- participant: ScoreboardIdentity
Returns number

Remarks
Returns a specific score for a participant.

Throws
This function can throw errors.
- Defined in index.d.ts:14265

getScores

getScores(): ScoreboardScoreInfo[]
Returns ScoreboardScoreInfo[]

Remarks
Returns specific scores for this objective for all participants.

Throws
This function can throw errors.
- Defined in index.d.ts:14272

removeParticipant

removeParticipant(participant): boolean
Parameters
- participant: ScoreboardIdentity
Returns boolean
- Defined in index.d.ts:14273

setScore

setScore(participant, score): boolean
Parameters
- participant: ScoreboardIdentity
- score: number
Returns boolean
- Defined in index.d.ts:14274