Allows this entity to be leashed and defines the conditions and events for this entity when is leashed.

import { world } from "@minecraft/server";

const entity = world.getEntity("-10000000000");
const leashHolderEntity = world.getEntity("-10000000000");
const leashable = entity.getComponent("leashable");
leashable.softDistance;
leashable.leashTo(leashHolderEntity); // Assuming you have an 'leashHolderEntity' instance
leashable.unleash();
leashable.isValid();

Hierarchy (View Summary)

Properties

entity: Entity

The entity that owns this component. The entity will be undefined if it has been removed.

softDistance: number

Distance in blocks at which the 'spring' effect starts acting to keep this entity close to the entity that leashed it.

This property can throw when used.

typeId: string

Identifier of the component.

componentId: "minecraft:leashable" = 'minecraft:leashable'

Methods

  • Beta

    Returns boolean

    Whether the component is valid.

    Returns whether the component is valid. A component is considered valid if its owner is valid, in addition to any addition to any additional validation required by the component.

  • Beta

    Parameters

    • leashHolder: Entity

      The entity to leash this entity to.

    Returns void

    Leashes this entity to another entity.

    This function can't be called in read-only mode.

    This function can throw errors.

  • Beta

    Returns void

    Unleashes this entity if it is leashed to another entity.

    This function can't be called in read-only mode.

    This function can throw errors.