TransformComponent

The TransformComponent stores an entity's position and rotation in the world.

API Reference

See full API: TransformComponent

Concepts

Before reading this, familiarize yourself with Components.

Overview

Property	Value
Class	com.hypixel.hytale.server.core.modules.entity.component.TransformComponent
Component Type	TransformComponent.getComponentType()

Getting the Component

// From Ref
TransformComponent transform = (TransformComponent)
    commandBuffer.getComponent(ref, TransformComponent.getComponentType());

// From ArchetypeChunk
TransformComponent transform = (TransformComponent)
    chunk.getComponent(index, TransformComponent.getComponentType());

Position[^1]

// Get position
Vector3d position = transform.getPosition();

double x = position.getX();
double y = position.getY();
double z = position.getZ();

WARNING

Do not use setPosition() to teleport entities - it won't work correctly. Use the Teleport component instead (see Teleporting Entities below).

Rotation

// Get rotation
Vector3f rotation = transform.getRotation();

float yaw = rotation.getYaw();     // Horizontal rotation
float pitch = rotation.getPitch(); // Vertical rotation
float roll = rotation.getRoll();   // Roll (usually 0)

// Set rotation
transform.setRotation(new Vector3f(yaw, pitch, 0));

Example: Get Player Location

public void onEntityAdded(@Nonnull Ref<EntityStore> ref, @Nonnull AddReason reason,
                           @Nonnull Store store, @Nonnull CommandBuffer commandBuffer) {

    Player player = (Player) commandBuffer.getComponent(ref, Player.getComponentType());
    TransformComponent transform = (TransformComponent)
        commandBuffer.getComponent(ref, TransformComponent.getComponentType());

    if (transform != null) {
        Vector3d pos = transform.getPosition();
        System.out.println("Player at: " + pos.getX() + ", " + pos.getY() + ", " + pos.getZ());
    }
}

Teleporting Entities[^2]

To teleport an entity, add a Teleport component. This is how the built-in teleport commands work:

public void teleportEntity(Ref<EntityStore> ref, Store store,
                            double x, double y, double z, float yaw, float pitch) {

    // Get current rotation for values we want to preserve
    TransformComponent transform = (TransformComponent)
        store.getComponent(ref, TransformComponent.getComponentType());
    Vector3f previousBodyRotation = transform.getRotation();

    // Create teleport with position and body rotation
    Teleport teleport = new Teleport(
        new Vector3d(x, y, z),
        new Vector3f(previousBodyRotation.getPitch(), yaw, previousBodyRotation.getRoll())
    ).withHeadRotation(new Vector3f(pitch, yaw, 0));

    // Add the component to trigger the teleport
    store.addComponent(ref, Teleport.getComponentType(), teleport);
}

TIP

The Teleport component is consumed by the engine - you add it, and the teleport happens. You don't need to remove it afterward.

Example: Calculate Distance

public double getDistance(Ref<EntityStore> ref1, Ref<EntityStore> ref2,
                           CommandBuffer commandBuffer) {

    TransformComponent t1 = (TransformComponent)
        commandBuffer.getComponent(ref1, TransformComponent.getComponentType());
    TransformComponent t2 = (TransformComponent)
        commandBuffer.getComponent(ref2, TransformComponent.getComponentType());

    if (t1 == null || t2 == null) return -1;

    Vector3d p1 = t1.getPosition();
    Vector3d p2 = t2.getPosition();

    double dx = p1.getX() - p2.getX();
    double dy = p1.getY() - p2.getY();
    double dz = p1.getZ() - p2.getZ();

    return Math.sqrt(dx*dx + dy*dy + dz*dz);
}

Related Components

Component	Description
Teleport	Add this component to teleport an entity
HeadRotation	Head direction (separate from body)
Velocity	Movement velocity

// Head rotation (for looking direction)
HeadRotation headRotation = (HeadRotation)
    commandBuffer.getComponent(ref, HeadRotation.getComponentType());
Vector3f headDir = headRotation.getRotation();

// Velocity
Velocity velocity = (Velocity)
    commandBuffer.getComponent(ref, Velocity.getComponentType());
Vector3d vel = velocity.getVelocity();

See Also

• Components Concept - How components work
• Player Component - Player data

[^1]: See TransformComponent API for getPosition(), getRotation(), and other position/rotation methods

[^2]: The Teleport component is in com.hypixel.hytale.server.core.modules.entity.component.Teleport