Common

KattonScoreboardApi

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

Get a score value for a target in an objective.

Members

Jump directly to declarations on this page.

• getFunction
• setFunction
• fakeFunction
• KattonScoreHolderScoreCollectionClass
• KattonScoreHolderScoreCollection.getFunction
• KattonScoreHolderScoreCollection.setFunction
• scoresProperty
• getObjectiveFunction
• getOrCreateObjectiveFunction
• setScoreFunction
• setScoreFunction
• setScoreFunction
• addScoreFunction
• addScoreFunction
• addScoreFunction
• getScoreFunction
• getScoreFunction
• getScoreFunction
• resetScoreFunction
• resetScoreFunction
• resetScoreFunction
• leaveTeamFunction
• joinTeamFunction
• emptyTeamFunction
• deleteTeamFunction
• createTeamFunction
• getTeamFunction
• addTriggerValueFunction
• setTriggerValueFunction
• simpleTriggerFunction

get

CommonFunction

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

Get a score value for a target in an objective.

set

CommonFunction

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

Set a score value for a target in an objective.

fake

CommonFunction

fun fake(name: String): ScoreHolder

Create a fake score holder with a name.

Parameters

Parameter	Description
name	The name for the fake score holder

Returns

A ScoreHolder that only exists for scoreboard purposes

KattonScoreHolderScoreCollection

CommonClass

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

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

Properties

Property	Description
scoreboard	The Scoreboard instance
scoreHolder	The ScoreHolder whose scores are being accessed

KattonScoreHolderScoreCollection.get

CommonFunction

operator fun get(objective: Objective): Int?

Get the score value for an objective.

KattonScoreHolderScoreCollection.set

CommonFunction

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

Set the score value for an objective.

scores

CommonProperty

val ScoreHolder.scores: KattonScoreHolderScoreCollection

Extension property to access a score holder's scores.

getObjective

CommonFunction

fun getObjective(name: String): Objective?

Get an objective by name.

Parameters

Parameter	Description
name	objective name

Returns

Objective or null if not found

getOrCreateObjective

CommonFunction

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.

Parameters

Parameter	Description
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

Returns

existing or newly created Objective

setScore

CommonFunction

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

Set a score for a target identified by name.

Parameters

Parameter	Description
target	target name
objective	objective to set
value	score value to set

setScore

CommonFunction

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

Set a score for an Entity.

Parameters

Parameter	Description
target	target Entity
objective	objective to set
value	score value

setScore

CommonFunction

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

Set a score for a ScoreHolder.

Parameters

Parameter	Description
target	target ScoreHolder
objective	objective to set
value	score value

addScore

CommonFunction

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

Add delta to a target's score by name.

Parameters

Parameter	Description
target	target name
objective	objective to modify
delta	amount to add

addScore

CommonFunction

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

Add delta to a target Entity's score.

Parameters

Parameter	Description
target	target Entity
objective	objective to modify
delta	amount to add

addScore

CommonFunction

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

Add delta to a ScoreHolder's score.

Parameters

Parameter	Description
target	target ScoreHolder
objective	objective to modify
delta	amount to add

getScore

CommonFunction

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

Get a score by target name.

Parameters

Parameter	Description
target	target name
objective	objective to query

Returns

score value or null if not present

getScore

CommonFunction

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

Get a score by Entity.

Parameters

Parameter	Description
target	target Entity
objective	objective to query

Returns

score value or null if not present

getScore

CommonFunction

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

Get a score for a ScoreHolder.

Parameters

Parameter	Description
target	target ScoreHolder
objective	objective to query

Returns

score value or null if not present

resetScore

CommonFunction

fun resetScore(target: String, objective: Objective)

Reset a target's score by name.

Parameters

Parameter	Description
target	target name
objective	objective to reset

resetScore

CommonFunction

fun resetScore(target: Entity, objective: Objective)

Reset a target's score by Entity.

Parameters

Parameter	Description
target	target Entity
objective	objective to reset

resetScore

CommonFunction

fun resetScore(target: ScoreHolder, objective: Objective)

Reset a ScoreHolder's score.

Parameters

Parameter	Description
target	target ScoreHolder
objective	objective to reset

leaveTeam

CommonFunction

fun leaveTeam(members: Collection<ScoreHolder>)

Remove a collection of players from any teams.

Parameters

Parameter	Description
members	collection of ScoreHolder members to remove from teams

joinTeam

CommonFunction

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

Add members to a PlayerTeam.

Parameters

Parameter	Description
team	PlayerTeam to join
members	collection of ScoreHolder to add

emptyTeam

CommonFunction

fun emptyTeam(team: PlayerTeam)

Empty a player team of all members.

Parameters

Parameter	Description
team	PlayerTeam to empty

deleteTeam

CommonFunction

fun deleteTeam(team: PlayerTeam)

Delete a player team from the scoreboard.

Parameters

Parameter	Description
team	team to delete

createTeam

CommonFunction

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

Create a team if it does not exist.

Parameters

Parameter	Description
name	team name
displayName	display name component for the team

getTeam

CommonFunction

fun getTeam(name: String): PlayerTeam?

Get a team by name.

Parameters

Parameter	Description
name	team name

Returns

PlayerTeam or null if not found

addTriggerValue

CommonFunction

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

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

Parameters

Parameter	Description
serverPlayer	player to modify
objective	trigger objective
i	amount to add

setTriggerValue

CommonFunction

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

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

Parameters

Parameter	Description
serverPlayer	player to modify
objective	trigger objective
i	value to set

simpleTrigger

CommonFunction

fun simpleTrigger(serverPlayer: ServerPlayer, objective: Objective)

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

Parameters

Parameter	Description
serverPlayer	player to trigger
objective	trigger objective