Common

KattonMiscApi

common/src/main/kotlin/top/katton/api/dpcaller/KattonMiscApi.kt

Send a system message to a player.

Members

Jump directly to declarations on this page.

• tellFunction
• tellFunction
• tellFunction
• tellFunction
• tellFunction
• tellFunction
• tellFunction
• particleFunction
• teleportToEntityFunction
• teleportToPosFunction
• teleportToPosFunction
• teleportToPosFunction
• setWaypointStyleFunction
• setWaypointColorFunction
• setWaypointColorFunction
• resetWaypointColorFunction
• teamMsgFunction

tell

tellCommonFunction

fun tell(player: ServerPlayer, message: String)

Send a system message to a player.

Parameters

Parameter	Description
player	target ServerPlayer
message	plain string message

tell

tellCommonFunction

fun tell(player: ServerPlayer, message: Component)

Send a system message to a player.

Parameters

Parameter	Description
player	target ServerPlayer
message	message component

tell

tellCommonFunction

fun tell(player: ServerPlayer, message: Any)

Send a system message to a player.

Parameters

Parameter	Description
player	target ServerPlayer
message	message object, converted to string

tell

tellCommonFunction

fun tell(players: Collection<ServerPlayer>, message: String)

Send a system message to multiple players.

Parameters

Parameter	Description
players	target ServerPlayer collection
message	plain string message

tell

tellCommonFunction

fun tell(players: Collection<ServerPlayer>, message: Component)

Send a system message to multiple players.

Parameters

Parameter	Description
players	target ServerPlayer collection
message	message component

tell

tellCommonFunction

fun tell(players: Collection<ServerPlayer>, message: Any)

Send a system message to multiple players.

Parameters

Parameter	Description
players	target ServerPlayer collection
message	message object, converted to string

tell

tellCommonFunction

fun tell(message: Any)

Send a system message to all players.

Parameters

Parameter	Description
message	message object, converted to string

particle

particleCommonFunction

fun particle(level: ServerLevel, players: Collection<ServerPlayer>, particle: ParticleOptions, pos: Vec3, delta: Vec3 = Vec3.ZERO, speed: Double = 1.0, count: Int = 0, forced: Boolean = false)

Send particles to a collection of players.

Parameters

Parameter	Description
level	server level
players	players to send to
particle	particle options
pos	center position
delta	spread vector (default zero)
speed	particle speed
count	particle count
forced	whether to force sending and ignore client settings

teleportToEntity

teleportToEntityCommonFunction

fun teleportToEntity(collection: MutableCollection<out Entity>, entity: Entity)

Teleport a collection of entities to another entity's position.

Parameters

Parameter	Description
collection	entities to teleport
entity	entity used as the destination position

teleportToPos

teleportToPosCommonFunction

fun teleportToPos(collection: MutableCollection<out Entity>, serverLevel: ServerLevel, pos: Vec3, rot: Vec2? = null)

Teleport a collection of entities to a position with optional rotation.

Parameters

Parameter	Description
collection	entities to teleport
level	destination level
pos	destination position
rot	optional rotation vector; if null, keep the entity's current rotation

teleportToPos

teleportToPosCommonFunction

fun teleportToPos(collection: MutableCollection<out Entity>, serverLevel: ServerLevel, pos: Vec3, lookAt: Entity, anchor: EntityAnchorArgument.Anchor = EntityAnchorArgument.Anchor.FEET, lookAtAnchor: EntityAnchorArgument.Anchor = EntityAnchorArgument.Anchor.FEET)

Teleport a collection of entities to a position and make them face another entity.

Parameters

Parameter	Description
collection	entities to teleport
level	destination level
pos	destination position
lookAt	entity to look at after teleporting
anchor	anchor used on the teleported entity
lookAtAnchor	anchor used on the entity being looked at

teleportToPos

teleportToPosCommonFunction

fun teleportToPos(collection: MutableCollection<out Entity>, serverLevel: ServerLevel, pos: Vec3, lookAt: Vec3, anchor: EntityAnchorArgument.Anchor = EntityAnchorArgument.Anchor.FEET)

Teleport a collection of entities to a position and make them face another position.

Parameters

Parameter	Description
collection	entities to teleport
level	destination level
pos	destination position
lookAt	position to look at
anchor	anchor used on the teleported entity

setWaypointStyle

setWaypointStyleCommonFunction

fun setWaypointStyle(serverLevel: ServerLevel, waypointTransmitter: WaypointTransmitter, resourceKey: ResourceKey<WaypointStyleAsset>)

Set waypoint style for a waypoint transmitter.

Parameters

Parameter	Description
serverLevel	server level
waypointTransmitter	waypoint transmitter to modify
resourceKey	waypoint style asset key

setWaypointColor

setWaypointColorCommonFunction

fun setWaypointColor(serverLevel: ServerLevel, waypointTransmitter: WaypointTransmitter, chatFormatting: ChatFormatting)

Set waypoint color using ChatFormatting.

Parameters

Parameter	Description
serverLevel	server level
waypointTransmitter	waypoint transmitter
chatFormatting	formatting to convert to color

setWaypointColor

setWaypointColorCommonFunction

fun setWaypointColor(serverLevel: ServerLevel, waypointTransmitter: WaypointTransmitter, integer: Int)

Set waypoint color using an integer color value.

Parameters

Parameter	Description
serverLevel	server level
waypointTransmitter	waypoint transmitter
integer	integer color value

resetWaypointColor

resetWaypointColorCommonFunction

fun resetWaypointColor(serverLevel: ServerLevel, waypointTransmitter: WaypointTransmitter)

Reset waypoint color to default (unset).

Parameters

Parameter	Description
serverLevel	server level
waypointTransmitter	waypoint transmitter

teamMsg

teamMsgCommonFunction

fun teamMsg(entity: Entity, playerTeam: PlayerTeam, list: MutableList<ServerPlayer>, playerChatMessage: PlayerChatMessage, commandSourceStack: CommandSourceStack = requireServer().createCommandSourceStack())

Send a team chat message to a list of players with filtering and formatting.

Parameters

Parameter	Description
entity	source entity (sender)
playerTeam	team being messaged
list	recipients
playerChatMessage	message content
commandSourceStack	command source used for formatting and filtering