SiegeLadder

One of the game's ladders leaning on a wall. Players climb it with the game's climbing. Defenders can push it from the top, so it swings and falls in 4.5 s, and attackers can raise a fallen one in 5.7 s. Its pose is 'standing', 'pushed', 'down', 'raising' or 'broken'. Pushing and raising return { accepted, reason, seconds }. Events are siegeLadderSpawn, siegeLadderUse, which can refuse, siegeLadderFall, siegeLadderRaise and siegeLadderDestroy.

siegeLadder.spawn()

SiegeLadder.spawn(kind, position, orientation, dimension)

Places a ladder with its foot at `position`, leaning 12 degrees towards the way it faces.

siegeLadder.describe()

SiegeLadder.describe(kind)

The mesh, rung height and lean of a kind, or null.

siegeLadder.all()

SiegeLadder.all(dimension)

All ladders, or those in one dimension.

siegeLadder.getById()

SiegeLadder.getById(id)

The ladder with this network id, or null.

siegeLadder.destroyAll()

SiegeLadder.destroyAll(dimension)

Removes all ladders, or those in one dimension, and returns how many.

siegeLadder.position

position

The foot of the ladder.

siegeLadder.rotation

rotation

Its rotation.

siegeLadder.pose

pose

'standing', 'pushed', 'down', 'raising' or 'broken'.

siegeLadder.height

height

The height of its rungs in metres.

siegeLadder.climbable

climbable

Whether it is standing and can be climbed.

siegeLadder.usable

usable

Whether players can push or raise it, true by default. You can assign to it.

siegeLadder.pusher

pusher

The player who last pushed it, or null.

siegeLadder.push()

push(player)

Pushes over a standing ladder.

siegeLadder.raise()

raise(player)

Raises a fallen ladder against its wall.

siegeLadder.break()

break()

Breaks the ladder, so it cannot be climbed or raised until repaired.

siegeLadder.repair()

repair()

Stands the ladder up again, whole.

siegeLadder.destroy()

destroy()

Removes the ladder, firing siegeLadderDestroy.

siegeLadder.id

id: number

The network id.

siegeLadder.kind

kind: string

'siege' (9.75 m), 'tall' (5.5 m), 'short' (3.25 m) or 'low' (2 m).

siegeLadder.dimension

dimension: number

Its dimension.