@minecraft
    Preparing search index...

    Class EntityLeashableComponent

    Allows the entity to be leashed. Defines the conditions and events for when an entity is leashed.

    Hierarchy (View Summary)

    Index

    Properties

    canBeStolen entity hardDistance isLeashed isValid leashHolder? leashHolderEntityId? maxDistance softDistance typeId componentId

    Methods

    leashTo unleash

    Properties

    canBeStolen: boolean

    Returns true if another entity can 'steal' the leashed entity by attaching their own leash to it.

    This property can throw when used.

    entity: Entity

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

    This property can throw when used.

    InvalidEntityError

    hardDistance: number

    Distance in blocks at which the leash stiffens, restricting movement.

    This property can throw when used.

    isLeashed: boolean

    Returns true if the entity is leashed.

    This property can throw when used.

    isValid: boolean

    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.

    leashHolder?: Entity

    Entity that is holding the leash.

    This property can throw when used.

    leashHolderEntityId?: string

    Identifier of entity that is holding the leash.

    This property can throw when used.

    maxDistance: number

    Distance in blocks at which the leash breaks.

    This property can throw when used.

    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

    • World mutation

      Parameters

      • leashHolder: Entity

        The entity to leash this entity to.

      Returns void

      Leashes this entity to another entity.

      Throws if the entity to leash to is over the max distance, and if the player is dead or in spectator mode.

    • World mutation

      Returns void

      Unleashes this entity if it is leashed to another entity.

      This function can throw errors.

    Settings

    Member Visibility

    On This Page

    Properties
    Methods