Class ScoreboardObjective

Contains objectives and participants for the scoreboard.

Index

Properties

displayName id isValid

Methods

addScore getParticipants getScore getScores hasParticipant removeParticipant setScore

Properties

`Readonly`displayName

displayName: string

Remarks

Returns the player-visible name of this scoreboard objective.

Throws

This property can throw when used.

`Readonly`id

id: string

Remarks

Identifier of the scoreboard objective.

Throws

This property can throw when used.

`Readonly`isValid

isValid: boolean

Remarks

Returns true if the ScoreboardObjective reference is still valid.

Methods

addScore

addScore(
participant: string | Entity | ScoreboardIdentity,
scoreToAdd: number,
): number
World mutation
Parameters
- participant: string | Entity | ScoreboardIdentity
  Participant to apply the scoreboard value addition to.
- scoreToAdd: number
Returns number
Remarks
Adds a score to the given participant and objective.

Throws
This function can throw errors.
- Defined in @minecraft/server.d.ts:17943

getParticipants

getParticipants(): ScoreboardIdentity[]
Returns ScoreboardIdentity[]
Remarks
Returns all objective participant identities.

Throws
This function can throw errors.
- Defined in @minecraft/server.d.ts:17950

getScore

getScore(participant: string | Entity | ScoreboardIdentity): number
Parameters
- participant: string | Entity | ScoreboardIdentity
  Identifier of the participant to retrieve a score for.
Returns number
Remarks
Returns a specific score for a participant.

Throws
This function can throw errors.
- Defined in @minecraft/server.d.ts:17959

getScores

getScores(): ScoreboardScoreInfo[]
Returns ScoreboardScoreInfo[]
Remarks
Returns specific scores for this objective for all participants.

Throws
This function can throw errors.
- Defined in @minecraft/server.d.ts:17967

hasParticipant

hasParticipant(participant: string | Entity | ScoreboardIdentity): boolean
Parameters
- participant: string | Entity | ScoreboardIdentity
Returns boolean
Remarks
Returns if the specified identity is a participant of the scoreboard objective.

Throws
This function can throw errors.
- Defined in @minecraft/server.d.ts:17975

removeParticipant

removeParticipant(participant: string | Entity | ScoreboardIdentity): boolean
World mutation
Parameters
- participant: string | Entity | ScoreboardIdentity
  Participant to remove from being tracked with this objective.
Returns boolean
Remarks
Removes a participant from this scoreboard objective.

Throws
This function can throw errors.
- Defined in @minecraft/server.d.ts:17987

setScore

setScore(participant: string | Entity | ScoreboardIdentity, score: number): void
World mutation
Parameters
- participant: string | Entity | ScoreboardIdentity
  Identity of the participant.
- score: number
  New value of the score.
Returns void
Remarks
Sets a score for a participant.

Throws
This function can throw errors.
- Defined in @minecraft/server.d.ts:18000