LiftView
Defined in: client/api.d.ts:1637
A lift as this client’s game shows it.
Properties
Section titled “Properties”bodyPosition
Section titled “bodyPosition”bodyPosition:
Vector3|null
Defined in: client/api.d.ts:1671
World position of the cab’s physics body, the place to stand to ride it; null before the lift has built it.
buttonsEnabled
Section titled “buttonsEnabled”buttonsEnabled:
boolean
Defined in: client/api.d.ts:1686
Whether the cab button’s prompt is available.
callButtons
Section titled “callButtons”callButtons: (
Vector3|null)[]
Defined in: client/api.d.ts:1706
World position of each floor’s call button, lowest floor first; null for a floor without one.
doorsOpen
Section titled “doorsOpen”doorsOpen: (
boolean|null)[]
Defined in: client/api.d.ts:1701
Whether each floor’s landing door is open or opening, lowest floor first; null for a floor without one.
floor:
number|null
Defined in: client/api.d.ts:1646
Floor the cab is at, 0 being the lowest; null while it is moving.
floorHeights
Section titled “floorHeights”floorHeights:
number[]
Defined in: client/api.d.ts:1696
World height of the cab floor at each floor, lowest first.
height
Section titled “height”height:
number
Defined in: client/api.d.ts:1666
World height of the cab floor, as the lift tracks it.
id:
string
Defined in: client/api.d.ts:1641
Lift id, the same “0x”-prefixed hex string the server’s Lift functions take.
moving
Section titled “moving”moving:
boolean
Defined in: client/api.d.ts:1656
Whether the lift is between floors, doors closing included.
ready:
boolean
Defined in: client/api.d.ts:1691
Whether the game has placed the cab since the lift streamed in.
state:
number
Defined in: client/api.d.ts:1661
The game’s lift state: 0 idle, 1 closing doors, 2 moving, 3 braking.
targetFloor
Section titled “targetFloor”targetFloor:
number
Defined in: client/api.d.ts:1651
Floor the cab is going to; equal to floor when it is not moving.
x:
number
Defined in: client/api.d.ts:1676
World x of the shaft.
y:
number
Defined in: client/api.d.ts:1681
World y of the shaft.