Class EntityTameMountComponent

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

Hierarchy (View Summary)

Constructors

constructor

Properties

entity isTamed isTamedToPlayer tamedToPlayer? tamedToPlayerId? typeId componentId

Methods

isValid tame tameToPlayer

Constructors

Privateconstructor

Properties

Readonlyentity

entity: Entity

Remarks

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

ReadonlyisTamed

isTamed: boolean

Remarks

Returns true if the entity is tamed.

Throws

This property can throw when used.

ReadonlyisTamedToPlayer

isTamedToPlayer: boolean

Remarks

Returns true if the entity is tamed by a player.

Throws

This property can throw when used.

Optional ReadonlytamedToPlayer

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 ReadonlytamedToPlayerId

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.

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.

    Deprecated

    This function is deprecated and will be removed in 2.0.0.

    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

    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.

Settings

Member Visibility

On This Page

Constructors
Properties
Methods