Class EntityRideableComponentBeta

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

Hierarchy (View Summary)

Properties

controllingSeat crouchingSkipInteract entity? interactText pullInEntities riderCanInteract seatCount typeId componentId

Methods

addRider ejectRider ejectRiders getFamilyTypes getRiders getSeats isValid

Properties

Readonly BetacontrollingSeat

controllingSeat: number

Remarks

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

Throws

This property can throw when used.

Readonly BetacrouchingSkipInteract

crouchingSkipInteract: boolean

Remarks

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

Throws

This property can throw when used.

Optional Readonly Betaentity

entity?: Entity

Remarks

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

Readonly BetainteractText

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 BetapullInEntities

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 BetariderCanInteract

riderCanInteract: boolean

Remarks

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

Throws

This property can throw when used.

Readonly BetaseatCount

seatCount: number

Remarks

Number of seats for riders defined for this entity.

Throws

This property can throw when used.

Readonly BetatypeId

typeId: string

Remarks

Identifier of the component.

Static Readonly BetacomponentId

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

Methods

addRider

  • addRider(rider: Entity): boolean
    Beta

    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

  • ejectRider(rider: Entity): void
    Beta

    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

  • ejectRiders(): void
    Beta

    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

  • getFamilyTypes(): string[]
    Beta

    Returns string[]

    Remarks

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

    Throws

    This function can throw errors.

getRiders

  • getRiders(): Entity[]
    Beta

    Returns Entity[]

    Remarks

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

    Throws

    This function can throw errors.

getSeats

  • getSeats(): Seat[]
    Beta

    Returns Seat[]

    Remarks

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

    Throws

    This function can throw errors.

isValid

  • isValid(): boolean
    Beta

    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.

Settings

Member Visibility

On This Page

Properties
Methods