Class ScoreboardIdentity`Beta`

Contains an identity of the scoreboard item.

Index

Constructors

Properties

displayName id type

Methods

getEntity getScore removeFromObjective setScore

Constructors

`Protected`constructor

new ScoreboardIdentity(): ScoreboardIdentity
Beta
Returns ScoreboardIdentity

Properties

`Readonly` `Beta`displayName

displayName: string

Returns the player-visible name of this identity.

`Readonly` `Beta`id

id: number

Identifier of the scoreboard identity.

`Readonly` `Beta`type

type: ScoreboardIdentityType

Type of the scoreboard identity.

Methods

getEntity

getEntity(): Entity
Beta
Returns Entity
Remarks
If the scoreboard identity is an entity or player, returns the entity that this scoreboard item corresponds to.

Throws
This function can throw errors.

getScore

getScore(objective: ScoreboardObjective): number
Beta
Parameters
- objective: ScoreboardObjective
  The objective to retrieve the score for.
Returns number
Score value.

Remarks
Gets the current score for this participant based on an objective.

Throws
This function can throw errors.

removeFromObjective

removeFromObjective(objective: ScoreboardObjective): boolean
Beta
Parameters
- objective: ScoreboardObjective
  The objective to remove this participant from.
Returns boolean
Remarks
Removes this participant from an objective.

Throws
This function can throw errors.

setScore

setScore(objective: ScoreboardObjective, score: number): boolean
Beta
Parameters
- objective: ScoreboardObjective
  Objective to apply the score to.
- score: number
  Score value.
Returns boolean
Remarks
Sets a score for this participant for a particular objective.

Throws
This function can throw errors.