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

    Class EntityRideableComponentBeta

    When added, this component adds the capability that an entity can be ridden by another entity.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    controllingSeat crouchingSkipInteract interactText pullInEntities riderCanInteract seatCount typeId componentId

    Methods

    addRider ejectRider ejectRiders getFamilyTypes getRiders getSeats

    Constructors

    Properties

    controllingSeat: number

    Zero-based index of the seat that can used to control this entity.

    This property can throw when used.

    crouchingSkipInteract: boolean

    Determines whether interactions are not supported if the entity is crouching.

    This property can throw when used.

    interactText: string

    Set of text that should be displayed when a player is looking to ride on this entity (commonly with touch-screen controls).

    This property can throw when used.

    pullInEntities: boolean

    If true, this entity will pull in entities that are in the correct family_types into any available seat.

    This property can throw when used.

    riderCanInteract: boolean

    If true, this entity will be picked when looked at by the rider.

    This property can throw when used.

    seatCount: number

    Number of seats for riders defined for this entity.

    This property can throw when used.

    typeId: string
    componentId: "minecraft:rideable" = 'minecraft:rideable'

    Identifier of this component. Should always be minecraft:rideable.

    Methods

    • Beta

      Parameters

      • rider: Entity

        Entity that will become the rider of this entity.

      Returns boolean

      True if the rider entity was successfully added.

      Adds an entity to this entity as a rider.

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

      This function can throw errors.

    • Beta

      Parameters

      • rider: Entity

        Entity that should be ejected from this entity.

      Returns void

      Ejects the specified rider of this entity.

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

      This function can throw errors.

    • Beta

      Returns void

      Ejects all riders of this entity.

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

      This function can throw errors.

    • Beta

      Returns string[]

      A string-list of entity types that this entity can support as riders.

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

      This function can throw errors.

    • Beta

      Returns Entity[]

      Gets a list of the all the entities currently riding this entity.

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

      This function can throw errors.

    • Beta

      Returns Seat[]

      Gets a list of positions and number of riders for each position for entities riding this entity.

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

      This function can throw errors.

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods