Class EntityTameableComponent

Rc

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

Hierarchy

Constructors

Properties

entity: Entity

Remarks

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

getTameItems: ItemStack[]

Remarks

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

Throws

This property can throw when used.

isTamed: boolean

Remarks

Returns true if the entity is tamed by player.

Throws

This property can throw when used.

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?: Player

Remarks

Returns the player that has tamed the entity, or 'undefined' if entity is not tamed.

Throws

This property can throw when used.

tamedToPlayerId?: string

Remarks

Returns the id of player that has tamed the entity, or 'undefined' if entity is not tamed.

Throws

This property can throw when used.

typeId: string

Remarks

Identifier of the component.

componentId: "minecraft:tameable" = 'minecraft:tameable'

Methods

  • 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.

  • Parameters

    • player: Player

      The player that this entity should be tamed by.

    Returns boolean

    Returns true if the entity was tamed.

    Remarks

    Set this entity as tamed by the given player.

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

    Throws

    This function can throw errors.