类 ScoreboardObjective实验性

表示记分板上的记分项。包含了分数持有者和各自的分数。

Contains objectives and participants for the scoreboard.

属性

displayName id isValid

方法

addScore getParticipants getScore getScores hasParticipant removeParticipant setScore

属性

只读 实验性displayName

displayName: string

备注

此记分项的显示名称。

Returns the player-visible name of this scoreboard objective.

抛出

若记分项无效，则抛出。

只读 实验性id

id: string

备注

此记分项的名称。

Identifier of the scoreboard objective.

抛出

若记分项无效，则抛出。

只读 实验性isValid

isValid: boolean

备注

Returns true if the ScoreboardObjective reference is still valid.

方法

addScore

  • addScore(
        participant: string | Entity | ScoreboardIdentity,
        scoreToAdd: number,
    ): number
  • 实验性

    参数

    • participant: string | Entity | ScoreboardIdentity

      Participant to apply the scoreboard value addition to.

    • scoreToAdd: number

    返回 number

    备注

    Adds a score to the given participant and objective.

    无法在只读模式下调用此函数，详见 WorldBeforeEvents。

    抛出

    This function can throw errors.

getParticipants

  • getParticipants(): ScoreboardIdentity[]
  • 实验性

    返回 ScoreboardIdentity[]

    由分数持有者对象组成的数组。

    备注

    返回此记分项上已记录的分数持有者。

    Returns all objective participant identities.

    抛出

    若记分项无效时，抛出。

getScore

  • getScore(participant: string | Entity | ScoreboardIdentity): number
  • 实验性

    参数

    • participant: string | Entity | ScoreboardIdentity

      分数持有者。

      Identifier of the participant to retrieve a score for.

    返回 number

    指定分数持有者的分数。

    备注

    获取指定分数持有者的分数。

    Returns a specific score for a participant.

    抛出

    若此记分项上未记录分数持有者的分数，抛出 "Failed to retrieve score for '<participant>'"。 若记分项无效时，抛出。

getScores

  • getScores(): ScoreboardScoreInfo[]
  • 实验性

    返回 ScoreboardScoreInfo[]

    由分数信息对象组成的数组。

    备注

    获取记分项上记录的所有分数信息。

    Returns specific scores for this objective for all participants.

    抛出

    若记分项无效时，抛出。

hasParticipant

  • hasParticipant(participant: string | Entity | ScoreboardIdentity): boolean
  • 实验性

    参数

    返回 boolean

    备注

    Returns if the specified identity is a participant of the scoreboard objective.

    抛出

    This function can throw errors.

removeParticipant

  • removeParticipant(participant: string | Entity | ScoreboardIdentity): boolean
  • 实验性

    参数

    返回 boolean

    备注

    Removes a participant from this scoreboard objective.

    无法在只读模式下调用此函数，详见 WorldBeforeEvents。

    抛出

    This function can throw errors.

setScore

  • setScore(participant: string | Entity | ScoreboardIdentity, score: number): void
  • 实验性

    参数

    返回 void

    备注

    Sets a score for a participant.

    无法在只读模式下调用此函数，详见 WorldBeforeEvents。

    抛出

    This function can throw errors.

显示设置

成员可见性

目录

属性
方法