five-on-it / packages/sim/src/ladders / ladderAt

Function: ladderAt()

ladderAt(sim, x, z, feet): { distance: number; index: number; } | undefined

Defined in: packages/sim/src/ladders.ts:64

The ladder someone standing at (x, z) with their feet at feet can climb: at its foot (within reach of its line, on its floor) or at its top (within reach of where it steps off, on the floor there); the nearest, with how far it is. undefined with none.

Parameters

sim

SimWorld

x

number

z

number

feet

number

Returns

{ distance: number; index: number; } | undefined