Common

KattonEntityApi

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

Get/Set the NBT data of an Entity.

Members

Jump directly to declarations on this page.

• nbtProperty
• EntityEventObject
• EntityEvent.EntityOnTickEventClass
• EntityEvent.onTickProperty
• EntityEvent.beginReloadFunction
• EntityEvent.rebindLoadedEntitiesFunction
• KattonServerEntityCollectionClass
• KattonServerEntityCollection.allProperty
• KattonServerEntityCollection.getFunction
• KattonServerEntityCollection.getFunction
• KattonLevelEntityCollectionClass
• KattonLevelEntityCollection.getFunction
• KattonLevelEntityCollection.getFunction
• KattonLevelEntityCollection.getFunction
• KattonLevelEntityCollection.getFunction
• KattonEntityAttributeValueMapClass
• KattonEntityAttributeValueMap.containsFunction
• KattonEntityAttributeValueMap.getFunction
• KattonEntityAttributeValueMap.setFunction
• attributeValuesProperty
• getAttributeFunction
• hasAttributeFunction
• getBaseAttributeFunction
• setBaseAttributeFunction
• addAttributeModifyFunction
• removeAttributeModifyFunction
• damageFunction
• damageFunction
• damageFunction
• damageFunction
• damageFunction
• addEffectFunction
• removeEffectFunction
• clearEffectsFunction
• mountFunction
• dismountFunction
• rotateFunction
• rotateFunction
• rotateFunction
• spreadPlayersFunction
• summonFunction
• getTagsFunction
• addTagFunction
• removeTagFunction

nbt

CommonProperty

var Entity.nbt: CompoundTag

Get/Set the NBT data of an Entity.

EntityEvent

CommonObject

object EntityEvent

Event handlers for entity lifecycle events.

EntityEvent.EntityOnTickEvent

CommonClass

class EntityOnTickEvent(entity: Entity): ContextEvent<Entity, Entity.(level: Level)-> Unit>(entity, onTickHandlers)

Context event for entity tick operations.

EntityEvent.onTick

CommonProperty

val Entity.onTick: EntityOnTickEvent

Register a tick event for this entity.

EntityEvent.beginReload

CommonFunction

fun beginReload()

Clear all script-owned entity handlers before scripts are reloaded.

EntityEvent.rebindLoadedEntities

CommonFunction

fun rebindLoadedEntities(server: MinecraftServer)

Re-apply handlers for entities that are already loaded.

This makes behavior changes effective immediately after reload, without requiring entities to be reloaded from chunks.

KattonServerEntityCollection

CommonClass

class KattonServerEntityCollection( private val server: MinecraftServer )

Collection of all entities across all server levels.

Properties

Property	Description
server	The MinecraftServer instance

KattonServerEntityCollection.all

CommonProperty

val all

All entities across all levels.

KattonServerEntityCollection.get

CommonFunction

operator fun get(level: ServerLevel): KattonLevelEntityCollection

Get entity collection for a specific level.

KattonServerEntityCollection.get

CommonFunction

operator fun get(uuid: UUID): Entity?

Find an entity by UUID across all levels.

KattonLevelEntityCollection

CommonClass

class KattonLevelEntityCollection( val level: ServerLevel ) : Iterable<Entity> by level.allEntities

Collection of entities within a specific level.

Properties

Property	Description
level	The ServerLevel containing the entities

KattonLevelEntityCollection.get

CommonFunction

operator fun <T : Entity> get(entityTypeTest: EntityTypeTest<Entity, T>, predicate: (T) -> Boolean = { true }): List<T>

Get entities matching a type test and predicate.

KattonLevelEntityCollection.get

CommonFunction

operator fun <T : Entity> get(entityTypeTest: EntityTypeTest<Entity, T>, aabb: AABB, predicate: (T) -> Boolean = { true }): List<T>

Get entities within an AABB matching a type test and predicate.

KattonLevelEntityCollection.get

CommonFunction

operator fun get(selector: EntitySelector): List<Entity>

Get entities using an entity selector.

KattonLevelEntityCollection.get

CommonFunction

operator fun get(uuid: UUID): Entity?

Find an entity by UUID in this level.

KattonEntityAttributeValueMap

CommonClass

