Class EntityLeashableComponentBeta

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

Hierarchy (View Summary)

Constructors

constructor

Properties

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

Methods

isValid leashTo unleash

Constructors

Privateconstructor

Properties

Readonly BetacanBeStolen

canBeStolen: boolean

Remarks

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

Throws

This property can throw when used.

Readonly Betaentity

entity: Entity

Remarks

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

Readonly BetahardDistance

hardDistance: number

Remarks

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

Throws

This property can throw when used.

Readonly BetaisLeashed

isLeashed: boolean

Remarks

Returns true if the entity is leashed.

Throws

This property can throw when used.

Optional Readonly BetaleashHolder

leashHolder?: Entity

Remarks

Entity that is holding the leash.

Throws

This property can throw when used.

Optional Readonly BetaleashHolderEntityId

leashHolderEntityId?: string

Remarks

Identifier of entity that is holding the leash.

Throws

This property can throw when used.

Readonly BetamaxDistance

maxDistance: number

Remarks

Distance in blocks at which the leash breaks.

Throws

This property can throw when used.

Readonly BetasoftDistance

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 BetatypeId

typeId: string

Remarks

Identifier of the component.

Static Readonly BetacomponentId

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

Methods

isValid

leashTo

unleash

Settings

Member Visibility

On This Page

Constructors
Properties
Methods