列车 API

第三个参数 train 上的全部方法。这是脚本能读到的列车状态的完整集合。

速度

方法	返回	说明
`speedKmh()`	float	km/h，等同 `speedKilometersPerHour()`
`speedKilometersPerHour()`	float	km/h
`speed()`	float	米每刻
`speedMetersPerMillisecond()`	float	米每毫秒 —— MTR 4 内部单位
`pathSpeedLimit()`	float	当前路段限速
`getRailSpeed(railIndex)`	float	指定轨道段的限速

MTR 4 内部一律用毫秒。3.x 脚本按 tick 或秒写的速度计算，直接搬过来量级会差很多。显示用途请一律用 speedKmh()。

门

方法	返回	说明
`doorValue()`	float	门开度，0 为全关，1 为全开
`isDoorOpen()`	boolean	门是否开着
`isDoorFullyOpen()`	boolean	是否完全打开
`isDoorClosed()`	boolean	是否完全关闭
`isDoorOpening()`	boolean	是否正在开门
`justOpening()`	boolean	是否刚开始开门
`justClosing(doorCloseTime)`	boolean	是否刚开始关门
`doorTarget()`	boolean	门的目标状态
`doorSide()`	String	取值 left、right、both、none

// 到站开门时播一次报站
if (train.justOpening()) {
  playAnnouncement(train.currentStationName(), train.doorSide());
}

线路与车站

方法	返回	说明
`routeName()`	String	线路名
`routeNumber()`	String	线路编号
`routeColor()`	int	线路颜色，RGB 整数
`currentRoute()`	RouteCompat	线路对象
`nextStationName()`	String	下一站站名
`currentStationName()`	String	当前站站名
`destinationName()`	String	终点站名
`nextStation()`	StationCompat	下一站对象
`currentStation()`	StationCompat	当前站对象
`nextPlatform()`	PlatformInfo	下一站台
`currentPlatform()`	PlatformInfo	当前站台
`thisRouteStationCount()`	int	本线路站数
`thisRouteCurrentIndex()`	int	当前是第几站，0 起
`isAtTerminus()`	boolean	是否在终点站
`isAtFirstStation()`	boolean	是否在首站

站名可能是「中文竖线English」的双语格式，按竖线切分即可。取不到时会回落到常量 UNKNOWN_STATION、UNKNOWN_ROUTE、 UNKNOWN_DEPOT，这三个常量脚本里可直接引用。

距离与进度

方法	返回	说明
`distanceToNextPlatform()`	double	到下一站台距离，取不到返回 `-1`
`distanceToPrevPlatform()`	double	距上一站台距离
`routeProgress()`	double	全程进度，范围 0 到 1
`totalRouteDistance()`	double	全程总距离
`railProgress()`	double	沿轨道的累计进度
`getRailProgress(car)`	double	指定车厢的进度
`getRailIndex(railProgress, roundDown)`	int	进度对应的轨道段下标

// 进站进度条
var d = train.distanceToNextPlatform();
if (d >= 0 && d < 200) {
  drawProgressBar(1 - d / 200);
}

站台列表

方法	返回	说明
`getAllPlatforms()`	List	全部站台，含跨线路
`getThisRoutePlatforms()`	List	本线路站台
`getNextRoutePlatforms()`	List	下一条线路的站台
`getAllPlatformsNextIndex()`	int	下一站在全部站台里的下标
`getThisRoutePlatformsNextIndex()`	int	下一站在本线路列表里的下标
`getPlatformRelative(offset, allowDifferentRoute)`	PlatformInfo	相对当前的第 N 站
`size()`	int	站台总数
`get(index)`	PlatformInfo	按下标取

PlatformInfo 的成员

成员	类型	说明
`stationName()`	String	站名
`platformName()`	String	站台名
`routeName()`	String	线路名
`routeColor()`	int	线路颜色
`destinationStationName()`	String	该站台方向的终点站
`distance`	double	沿线距离
`reverseAtPlatform`	boolean	是否在此站折返
`station`	StationCompat	车站对象
`platform`	PlatformCompat	站台对象
`route`	RouteCompat	线路对象
`destinationStation`	StationCompat	终点站对象

// 画后续三站
var list = train.getThisRoutePlatforms();
var i = train.getThisRoutePlatformsNextIndex();
for (var k = 0; k < 3 && i + k < list.size(); k++) {
  var p = list.get(i + k);
  draw(p.stationName(), p.routeColor());
}

车辆本身

方法	返回	说明
`id()`	long	车辆实例 ID
`trainTypeId()`	String	车型 ID
`baseTrainType()`	String	基础车型
`trainCars()`	int	编组数
`spacing()`	double	车厢间距，受配置 `closeCouplingGap` 影响
`width()`	double	车宽
`getCarLength(car)`	double	指定车厢长度
`getCarBogieLength(car)`	double	转向架间距
`getCarWorldPosition(car)`	Vector3f	车厢世界坐标
`getCarWorldRotation(car)`	Vector3f	车厢世界旋转
`transportMode()`	TransportMode	运输模式
`siding()`	SidingCompat	所属车厂线
`mtrTrain()`	Vehicle	底层 MTR 对象

运行状态

方法	返回	说明
`isOnRoute()`	boolean	是否在营运线路上
`isReversed()`	boolean	是否反向运行
`isCurrentlyManual()`	boolean	是否处于手动驾驶
`manualAllowed()`	boolean	是否允许手动
`maxManualSpeed()`	int	手动最高速
`manualToAutomaticTime()`	int	手动转自动的时间
`accelerationConstant()`	float	加速度常数
`isClientPlayerRiding()`	boolean	本地玩家是否在车上
`shouldRender()`	boolean	是否在渲染范围
`shouldRenderDetail()`	boolean	是否在细节渲染距离
`headYaw()`	float	车头偏航角
`headPitch()`	float	车头俯仰角

shouldRender、isInDetailDistance、 previousDoorValue、currentDoorValue 同时存在同名的公开字段。写成属性或方法都能取到值，但同一份脚本里不要混用两种写法。