class KattonEntityAttributeValueMap( val entity: LivingEntity )

Map-like access to a living entity's attribute values.

Properties

Property	Description
entity	The LivingEntity whose attributes are being accessed

KattonEntityAttributeValueMap.contains

CommonFunction

fun contains(holder: Holder<Attribute>): Boolean

Check if the entity has a given attribute.

KattonEntityAttributeValueMap.get

CommonFunction

operator fun get(holder: Holder<Attribute>): Double?

Get the current value of an attribute.

KattonEntityAttributeValueMap.set

CommonFunction

fun set(holder: Holder<Attribute>, value: Double, vararg modifiers: AttributeModifier)

Set the base value of an attribute and optionally add modifiers.

attributeValues

CommonProperty

val LivingEntity.attributeValues

Access to a living entity's attribute values.

getAttribute

CommonFunction

fun getAttribute(entity: LivingEntity, attribute: Holder<Attribute>): Double

Get an attribute value from a LivingEntity.

Parameters

Parameter	Description
entity	the entity
attribute	attribute holder to read

Returns

current attribute value

hasAttribute

CommonFunction

fun hasAttribute(entity: LivingEntity, attribute: Holder<Attribute>): Boolean

Check if a LivingEntity has a given attribute.

Parameters

Parameter	Description
entity	the entity
attribute	attribute holder to check

Returns

true if attribute present

getBaseAttribute

CommonFunction

fun getBaseAttribute(entity: LivingEntity, attribute: Holder<Attribute>): Double?

Get base attribute value from a LivingEntity.

Parameters

Parameter	Description
entity	the entity
attribute	attribute holder to read

Returns

base value or null if attribute missing

setBaseAttribute

CommonFunction

fun setBaseAttribute(entity: LivingEntity, attribute: Holder<Attribute>, value: Double): Boolean

Set the base attribute value for a LivingEntity.

Parameters

Parameter	Description
entity	the entity
attribute	attribute holder to set
value	new base value

Returns

true if changed, false otherwise

addAttributeModify

CommonFunction

fun addAttributeModify(entity: LivingEntity, attribute: Holder<Attribute>, modifier: AttributeModifier)

Add a transient attribute modifier to an entity.

Parameters

Parameter	Description
entity	the entity
attribute	attribute holder to modify
modifier	AttributeModifier to add

removeAttributeModify

CommonFunction

fun removeAttributeModify(entity: LivingEntity, attribute: Holder<Attribute>, modifier: AttributeModifier)

Remove an attribute modifier from an entity.

Parameters

Parameter	Description
entity	the entity
attribute	attribute holder to modify
modifier	AttributeModifier to remove

damage

CommonFunction

fun damage(entity: Entity, amount: Float)

Damage an entity by an amount using generic damage.

Parameters

Parameter	Description
entity	target entity
amount	damage amount

damage

CommonFunction

fun damage(target: Entity, amount: Float, attacker: Entity, damageType: ResourceKey<DamageType> = DamageTypes.GENERIC)

Damage a target entity from an attacker using a damage type key.

Parameters

Parameter	Description
target	the entity to damage
amount	damage amount
attacker	the source entity causing damage
damageType	resource key of the DamageType (default GENERIC)

damage

CommonFunction

fun damage(target: Entity, amount: Float, attacker: Entity, damageType: DamageType)

Damage a target entity from an attacker using a DamageType instance.

Parameters

Parameter	Description
target	the entity to damage
amount	damage amount
attacker	the source entity causing damage
damageType	DamageType instance to apply

damage

CommonFunction

fun damage(target: Entity, amount: Float, pos: Vec3, damageType: ResourceKey<DamageType> = DamageTypes.GENERIC)

Damage a target entity from a position using a damage type key.

Parameters

Parameter	Description
target	entity to damage
amount	damage amount
pos	position of damage source
damageType	resource key of the DamageType (default GENERIC)

damage

CommonFunction

fun damage(target: Entity, amount: Float, pos: Vec3, damageType: DamageType)

Damage a target entity from a position using a DamageType instance.

Parameters

Parameter	Description
target	entity to damage
amount	damage amount
pos	position of damage source
damageType	DamageType instance to apply

addEffect

CommonFunction

