Class: EntityTameableComponent

Defines the rules for an entity to be tamed by the player.

Extends

• EntityComponent

Constructors

new EntityTameableComponent()

private new EntityTameableComponent(): EntityTameableComponent

Returns

EntityTameableComponent

Overrides

EntityComponent . constructor

Properties

entity

Beta

readonly entity: Entity

Remarks

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

Inherited from

EntityComponent . entity

---

getTameItems

readonly getTameItems: ItemStack[]

Remarks

Returns a set of items that can be used to tame this entity.

Throws

This property can throw when used.

---

isTamed

readonly isTamed: boolean

Throws

This property can throw when used.

---

probability

readonly probability: number

Remarks

The chance of taming the entity with each item use between 0.0 and 1.0, where 1.0 is 100%

Throws

This property can throw when used.

---

tamedToPlayer?

optional readonly tamedToPlayer: Player

Throws

This property can throw when used.

---

tamedToPlayerId?

optional readonly tamedToPlayerId: string

Throws

This property can throw when used.

---

typeId

readonly typeId: string

Remarks

Identifier of the component.

Inherited from

EntityComponent . typeId

---

componentId

static readonly componentId: "minecraft:tameable" = 'minecraft:tameable'

Methods

isValid()

isValid(): boolean

Returns

boolean

Whether the component is valid.

Inherited from

EntityComponent . isValid

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.

---

tame()

tame(player): boolean

Parameters

Parameter	Type
player	Player

Returns

boolean

Returns true if the entity was tamed.

Remarks

Tames this entity.

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

Throws

This function can throw errors.