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

EntityComponent
- EntityTameableComponent

Index

Constructors

Properties

entity getTameItems isTamed probability tamedToPlayer? tamedToPlayerId? typeId componentId

Methods

Constructors

`Private` constructor

new EntityTameableComponent(): EntityTameableComponent
Returns EntityTameableComponent

Overrides EntityComponent.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

Remarks

Returns true if the entity is tamed by player.

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

Remarks

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

Throws

This property can throw when used.

`Optional` `Readonly` tamedToPlayerId

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.

`Readonly` typeId

typeId: string

Remarks

Identifier of the component.

`Static` `Readonly` componentId

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

Methods

isValid

isValid(): boolean
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.

Inherited from EntityComponent.isValid

tame

tame(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.