fun addEffect(entity: LivingEntity, effect: Holder<MobEffect>, duration: Int = 600, amplifier: Int = 0, showParticles: Boolean = true, ambient: Boolean = false)

Add a mob effect to a LivingEntity.

Parameters

Parameter	Description
entity	target entity
effect	holder of the MobEffect to apply
duration	effect duration in ticks (default 600)
amplifier	effect amplifier level (default 0)
showParticles	whether to show particles
ambient	whether effect is ambient

removeEffect

CommonFunction

fun removeEffect(entity: LivingEntity, effect: Holder<MobEffect>)

Remove a specific effect from a LivingEntity.

Parameters

Parameter	Description
entity	target entity
effect	holder of the MobEffect to remove

clearEffects

CommonFunction

fun clearEffects(entity: LivingEntity)

Clear all effects from a LivingEntity.

Parameters

Parameter	Description
entity	target entity

mount

CommonFunction

fun mount(passenger: Entity, vehicle: Entity): Boolean

Mount a passenger on a vehicle entity.

Parameters

Parameter	Description
passenger	entity to mount
vehicle	entity to be ridden

Returns

true if mounting succeeded, false otherwise

dismount

CommonFunction

fun dismount(passenger: Entity): Boolean

Dismount a passenger from its vehicle.

Parameters

Parameter	Description
passenger	entity to dismount

Returns

true if dismounted, false if not riding

rotate

CommonFunction

fun rotate(target: Entity, rot: Vec2, relative: Boolean = false)

Rotate an entity by a Vec2 (pitch, yaw).

Parameters

Parameter	Description
target	target entity
rot	rotation vector (x=pitch, y=yaw)
relative	whether rotation is relative

rotate

CommonFunction

fun rotate(target: Entity, lookAt: Entity, targetAnchor: EntityAnchorArgument.Anchor = EntityAnchorArgument.Anchor.FEET, lookAtAnchor: EntityAnchorArgument.Anchor = EntityAnchorArgument.Anchor.FEET)

Rotate an entity to look at another entity.

Parameters

Parameter	Description
target	entity to rotate
lookAt	entity to look at
targetAnchor	anchor point on the target
lookAtAnchor	anchor point on lookAt entity

rotate

CommonFunction

fun rotate(target: Entity, lookAt: Vec3, targetAnchor: EntityAnchorArgument.Anchor = EntityAnchorArgument.Anchor.FEET, lookAtAnchor: EntityAnchorArgument.Anchor = EntityAnchorArgument.Anchor.FEET)

Rotate an entity to look at a position.

Parameters

Parameter	Description
target	entity to rotate
lookAt	position to look at
targetAnchor	anchor on target entity

spreadPlayers

CommonFunction

fun spreadPlayers(level: ServerLevel, center: Vec2, spreadDistance: Float, maxRange: Float, maxHeight: Int, respectTeams: Boolean, targets: Collection<Entity>)

Spread players around a center point.

Parameters

Parameter	Description
level	server level used for context
center	center position vector (x=z, y ignored)
spreadDistance	minimum distance between players
maxRange	max spread radius
maxHeight	maximum height difference
respectTeams	whether to keep teams together
targets	collection of entities to spread

summon

CommonFunction

fun summon(level: ServerLevel, reference: Holder.Reference<EntityType<*>>, vec3: Vec3, entityData: CompoundTag? = null): Entity?

Summon an entity of a given type at a position with optional NBT.

Parameters

Parameter	Description
level	server level to spawn in
reference	reference to the EntityType to summon
vec3	spawn position
entityData	optional NBT override for the entity

Returns

spawned Entity or null on failure

getTags

CommonFunction

fun getTags(entity: Entity): MutableCollection<String>

Get tags attached to an entity.

Parameters

Parameter	Description
entity	target entity

Returns

mutable collection of tag strings

addTag

CommonFunction

fun addTag(entity: Entity, string: String): Boolean

Add a tag to an entity.

Parameters

Parameter	Description
entity	target entity
string	tag to add

Returns

true if tag was added, false if already present

removeTag

CommonFunction

fun removeTag(entity: Entity, string: String): Boolean

Remove a tag from an entity.

Parameters

Parameter	Description
entity	target entity
string	tag to remove

Returns

true if the tag was removed