Common

KattonWorldApi

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

Map-like access to all server levels by ResourceKey.

Members

Jump directly to declarations on this page.

• KattonLevelMapClass
• KattonLevelMap.overworldProperty
• KattonLevelMap.netherProperty
• KattonLevelMap.endProperty
• levelsProperty
• playersProperty
• blockEntitiesProperty
• entitiesProperty
• blocksProperty
• blockStatesProperty
• setBlockFunction
• setBlockFunction
• fillFunction
• fillFunction
• fillBiomeFunction
• locateStructureFunction
• locateStructureFunction
• locateBiomeFunction
• locateBiomeFunction
• placeFeatureFunction
• placeJigsawFunction
• placeStructureFunction
• playSoundFunction
• randomSampleFunction
• resetSequenceFunction
• resetSequenceFunction
• resetAllSequencesFunction
• resetAllSequencesAndSetNewDefaultsFunction
• setTickingRateFunction
• tickQueryFunction
• tickSprintFunction
• setTickFreezeFunction
• tickStepFunction
• tickStopSteppingFunction
• tickStopSprintingFunction
• getDurationFunction
• setClearFunction
• setRainFunction
• setThunderFunction
• setWorldBorderDamageBufferFunction
• setWorldBorderDamageAmountFunction
• setWorldBorderWarningTimeFunction
• setWorldBorderWarningDistanceFunction
• getWorldBorderSizeFunction
• setWorldBorderSizeFunction

KattonLevelMap

KattonLevelMapCommonClass

class KattonLevelMap( private val server: MinecraftServer ) : Map<ResourceKey<Level>, ServerLevel>

Map-like access to all server levels by ResourceKey.

KattonLevelMap.overworld

KattonLevelMap.overworldCommonProperty

val overworld: ServerLevel

Quick access to the Overworld level.

KattonLevelMap.nether

KattonLevelMap.netherCommonProperty

val nether: ServerLevel

Quick access to the Nether level.

KattonLevelMap.end

KattonLevelMap.endCommonProperty

val end: ServerLevel

Quick access to the End level.

levels

levelsCommonProperty

val levels: KattonLevelMap

Map-like access to all server levels.

players

playersCommonProperty

val ServerLevel.players: KattonLevelPlayerCollection

Access to players in a level.

blockEntities

blockEntitiesCommonProperty

val ServerLevel.blockEntities: KattonLevelBlockEntityCollection

Access to block entities in a level.

entities

entitiesCommonProperty

val ServerLevel.entities: KattonLevelEntityCollection

Access to entities in a level.

blocks

blocksCommonProperty

val Level.blocks: KattonLevelBlockCollection

Access to blocks in a level.

blockStates

blockStatesCommonProperty

val Level.blockStates: KattonLevelBlockStateCollection

Access to block states in a level.

setBlock

setBlockCommonFunction

fun setBlock(level: Level, pos: BlockPos, state: BlockState)

Set a block at position to a specific BlockState.

Parameters

Parameter	Description
level	level to modify
pos	block position
state	BlockState to set

setBlock

setBlockCommonFunction

fun setBlock(level: Level, pos: BlockPos, block: Block)

Set a block at position using a Block type's default state.

Parameters

Parameter	Description
level	level to modify
pos	block position
block	block type to set

fill

fillCommonFunction

fun fill(level: Level, start: BlockPos, end: BlockPos, state: BlockState)

Fill a region with a given BlockState.

Parameters

Parameter	Description
level	level to modify
start	start position (inclusive)
end	end position (inclusive)
state	BlockState to place

fill

fillCommonFunction

fun fill(level: Level, start: BlockPos, end: BlockPos, block: Block)

Fill a region with a given Block type using its default state.

Parameters

Parameter	Description
level	level to modify
start	start position (inclusive)
end	end position (inclusive)
block	block type to place

fillBiome

fillBiomeCommonFunction

fun fillBiome(level: Level, start: BlockPos, end: BlockPos, biome: Identifier, biomePredicate: (Holder<Biome>) -> Boolean)

Fill a region's biome using a predicate on biome holder.

Parameters

Parameter	Description
level	server-level to modify
start	start position
end	end position
biome	biome identifier to apply
biomePredicate	predicate to further filter biome application

locateStructure

locateStructureCommonFunction

