Class EntityTameableComponent`Beta`

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)

EntityComponent
- EntityTameableComponent

Index

Properties

entity getTameItems isTamed probability tamedToPlayer? tamedToPlayerId? typeId componentId

Methods

Properties

`Readonly` `Beta`entity

entity: Entity

Remarks

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

`Readonly` `Beta`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` `Beta`isTamed

isTamed: boolean

Throws

This property can throw when used.

`Readonly` `Beta`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` `Beta`tamedToPlayer

tamedToPlayer?: Player

Throws

This property can throw when used.

`Optional` `Readonly` `Beta`tamedToPlayerId

tamedToPlayerId?: string

Throws

This property can throw when used.

`Readonly` `Beta`typeId

typeId: string

Remarks

Identifier of the component.

`Static` `Readonly` `Beta`componentId

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

Methods

isValid

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