Class EntityTameableComponentBeta

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

Hierarchy

Constructors

constructor

Properties

entity getTameItems isTamed probability tamedToPlayer? tamedToPlayerId? typeId componentId

Methods

isValid tame

Constructors

Private constructor

Properties

Readonly entity

entity: Entity

Remarks

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

Readonly getTameItems

getTameItems: ItemStack[]

Remarks

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

Throws

This property can throw when used.

Readonly isTamed

isTamed: boolean

Throws

This property can throw when used.

Readonly probability

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.

Optional Readonly tamedToPlayer

tamedToPlayer?: Player

Throws

This property can throw when used.

Optional Readonly tamedToPlayerId

tamedToPlayerId?: string

Throws

This property can throw when used.

Readonly typeId

typeId: string

Remarks

Identifier of the component.

Static Readonly componentId

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

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.

tame

  • Parameters

    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.

Settings

Member Visibility

Theme

On This Page