TeleportOptions Interface

Contains additional options for teleporting an entity.

Examples

teleportMovement.ts

import { world, system } from '@minecraft/server';

const overworld = world.getDimension('overworld');
const targetLocation = { x: 0, y: 0, z: 0 };

const pig = overworld.spawnEntity('minecraft:pig', targetLocation);

let inc = 1;
const runId = system.runInterval(() => {
    pig.teleport(
        { x: targetLocation.x + inc / 4, y: targetLocation.y + inc / 4, z: targetLocation.z + inc / 4 },
        {
            facingLocation: targetLocation,
        },
    );

    if (inc > 100) {
        system.clearRun(runId);
    }
    inc++;
}, 4);

Properties

checkForBlocks

checkForBlocks?: boolean;

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

Type: boolean

dimension

dimension?: Dimension;

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

Type: Dimension

facingLocation

facingLocation?: Vector3;

Location that the entity should be facing after teleport.

Type: Vector3

keepVelocity

keepVelocity?: boolean;

Whether to retain the entities velocity after teleport.

Type: boolean

rotation

rotation?: Vector2;

Rotation of the entity after teleport.

Type: Vector2

Examples

teleportMovement.ts

import { world, system } from '@minecraft/server';

const overworld = world.getDimension('overworld');
const targetLocation = { x: 0, y: 0, z: 0 };

const pig = overworld.spawnEntity('minecraft:pig', targetLocation);

let inc = 1;
const runId = system.runInterval(() => {
    pig.teleport(
        { x: targetLocation.x + inc / 4, y: targetLocation.y + inc / 4, z: targetLocation.z + inc / 4 },
        {
            facingLocation: targetLocation,
        },
    );

    if (inc > 100) {
        system.clearRun(runId);
    }
    inc++;
}, 4);