Contains additional options for teleporting an entity.

interface TeleportOptions {
    checkForBlocks?: boolean;
    dimension?: Dimension;
    facingLocation?: Vector3;
    keepVelocity?: boolean;
    rotation?: Vector2;
}

Properties

checkForBlocks?: boolean

Whether to check whether blocks will block the entity after teleport.

dimension?: Dimension

Dimension to potentially move the entity to. If not specified, the entity is teleported within the dimension that they reside.

facingLocation?: Vector3

Location that the entity should be facing after teleport.

keepVelocity?: boolean

Whether to retain the entities velocity after teleport.

rotation?: Vector2

Rotation of the entity after teleport.