Script API - v1.21.120
    Preparing search index...

    Class EntityTameMountComponent

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

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    entity isTamed isTamedToPlayer isValid tamedToPlayer? tamedToPlayerId? typeId componentId

    Methods

    tame tameToPlayer

    Constructors

    Properties

    entity: Entity

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

    This property can throw when used.

    InvalidEntityError

    This property can't be read in early-execution mode.

    isTamed: boolean

    Returns true if the entity is tamed.

    This property can throw when used.

    This property can't be read in early-execution mode.

    isTamedToPlayer: boolean

    Returns true if the entity is tamed by a player.

    This property can throw when used.

    This property can't be read in early-execution mode.

    isValid: boolean

    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.

    This property can't be read in early-execution mode.

    tamedToPlayer?: Player

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

    This property can throw when used.

    This property can't be read in early-execution mode.

    tamedToPlayerId?: string

    Returns the id of player that has tamed the entity, or 'undefined' if entity is not tamed.

    This property can throw when used.

    This property can't be read in early-execution mode.

    typeId: string

    Identifier of the component.

    This property can't be read in early-execution mode.

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

    Methods

    • Parameters

      • showParticles: boolean

        Whether to show effect particles when this entity is tamed.

      Returns void

      Sets this rideable entity as tamed.

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

      This function can throw errors.

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

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

      Sets this rideable entity as tamed by the given player.

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

      This function can throw errors.

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

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods