Skip to content

@minecraft/server


@minecraft/server / EntityTameMountComponent

Class: EntityTameMountComponent ​

Defined in: @minecraft/server/index.d.ts:12565

Contains options for taming a rideable entity based on the entity that mounts it.

Extends ​

Properties ​

entity ​

readonly entity: Entity

Defined in: @minecraft/server/index.d.ts:9981

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

Inherited from ​

EntityComponent.entity


isTamed ​

readonly isTamed: boolean

Defined in: @minecraft/server/index.d.ts:12573

Remarks ​

Returns true if the entity is tamed.

Throws ​

This property can throw when used.


isTamedToPlayer ​

readonly isTamedToPlayer: boolean

Defined in: @minecraft/server/index.d.ts:12580

Remarks ​

Returns true if the entity is tamed by a player.

Throws ​

This property can throw when used.


isValid ​

readonly isValid: boolean

Defined in: @minecraft/server/index.d.ts:6234

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


tamedToPlayer? ​

readonly optional tamedToPlayer?: Player

Defined in: @minecraft/server/index.d.ts:12588

Remarks ​

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

Throws ​

This property can throw when used.


tamedToPlayerId? ​

readonly optional tamedToPlayerId?: string

Defined in: @minecraft/server/index.d.ts:12596

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 ​

readonly typeId: string

Defined in: @minecraft/server/index.d.ts:6240

Remarks ​

Identifier of the component.

Inherited from ​

EntityComponent.typeId


componentId ​

readonly static componentId: "minecraft:tamemount" = 'minecraft:tamemount'

Defined in: @minecraft/server/index.d.ts:12597

Methods ​

tame() ​

tame(showParticles): void

Defined in: @minecraft/server/index.d.ts:12608

Parameters ​

showParticles ​

boolean

Whether to show effect particles when this entity is tamed.

Returns ​

void

Remarks ​

Sets this rideable entity as tamed.

This function can't be called in restricted-execution mode.

Throws ​

This function can throw errors.


tameToPlayer() ​

tameToPlayer(showParticles, player): boolean

Defined in: @minecraft/server/index.d.ts:12623

Parameters ​

showParticles ​

boolean

Whether to show effect particles when this entity is tamed.

player ​

Player

The player that this entity should be tamed by.

Returns ​

boolean

Returns true if the entity was tamed.

Remarks ​

Sets this rideable entity as tamed by the given player.

This function can't be called in restricted-execution mode.

Throws ​

This function can throw errors.