fun locateStructure(structureKey: ResourceKey<Structure>, level: ServerLevel, startPos: BlockPos = BlockPos.ZERO): BlockPos?

Locate a structure by ResourceKey.

Parameters

Parameter	Description
structureKey	structure resource key
level	server level to search in
startPos	starting position for search

Returns

nearest BlockPos of the structure or null if not found

locateStructure

locateStructureCommonFunction

fun locateStructure(structureKey: TagKey<Structure>, level: ServerLevel, startPos: BlockPos = BlockPos.ZERO): BlockPos?

Locate a structure by TagKey.

Parameters

Parameter	Description
structureKey	structure tag key
level	server level to search in
startPos	starting position

Returns

nearest BlockPos or null if not found

locateBiome

locateBiomeCommonFunction

fun locateBiome(biomeKey: ResourceKey<Biome>, level: ServerLevel, startPos: BlockPos = BlockPos.ZERO): Pair<BlockPos, Holder<Biome>>?

Find closest biome by resource key.

Parameters

Parameter	Description
biomeKey	biome resource key
level	server level to search
startPos	starting position

Returns

Pair of BlockPos and biome Holder, or null if not found

locateBiome

locateBiomeCommonFunction

fun locateBiome(biomeKey: TagKey<Biome>, level: ServerLevel, startPos: BlockPos = BlockPos.ZERO): Pair<BlockPos, Holder<Biome>>?

Find closest biome by tag key.

Parameters

Parameter	Description
biomeKey	biome tag key
level	server level to search
startPos	starting position

Returns

Pair of BlockPos and biome Holder, or null if not found

placeFeature

placeFeatureCommonFunction

fun placeFeature(feature: Identifier, pos: BlockPos)

Place a configured feature at a position.

Parameters

Parameter	Description
feature	feature identifier
pos	position to place

placeJigsaw

placeJigsawCommonFunction

fun placeJigsaw(templatePool: Identifier, start: Identifier, depth: Int, pos: BlockPos)

Place a jigsaw structure from a template pool.

Parameters

Parameter	Description
templatePool	pool identifier
start	starting template identifier
depth	placement depth
pos	starting position

placeStructure

placeStructureCommonFunction

fun placeStructure(structure: Identifier, pos: BlockPos)

Place a structure by identifier at a position.

Parameters

Parameter	Description
structure	structure identifier
pos	position to place

playSound

playSoundCommonFunction

fun playSound(level: ServerLevel, players: Collection<ServerPlayer>, sound: Identifier, soundSource: SoundSource, pos: Vec3, volume: Float = 1.0f, pitch: Float = 1.0f, minVolume: Float = 0.0f)

Play a sound to a set of players, performing distance attenuation and minimum volume handling.

Parameters

Parameter	Description
level	server level
players	players to send sound to
sound	sound identifier
soundSource	sound category/source
pos	sound origin position
volume	base volume
pitch	playback pitch
minVolume	minimum audible volume when out of range

randomSample

randomSampleCommonFunction

fun randomSample(randomSequence: Identifier? = null, broadcast: Boolean = false, min: Int = Int.MIN_VALUE, max: Int = Int.MAX_VALUE): Int?

Sample a random integer in [min, max] using optional random sequence.

Parameters

Parameter	Description
randomSequence	optional identifier for random sequence
broadcast	whether to broadcast the result to players
min	inclusive minimum
max	inclusive maximum

Returns

sampled integer or null on invalid range

resetSequence

resetSequenceCommonFunction

fun resetSequence(level: ServerLevel, randomSequence: Identifier)

Reset a named random sequence for a level to its default seed.

Parameters

Parameter	Description
level	server level
randomSequence	sequence identifier

resetSequence

resetSequenceCommonFunction

fun resetSequence(level: ServerLevel, randomSequence: Identifier, seed: Int, includeWorldSeed: Boolean = true, includeSequenceID: Boolean = true)

Reset a named random sequence with a specific seed and behavior flags.

Parameters

Parameter	Description
level	server level
randomSequence	sequence identifier
seed	integer seed
includeWorldSeed	whether to include world seed
includeSequenceID	whether to include sequence id

resetAllSequences

resetAllSequencesCommonFunction

fun resetAllSequences(level: ServerLevel)

Clear all random sequences for a level.

Parameters

Parameter	Description
level	server level

