Class EntityTameMountComponent`Beta`

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

Hierarchy (View Summary)

EntityComponent
- EntityTameMountComponent

Index

Constructors

`Private`constructor

new EntityTameMountComponent(): EntityTameMountComponent
Beta
Returns EntityTameMountComponent
Overrides EntityComponent.constructor
- Defined in ../../../../AppData/Roaming/.minecraft_bedrock/installations/Main Release/packageData/development_behavior_packs/DebugSticksAndScreens/node_modules/@minecraft/server/index.d.ts:10901

Properties

`Readonly` `Beta`entity

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

`Readonly` `Beta`isTamed

isTamed: boolean

Remarks

Returns true if the entity is tamed.

Throws

This property can throw when used.

`Readonly` `Beta`isTamedToPlayer

isTamedToPlayer: boolean

Remarks

Returns true if the entity is tamed by a player.

Throws

This property can throw when used.

`Readonly` `Beta`isValid

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.

`Optional` `Readonly` `Beta`tamedToPlayer

tamedToPlayer?: Player

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.

`Optional` `Readonly` `Beta`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` `Beta`typeId

typeId: string

Remarks

Identifier of the component.

`Static` `Readonly` `Beta`componentId

componentId: "minecraft:tamemount" = 'minecraft:tamemount'

Methods

tame

tame(showParticles: boolean): void
Beta
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 read-only mode.

Throws
This function can throw errors.
- Defined in ../../../../AppData/Roaming/.minecraft_bedrock/installations/Main Release/packageData/development_behavior_packs/DebugSticksAndScreens/node_modules/@minecraft/server/index.d.ts:10943

tameToPlayer

tameToPlayer(showParticles: boolean, player: Player): boolean
Beta
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 read-only mode.

Throws
This function can throw errors.
- Defined in ../../../../AppData/Roaming/.minecraft_bedrock/installations/Main Release/packageData/development_behavior_packs/DebugSticksAndScreens/node_modules/@minecraft/server/index.d.ts:10958

Class EntityTameMountComponentBeta

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

Privateconstructor

Returns EntityTameMountComponent

Properties

Readonly Betaentity

Remarks

Throws

Readonly BetaisTamed

Remarks

Throws

Readonly BetaisTamedToPlayer

Remarks

Throws

Readonly BetaisValid

Remarks

Optional Readonly BetatamedToPlayer

Remarks

Throws

Optional Readonly BetatamedToPlayerId

Remarks

Throws

Readonly BetatypeId

Remarks

Static Readonly BetacomponentId

Methods

tame

Parameters

Returns void

Remarks

Throws

tameToPlayer

Parameters

Returns boolean

Remarks

Throws

Settings

On This Page

Class EntityTameMountComponent`Beta`

`Private`constructor

`Readonly` `Beta`entity

`Readonly` `Beta`isTamed

`Readonly` `Beta`isTamedToPlayer

`Readonly` `Beta`isValid

`Optional` `Readonly` `Beta`tamedToPlayer

`Optional` `Readonly` `Beta`tamedToPlayerId

`Readonly` `Beta`typeId

`Static` `Readonly` `Beta`componentId