Lift
constLift:object
Defined in: client/api.d.ts:1611
Reads the game’s lifts this client has streamed in, and asks the server to send one to a floor. The server decides every move, so a lift only moves once the server accepts the request; the same move then plays for every player.
Type Declaration
Section titled “Type Declaration”call()
Section titled “call()”call(
liftId,floor):boolean
Asks the server to send a lift to a floor, as pressing one of its buttons does: the server refuses a lift that is disabled, still moving, or more than 30 m from the player. Lets a script offer a floor menu for a lift with more than two floors.
Parameters
Section titled “Parameters”liftId
Section titled “liftId”string
Lift id.
number
Floor to send the lift to, 0 being the lowest.
Returns
Section titled “Returns”boolean
True when the request was sent; false when not connected, for an unknown lift id, or a floor out of range.
get(
liftId):LiftView|null
Reads one lift.
Parameters
Section titled “Parameters”liftId
Section titled “liftId”string
Lift id.
Returns
Section titled “Returns”LiftView | null
The lift, or null when this client does not have it streamed in.
getStreamed()
Section titled “getStreamed()”getStreamed():
LiftView[]
Lists the lifts this client has streamed in.
Returns
Section titled “Returns”LiftView[]
Every streamed-in lift.