resetAllSequencesAndSetNewDefaults

resetAllSequencesAndSetNewDefaultsCommonFunction

fun resetAllSequencesAndSetNewDefaults(level: ServerLevel, seed: Int, includeWorldSeed: Boolean = true, includeSequenceID: Boolean = true)

Reset all sequences and set new defaults.

Parameters

Parameter	Description
level	server level
seed	seed to set as default
includeWorldSeed	whether to include world seed
includeSequenceID	whether to include sequence id

setTickingRate

setTickingRateCommonFunction

fun setTickingRate(f: Float)

Set the server ticking rate.

Parameters

Parameter	Description
f	new tick rate (ticks per second)

tickQuery

tickQueryCommonFunction

fun tickQuery(): Float

Query current tickrate.

Returns

current tickrate value

tickSprint

tickSprintCommonFunction

fun tickSprint(i: Int)

Request the server to sprint tick advancement by given ticks.

Parameters

Parameter	Description
i	number of ticks to sprint

setTickFreeze

setTickFreezeCommonFunction

fun setTickFreeze(freeze: Boolean)

Freeze or unfreeze server tick processing.

Parameters

Parameter	Description
freeze	true to freeze, false to unfreeze

tickStep

tickStepCommonFunction

fun tickStep(i: Int)

Step the server forward a number of ticks while paused.

Parameters

Parameter	Description
i	number of ticks to step

tickStopStepping

tickStopSteppingCommonFunction

fun tickStopStepping(): Boolean

Stop stepping mode on the tick manager.

Returns

true if stepping was stopped

tickStopSprinting

tickStopSprintingCommonFunction

fun tickStopSprinting(): Boolean

Stop sprinting mode on the tick manager.

Returns

true if sprinting was stopped

getDuration

getDurationCommonFunction

fun getDuration(level: ServerLevel, i: Int, intProvider: IntProvider): Int

Resolve duration: if i == -1 use IntProvider sampled value; otherwise return i.

Parameters

Parameter	Description
i	provided duration (-1 means sample)
intProvider	provider to sample from

Returns

resolved duration

setClear

setClearCommonFunction

fun setClear(level: ServerLevel, i: Int)

Set clear weather for specified duration (or sample when -1).

Parameters

Parameter	Description
i	duration ticks or -1 to sample

setRain

setRainCommonFunction

fun setRain(level: ServerLevel, i: Int)

Set rain weather for specified duration (or sample when -1).

Parameters

Parameter	Description
i	duration ticks or -1 to sample

setThunder

setThunderCommonFunction

fun setThunder(level: ServerLevel, i: Int)

Set thunder weather for specified duration (or sample when -1).

Parameters

Parameter	Description
i	duration ticks or -1 to sample

setWorldBorderDamageBuffer

setWorldBorderDamageBufferCommonFunction

fun setWorldBorderDamageBuffer(level: ServerLevel, distance: Double)

Set world border safe-zone buffer.

Parameters

Parameter	Description
level	server level whose border to modify
distance	safe distance buffer

setWorldBorderDamageAmount

setWorldBorderDamageAmountCommonFunction

fun setWorldBorderDamageAmount(level: ServerLevel, damage: Double)

Set world border damage per block amount.

Parameters

Parameter	Description
level	server level
damage	damage per block

setWorldBorderWarningTime

setWorldBorderWarningTimeCommonFunction

fun setWorldBorderWarningTime(level: ServerLevel, time: Int)

Set world border warning time.

Parameters

Parameter	Description
level	server level
time	warning time in seconds

setWorldBorderWarningDistance

setWorldBorderWarningDistanceCommonFunction

fun setWorldBorderWarningDistance(level: ServerLevel, distance: Int)

Set world border warning distance in blocks.

Parameters

Parameter	Description
level	server level
distance	warning distance

getWorldBorderSize

getWorldBorderSizeCommonFunction

fun getWorldBorderSize(level: ServerLevel): Double

Get the current world border size.

Parameters

Parameter	Description
level	server level

Returns

world border size (double)

setWorldBorderSize

setWorldBorderSizeCommonFunction

fun setWorldBorderSize(level: ServerLevel, size: Double, time: Long = 0L)

Set world border size, optionally over time.

Parameters

Parameter	Description
level	server level
size	target border size
time	time in ticks to lerp to new size (0 for instant)