Class EntityLeashableComponentBeta

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

Hierarchy

Constructors

constructor

Properties

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

Methods

isValid leashTo unleash

Constructors

Private constructor

Properties

Readonly canBeStolen

canBeStolen: boolean

Throws

This property can throw when used.

Readonly entity

entity: Entity

Remarks

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

Readonly hardDistance

hardDistance: number

Throws

This property can throw when used.

Readonly isLeashed

isLeashed: boolean

Throws

This property can throw when used.

Optional Readonly leashHolder

leashHolder?: Entity

Throws

This property can throw when used.

Optional Readonly leashHolderEntityId

leashHolderEntityId?: string

Throws

This property can throw when used.

Readonly maxDistance

maxDistance: number

Throws

This property can throw when used.

Readonly softDistance

softDistance: number

Remarks

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

Throws

This property can throw when used.

Readonly typeId

typeId: string

Remarks

Identifier of the component.

Static Readonly componentId

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

Methods

isValid

  • Returns boolean

    Whether the component is valid.

    Remarks

    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.

leashTo

  • Parameters

    Returns void

    Remarks

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

    Throws

    This function can throw errors.

unleash

  • Returns void

    Remarks

    Unleashes this entity if it is leashed to another entity.

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

    Throws

    This function can throw errors.

Settings

Member Visibility

Theme

On This Page