Class EntityTameMountComponent

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

Hierarchy (View Summary)

Properties

entity isTamed isTamedToPlayer tamedToPlayer? tamedToPlayerId? typeId componentId

Methods

isValid tame tameToPlayer

Properties

Readonlyentity

entity: Entity

Remarks

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

Readonly BetaisTamed

isTamed: boolean

Throws

This property can throw when used.

Readonly BetaisTamedToPlayer

isTamedToPlayer: boolean

Throws

This property can throw when used.

Optional Readonly BetatamedToPlayer

tamedToPlayer?: Player

Throws

This property can throw when used.

Optional Readonly BetatamedToPlayerId

tamedToPlayerId?: string

Throws

This property can throw when used.

ReadonlytypeId

typeId: string

Remarks

Identifier of the component.

Static ReadonlycomponentId

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

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.

tame

  • tame(showParticles: boolean): void

  • 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.

tameToPlayer

  • tameToPlayer(showParticles: boolean, player: Player): boolean
  • Beta

    Parameters

    • showParticles: boolean
    • player: Player

    Returns boolean

    Remarks

    This function can't be called in read-only mode.

    Throws

    This function can throw errors.

Settings

Member Visibility

On This Page

Properties
Methods