通用

KattonScoreboardApi

top.katton.api.dpcallercommon/src/main/kotlin/top/katton/api/dpcaller/KattonScoreboardApi.kt

Get a score value for a target in an objective.

成员

直接跳转到本页的声明。

• get函数
• set函数
• fake函数
• KattonScoreHolderScoreCollection类
• KattonScoreHolderScoreCollection.get函数
• KattonScoreHolderScoreCollection.set函数
• scores属性
• getObjective函数
• getOrCreateObjective函数
• setScore函数
• setScore函数
• setScore函数
• addScore函数
• addScore函数
• addScore函数
• getScore函数
• getScore函数
• getScore函数
• resetScore函数
• resetScore函数
• resetScore函数
• leaveTeam函数
• joinTeam函数
• emptyTeam函数
• deleteTeam函数
• createTeam函数
• getTeam函数
• addTriggerValue函数
• setTriggerValue函数
• simpleTrigger函数

get

get通用函数

operator fun Scoreboard.get(target: ScoreHolder, objective: Objective): Int?

Get a score value for a target in an objective.

set

set通用函数

operator fun Scoreboard.set(target: ScoreHolder, objective: Objective, value: Int)

Set a score value for a target in an objective.

fake

fake通用函数

fun fake(name: String): ScoreHolder

Create a fake score holder with a name.

参数

参数	说明
name	The name for the fake score holder

返回值

A ScoreHolder that only exists for scoreboard purposes

KattonScoreHolderScoreCollection

KattonScoreHolderScoreCollection通用类

class KattonScoreHolderScoreCollection( val scoreboard: Scoreboard, val scoreHolder: ScoreHolder )

Map-like access to a score holder's scores across objectives.

属性

属性	说明
scoreboard	The Scoreboard instance
scoreHolder	The ScoreHolder whose scores are being accessed

KattonScoreHolderScoreCollection.get

KattonScoreHolderScoreCollection.get通用函数

operator fun get(objective: Objective): Int?

Get the score value for an objective.

KattonScoreHolderScoreCollection.set

KattonScoreHolderScoreCollection.set通用函数

operator fun set(objective: Objective, value: Int)

Set the score value for an objective.

scores

scores通用属性

val ScoreHolder.scores: KattonScoreHolderScoreCollection

Extension property to access a score holder's scores.

getObjective

getObjective通用函数

fun getObjective(name: String): Objective?

Get an objective by name.

参数

参数	说明
name	objective name

返回值

Objective or null if not found

getOrCreateObjective

getOrCreateObjective通用函数

fun getOrCreateObjective(name: String, displayName: Component = Component.literal(name), criteria: ObjectiveCriteria = ObjectiveCriteria.DUMMY, renderType: ObjectiveCriteria.RenderType = ObjectiveCriteria.RenderType.INTEGER, displayAutoUpdate: Boolean = false, numberFormat: NumberFormat? = null): Objective

Get or create a scoreboard Objective.

参数

参数	说明
name	objective name
displayName	display name component for the objective
criteria	objective criteria
renderType	render type for the objective
displayAutoUpdate	whether the display auto-updates
numberFormat	optional number format

返回值

existing or newly created Objective

setScore

setScore通用函数

fun setScore(target: String, objective: Objective, value: Int)

Set a score for a target identified by name.

参数

参数	说明
target	target name
objective	objective to set
value	score value to set

setScore

setScore通用函数

fun setScore(target: Entity, objective: Objective, value: Int)

Set a score for an Entity.

参数

参数	说明
target	target Entity
objective	objective to set
value	score value

setScore

setScore通用函数

fun setScore(target: ScoreHolder, objective: Objective, value: Int)

Set a score for a ScoreHolder.

参数

参数	说明
target	target ScoreHolder
objective	objective to set
value	score value

addScore

addScore通用函数

fun addScore(target: String, objective: Objective, delta: Int)

Add delta to a target's score by name.

参数

参数	说明
target	target name
objective	objective to modify
delta	amount to add

addScore

addScore通用函数

fun addScore(target: Entity, objective: Objective, delta: Int)

Add delta to a target Entity's score.

参数

参数	说明
target	target Entity
objective	objective to modify
delta	amount to add

addScore

addScore通用函数

fun addScore(target: ScoreHolder, objective: Objective, delta: Int)

Add delta to a ScoreHolder's score.

参数

参数	说明
target	target ScoreHolder
objective	objective to modify
delta	amount to add

getScore

getScore通用函数

fun getScore(target: String, objective: Objective): Int?

Get a score by target name.

参数

参数	说明
target	target name
objective	objective to query

返回值

score value or null if not present

getScore

getScore通用函数

fun getScore(target: Entity, objective: Objective): Int?

Get a score by Entity.

参数

参数	说明
target	target Entity
objective	objective to query

返回值

score value or null if not present

getScore

getScore通用函数

fun getScore(target: ScoreHolder, objective: Objective): Int?

Get a score for a ScoreHolder.

参数

参数	说明
target	target ScoreHolder
objective	objective to query

返回值

score value or null if not present

resetScore

resetScore通用函数

fun resetScore(target: String, objective: Objective)

Reset a target's score by name.

参数

参数	说明
target	target name
objective	objective to reset

resetScore

resetScore通用函数

fun resetScore(target: Entity, objective: Objective)

Reset a target's score by Entity.

参数

参数	说明
target	target Entity
objective	objective to reset

resetScore

resetScore通用函数

fun resetScore(target: ScoreHolder, objective: Objective)

Reset a ScoreHolder's score.

参数

参数	说明
target	target ScoreHolder
objective	objective to reset

leaveTeam

leaveTeam通用函数

fun leaveTeam(members: Collection<ScoreHolder>)

Remove a collection of players from any teams.

参数

参数	说明
members	collection of ScoreHolder members to remove from teams

joinTeam

joinTeam通用函数

fun joinTeam(team: PlayerTeam, members: Collection<ScoreHolder>)

Add members to a PlayerTeam.

参数

参数	说明
team	PlayerTeam to join
members	collection of ScoreHolder to add

emptyTeam

emptyTeam通用函数

fun emptyTeam(team: PlayerTeam)

Empty a player team of all members.

参数

参数	说明
team	PlayerTeam to empty

deleteTeam

deleteTeam通用函数

fun deleteTeam(team: PlayerTeam)

Delete a player team from the scoreboard.

参数

参数	说明
team	team to delete

createTeam

createTeam通用函数

fun createTeam(name: String, displayName: Component = Component.literal(name))

Create a team if it does not exist.

参数

参数	说明
name	team name
displayName	display name component for the team

getTeam

getTeam通用函数

fun getTeam(name: String): PlayerTeam?

Get a team by name.

参数

参数	说明
name	team name

返回值

PlayerTeam or null if not found

addTriggerValue

addTriggerValue通用函数

fun addTriggerValue(serverPlayer: ServerPlayer, objective: Objective, i: Int)

Add a trigger score value for a player on a trigger objective.

参数

参数	说明
serverPlayer	player to modify
objective	trigger objective
i	amount to add

setTriggerValue

setTriggerValue通用函数

fun setTriggerValue(serverPlayer: ServerPlayer, objective: Objective, i: Int)

Set a trigger score value for a player on a trigger objective.

参数

参数	说明
serverPlayer	player to modify
objective	trigger objective
i	value to set

simpleTrigger

simpleTrigger通用函数

fun simpleTrigger(serverPlayer: ServerPlayer, objective: Objective)

Simple trigger: increment a trigger objective for a player by 1.

参数

参数	说明
serverPlayer	player to trigger
objective	trigger objective