Class ScriptScoreboard

Index

Constructors

Methods

addObjective addScore getObjective getObjectives getScore getScores removeObjective removeParticipant removeScore setDisplay setScore

Constructors

constructor

new ScriptScoreboard(session: ISession): ScriptScoreboard
Parameters
- session: ISession
Returns ScriptScoreboard
- Defined in projects/server/src/minecraft/bridge/scoreboard/scoreboard.ts:26

Methods

addObjective

addObjective(
objectiveId: string,
displayName?: string,
): Promise<ScriptScoreboardObjective>
Adds a new objective to the scoreboard.
Parameters
- objectiveId: string
- OptionaldisplayName: string
Returns Promise<ScriptScoreboardObjective>
- Defined in projects/server/src/minecraft/bridge/scoreboard/scoreboard.ts:68

addScore

addScore(
    target: string | ScriptPlayer,
    objective: string | ScriptScoreboardObjective,
    score: number,
): Promise<number>
Adds the score given a player and objective.
Parameters
- target: string | ScriptPlayer
- objective: string | ScriptScoreboardObjective
- score: number
Returns Promise<number>
New value of the score.
- Defined in projects/server/src/minecraft/bridge/scoreboard/scoreboard.ts:144

getObjective

getObjective(
objectiveId: string,
): Promise<ScriptScoreboardObjective | undefined>
Returns a specific objective (by id).
Parameters
- objectiveId: string
Returns Promise<ScriptScoreboardObjective | undefined>
- Defined in projects/server/src/minecraft/bridge/scoreboard/scoreboard.ts:52

getObjectives

getObjectives(): Promise<ScriptScoreboardObjective[]>
Returns all defined objectives.

Returns Promise<ScriptScoreboardObjective[]>
- Defined in projects/server/src/minecraft/bridge/scoreboard/scoreboard.ts:33

getScore

getScore(
target: string | ScriptPlayer,
objective: string | ScriptScoreboardObjective,
): Promise<number | null>
Returns a score given a player and objective.
Parameters
- target: string | ScriptPlayer
- objective: string | ScriptScoreboardObjective
Returns Promise<number | null>
- Defined in projects/server/src/minecraft/bridge/scoreboard/scoreboard.ts:99

getScores

getScores(
objective: string | ScriptScoreboardObjective,
): Promise<ScriptScoreboardScoreInfo[]>
Parameters
- objective: string | ScriptScoreboardObjective
Returns Promise<ScriptScoreboardScoreInfo[]>
- Defined in projects/server/src/minecraft/bridge/scoreboard/scoreboard.ts:112

removeObjective

removeObjective(objective: string | ScriptScoreboardObjective): Promise<void>
Removes an objective from the scoreboard.
Parameters
- objective: string | ScriptScoreboardObjective
Returns Promise<void>
- Defined in projects/server/src/minecraft/bridge/scoreboard/scoreboard.ts:86

removeParticipant

removeParticipant(
target: string | ScriptPlayer,
objective: string | ScriptScoreboardObjective,
): Promise<void>
Removes a player from an objective.
Parameters
- target: string | ScriptPlayer
- objective: string | ScriptScoreboardObjective
Returns Promise<void>
- Defined in projects/server/src/minecraft/bridge/scoreboard/scoreboard.ts:182

removeScore

removeScore(
    target: string | ScriptPlayer,
    objective: string | ScriptScoreboardObjective,
    score: number,
): Promise<number>
Removes the score given a player and objective.
Parameters
- target: string | ScriptPlayer
- objective: string | ScriptScoreboardObjective
- score: number
Returns Promise<number>
New value of the score.
- Defined in projects/server/src/minecraft/bridge/scoreboard/scoreboard.ts:163

setDisplay

setDisplay(
    displaySlotId: DisplaySlotId,
    objective?: string | ScriptScoreboardObjective,
    sortOrder?: ObjectiveSortOrder,
): Promise<void>
Sets an objective into a display slot with specified additional display settings.
Parameters
- displaySlotId: DisplaySlotId
- Optionalobjective: string | ScriptScoreboardObjective
- OptionalsortOrder: ObjectiveSortOrder
Returns Promise<void>
- Defined in projects/server/src/minecraft/bridge/scoreboard/scoreboard.ts:196

setScore

setScore(
    target: string | ScriptPlayer,
    objective: string | ScriptScoreboardObjective,
    score: number,
): Promise<number>
Sets the score given a player and objective.
Parameters
- target: string | ScriptPlayer
- objective: string | ScriptScoreboardObjective
- score: number
Returns Promise<number>
New value of the score.
- Defined in projects/server/src/minecraft/bridge/scoreboard/scoreboard.ts:125

Class ScriptScoreboard

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns ScriptScoreboard

Methods

addObjective

Parameters

Returns Promise<ScriptScoreboardObjective>

addScore

Parameters

Returns Promise<number>

getObjective

Parameters

Returns Promise<ScriptScoreboardObjective | undefined>

getObjectives

Returns Promise<ScriptScoreboardObjective[]>

getScore

Parameters

Returns Promise<number | null>

getScores

Parameters

Returns Promise<ScriptScoreboardScoreInfo[]>

removeObjective

Parameters

Returns Promise<void>

removeParticipant

Parameters

Returns Promise<void>

removeScore

Parameters

Returns Promise<number>

setDisplay

Parameters

Returns Promise<void>

setScore

Parameters

Returns Promise<number>

Settings

On This Page