EntityRideableComponent

Class in @minecraft/server

Extends EntityComponent

Who may ride an entity, and who does: a minecart’s one seat. Players get on by using it, mobs it runs into are pulled in, and an activator rail with power throws them out.

import { EntityRideableComponent } from '@minecraft/server';

Example

TypeScript JavaScript

import { world, type EntityRideableComponent } from '@minecraft/server';

for (const player of world.getAllPlayers()) {
    const component: EntityRideableComponent | undefined = player.getComponent('minecraft:rideable');
    if (component) {
        console.log(player.name, component.controllingSeat);
    }
}

import { world } from '@minecraft/server';

for (const player of world.getAllPlayers()) {
    const component = player.getComponent('minecraft:rideable');
    if (component) {
        console.log(player.name, component.controllingSeat);
    }
}

Properties

componentId

static read-only

static readonly componentId: "minecraft:rideable";

typeId

read-only

readonly typeId: "minecraft:rideable";

entity

read-only

readonly entity: Entity;

Types

Entity

isValid

read-only

readonly isValid: boolean;

controllingSeat

read-only

readonly controllingSeat: number;

The seat of whoever steers it.

crouchingSkipInteract

read-only

readonly crouchingSkipInteract: boolean;

A sneaking player doesn’t get on.

interactText

read-only

readonly interactText: string;

passengerMaxWidth

read-only

readonly passengerMaxWidth: number;

0 for no limit; otherwise a rider must be narrower.

pullInEntities

read-only

readonly pullInEntities: boolean;

It takes on board the mobs it runs into.

riderCanInteract

read-only

readonly riderCanInteract: boolean;

seatCount

read-only

readonly seatCount: number;

Methods

addRider

addRider(rider: Entity): boolean;

Seats a player or a mob. False if it’s full, or the rider is on something already.

Parameters

rider

Entity

Returns

boolean

Types

Entity

ejectRider

ejectRider(rider: Entity): void;

Lets a rider off beside it, where BDS lands riders.

Parameters

rider

Entity

Types

Entity

ejectRiders

ejectRiders(): void;

Lets everyone off, the last rider first.

getFamilyTypes

getFamilyTypes(): string[];

The families that may ride; empty for any.

Returns

string[]

getRiders

getRiders(): Entity[];

Returns

Entity[]

Types

Entity

getSeats

getSeats(): Seat[];

Returns

Seat[]

Types

Seat

Used by

EntityComponentTypeMap.minecraft:rideable, EntityComponentTypeMap.rideable