Class EntityTameableComponent

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

Example: wolfTameProbability.js

import { world } from "@minecraft/server";

const wolf = world
    .getDimension("overworld")
    .spawnEntity("minecraft:wolf", { x: 0, y: 0, z: 0 });
const tameable = wolf.getComponent("tameable");
tameable.probability;
tameable.tame(world.getAllPlayers()[0]);

Hierarchy (View Summary)

Constructors

constructor

Properties

entity getTameItems isTamed isValid probability tamedToPlayer? tamedToPlayerId? typeId componentId

Methods

tame

Constructors

Privateconstructor

Properties

Readonlyentity

entity: Entity

Remarks

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

Throws

This property can throw when used.

InvalidEntityError

ReadonlygetTameItems

getTameItems: ItemStack[]

Remarks

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

Throws

This property can throw when used.

ReadonlyisTamed

isTamed: boolean

Remarks

Returns true if the entity is tamed by player.

Throws

This property can throw when used.

Readonly BetaisValid

isValid: boolean

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.

Readonlyprobability

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 ReadonlytamedToPlayer

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.

Optional ReadonlytamedToPlayerId

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.

ReadonlytypeId

typeId: string

Remarks

Identifier of the component.

Static ReadonlycomponentId

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

Methods

tame

  • tame(player: Player): boolean

    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.

Settings

Member Visibility

On This Page

Constructors
Properties
Methods