Common

KattonEntityApi

common/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
• 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

nbtCommonProperty

var Entity.nbt: CompoundTag

Get/Set the NBT data of an Entity.

KattonServerEntityCollection

KattonServerEntityCollectionCommonClass

class KattonServerEntityCollection( private val server: MinecraftServer )

Collection of all entities across all server levels.

Properties

Property	Description
server	The MinecraftServer instance

KattonServerEntityCollection.all

KattonServerEntityCollection.allCommonProperty

val all

All entities across all levels.

KattonServerEntityCollection.get

KattonServerEntityCollection.getCommonFunction

operator fun get(level: ServerLevel): KattonLevelEntityCollection

Get entity collection for a specific level.

KattonServerEntityCollection.get

KattonServerEntityCollection.getCommonFunction

operator fun get(uuid: UUID): Entity?

Find an entity by UUID across all levels.

KattonLevelEntityCollection

KattonLevelEntityCollectionCommonClass

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

KattonLevelEntityCollection.getCommonFunction

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

KattonLevelEntityCollection.getCommonFunction

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

KattonLevelEntityCollection.getCommonFunction

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

Get entities using an entity selector.

KattonLevelEntityCollection.get

KattonLevelEntityCollection.getCommonFunction

operator fun get(uuid: UUID): Entity?

Find an entity by UUID in this level.

KattonEntityAttributeValueMap

KattonEntityAttributeValueMapCommonClass

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

KattonEntityAttributeValueMap.containsCommonFunction

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

Check if the entity has a given attribute.

KattonEntityAttributeValueMap.get

KattonEntityAttributeValueMap.getCommonFunction

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

Get the current value of an attribute.

KattonEntityAttributeValueMap.set

KattonEntityAttributeValueMap.setCommonFunction

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

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

attributeValues

attributeValuesCommonProperty

val LivingEntity.attributeValues

Access to a living entity's attribute values.

getAttribute

getAttributeCommonFunction

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

Get an attribute value from a LivingEntity.

Parameters

Parameter	Description
entity	the entity
attribute	holder of the attribute to read

Returns

attribute value

hasAttribute

hasAttributeCommonFunction

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

Check if a LivingEntity has a given attribute.

Parameters

Parameter	Description
entity	the entity
attribute	holder of the attribute to check

Returns

if attribute present

getBaseAttribute

getBaseAttributeCommonFunction

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

Get base attribute value from a LivingEntity.

Parameters

Parameter	Description
entity	the entity
attribute	holder of the attribute to check

Returns

base attribute value; null if attribute not present

setBaseAttribute

setBaseAttributeCommonFunction

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

if changed, false otherwise

addAttributeModify

addAttributeModifyCommonFunction

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

removeAttributeModifyCommonFunction

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

damageCommonFunction

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

damageCommonFunction

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

damageCommonFunction

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

damageCommonFunction

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

damageCommonFunction

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

addEffectCommonFunction

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

removeEffectCommonFunction

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

clearEffectsCommonFunction

fun clearEffects(entity: LivingEntity)

Clear all effects from a LivingEntity.

Parameters

Parameter	Description
entity	target entity

mount

mountCommonFunction

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

if mounting succeeded, false otherwise

dismount

dismountCommonFunction

fun dismount(passenger: Entity): Boolean

Dismount a passenger from its vehicle.

Parameters

Parameter	Description
passenger	entity to dismount

Returns

if dismounted, false if not riding

rotate

rotateCommonFunction

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

rotateCommonFunction

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

rotateCommonFunction

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 point on the target

spreadPlayers

spreadPlayersCommonFunction

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 used, y ignored)
spreadDistance	minimum distance between players
maxRange	max spread radius
maxHeight	maximum height difference
respectTeams	whether to keep teams together
targets	entities to spread

summon

summonCommonFunction

fun summon(level: ServerLevel, id: String, 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

Entity or null on failure

getTags

getTagsCommonFunction

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

Get tags attached to an entity.

Parameters

Parameter	Description
entity	target entity

Returns

tag string collection

addTag

addTagCommonFunction

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

Add a tag to an entity.

Parameters

Parameter	Description
entity	target entity
string	tag to add

Returns

if tag was added, false if already present

removeTag

removeTagCommonFunction

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

Remove a tag from an entity.

Parameters

Parameter	Description
entity	target entity
string	tag to remove

Returns

if the tag was removed