Skip to main content

Class: EntityRideableComponent

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

Extends​

Constructors​

new EntityRideableComponent()​

private new EntityRideableComponent(): EntityRideableComponent

Returns​

EntityRideableComponent

Overrides​

EntityComponent . constructor

Properties​

controllingSeat​

readonly controllingSeat: number

Remarks​

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

Throws​

This property can throw when used.

crouchingSkipInteract​

readonly crouchingSkipInteract: boolean

Remarks​

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

Throws​

This property can throw when used.

entity​

Beta

readonly entity: Entity

Remarks​

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

Inherited from​

EntityComponent . entity

interactText​

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

passengerMaxWidth​

readonly passengerMaxWidth: number

Remarks​

The max width a mob can be to be a passenger.

Throws​

This property can throw when used.

pullInEntities​

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

riderCanInteract​

readonly riderCanInteract: boolean

Remarks​

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

Throws​

This property can throw when used.

seatCount​

readonly seatCount: number

Remarks​

Number of seats for riders defined for this entity.

Throws​

This property can throw when used.

typeId​

readonly typeId: string

Remarks​

Identifier of the component.

Inherited from​

EntityComponent . typeId

componentId​

static readonly componentId: "minecraft:rideable" = 'minecraft:rideable'

Methods​

addRider()​

addRider(rider): boolean

Parameters​

ParameterTypeDescription
riderEntityEntity 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): void

Parameters​

ParameterTypeDescription
riderEntityEntity 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

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[]

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[]

Returns​

Entity[]

Remarks​

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

Throws​

This function can throw errors.

getSeats()​

getSeats(): Seat[]

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

Returns​

boolean

Whether the component is valid.

Inherited from​

EntityComponent . isValid

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.