Class EntityRideableComponentBeta

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

Hierarchy

Constructors

constructor

Properties

controllingSeat crouchingSkipInteract interactText pullInEntities riderCanInteract seatCount typeId componentId

Methods

addRider ejectRider ejectRiders getFamilyTypes getRiders getSeats

Constructors

Protected constructor

Properties

Readonly controllingSeat

controllingSeat: number

Remarks

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

Throws

This property can throw when used.

Readonly crouchingSkipInteract

crouchingSkipInteract: boolean

Remarks

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

Throws

This property can throw when used.

Readonly interactText

interactText: string

Remarks

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

Throws

This property can throw when used.

Readonly pullInEntities

pullInEntities: boolean

Remarks

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

Throws

This property can throw when used.

Readonly riderCanInteract

riderCanInteract: boolean

Remarks

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

Throws

This property can throw when used.

Readonly seatCount

seatCount: number

Remarks

Number of seats for riders defined for this entity.

Throws

This property can throw when used.

Readonly typeId

typeId: string

Static Readonly componentId

componentId: "minecraft:rideable" = 'minecraft:rideable'

Remarks

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

Methods

addRider

  • Parameters

    • rider: Entity

      Entity that will become the rider of this entity.

    Returns boolean

    True if the rider entity was successfully added.

    Remarks

    Adds an entity to this entity as a rider.

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

    Throws

    This function can throw errors.

ejectRider

  • Parameters

    • rider: Entity

      Entity that should be ejected from this entity.

    Returns void

    Remarks

    Ejects the specified rider of this entity.

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

    Throws

    This function can throw errors.

ejectRiders

  • Returns void

    Remarks

    Ejects all riders of this entity.

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

    Throws

    This function can throw errors.

getFamilyTypes

  • Returns string[]

    Remarks

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

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

    Throws

    This function can throw errors.

getRiders

  • Returns Entity[]

    Remarks

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

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

    Throws

    This function can throw errors.

getSeats

  • Returns Seat[]

    Remarks

    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.

    Throws

    This function can throw errors.

Settings

Member Visibility

Theme

On This Page