Common

KattonContextApi

top.katton.apicommon/src/main/kotlin/top/katton/api/KattonContextApi.kt

Determines which position the returned [ExecutionContext] uses.

Members

Jump directly to declarations on this page.

• BonePositionModeEnum Class
• BonePositionMode.BONEClass
• BonePositionMode.ENTITYClass
• BoneOrientationModeEnum Class
• BoneOrientationMode.BONEClass
• BoneOrientationMode.ENTITYClass
• BoneOrientationMode.WORLDClass
• computeBoneWorldPosFunction
• createBoneExecutionFunction

BonePositionMode

BonePositionModeCommonEnum Class

enum class BonePositionMode

Determines which position the returned [ExecutionContext] uses.

BonePositionMode.BONE

BonePositionMode.BONECommonClass

BONE,

Bone world-space position (entity position + bone offset, rotated by yaw).

BonePositionMode.ENTITY

BonePositionMode.ENTITYCommonClass

ENTITY

Entity world-space position (ignoring the bone).

BoneOrientationMode

BoneOrientationModeCommonEnum Class

enum class BoneOrientationMode

Determines which facing direction the returned [ExecutionContext] uses.

BoneOrientationMode.BONE

BoneOrientationMode.BONECommonClass

BONE,

Bone's local rotation + entity rotation (approximate world-space facing).

BoneOrientationMode.ENTITY

BoneOrientationMode.ENTITYCommonClass

ENTITY,

Entity's natural yaw/pitch.

BoneOrientationMode.WORLD

BoneOrientationMode.WORLDCommonClass

WORLD

Default — [Vec2.ZERO] (no rotation).

computeBoneWorldPos

computeBoneWorldPosCommonFunction

fun Entity.computeBoneWorldPos(bone: ModelPart, partialTick: Float = 1.0f): Vec3

Computes the world-space position of a [ModelPart] bone on the given [entity].

The bone offset (pixels, 1/16 block) is rotated by the entity's yaw and added to the entity's interpolated position.

Call AFTER animations have been applied ([net.minecraft.client.animation.KeyframeAnimation.apply]), so that [ModelPart.x]/[ModelPart.y]/[ModelPart.z] reflect the animated pose.

createBoneExecution

createBoneExecutionCommonFunction

fun Entity.createBoneExecution(modelPart: ModelPart, positionMode: BonePositionMode = BonePositionMode.BONE, orientationMode: BoneOrientationMode = BoneOrientationMode.WORLD): ExecutionContext

Creates an [ExecutionContext] positioned at a [ModelPart] bone on an [entity].

Combines [BonePositionMode] and [BoneOrientationMode] to set the context's pos and rotation. Use the returned [ExecutionContext] to execute commands at the bone's world position, or read pos / rotation directly for custom effects.

On a dedicated client (multiplayer), the server reference may be unavailable — in that case the returned context has position/rotation set but no command execution capability.

Parameters

Parameter	Description
modelPart	direct [ModelPart] reference (e.g. model.rightArm, model.head)
positionMode	[BonePositionMode.BONE] or [BonePositionMode.ENTITY]
orientationMode	[BoneOrientationMode.BONE], [BoneOrientationMode.ENTITY], or [BoneOrientationMode.WORLD]