SiegeLadder
Defined in: server/api.d.ts:6030
Replicated handle for a siege ladder leaning on a wall.
Extends
Section titled “Extends”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new SiegeLadder(
id):SiegeLadder
Defined in: server/api.d.ts:6035
Creates a script wrapper for an existing siege ladder with this ID; use SiegeLadder.spawn() to place one.
Parameters
Section titled “Parameters”number
Network entity identifier.
Returns
Section titled “Returns”SiegeLadder
Inherited from
Section titled “Inherited from”Methods
Section titled “Methods”break()
Section titled “break()”break():
void
Defined in: server/api.d.ts:6090
Breaks the ladder: it lies in pieces where it stands, anyone on it falls, and nothing raises it until repair.
Returns
Section titled “Returns”void
destroy()
Section titled “destroy()”destroy():
void
Defined in: server/api.d.ts:6100
Removes the ladder on every client after emitting siegeLadderDestroy.
Returns
Section titled “Returns”void
push()
Section titled “push()”push(
player?):SiegeResult
Defined in: server/api.d.ts:6078
Pushes a standing ladder off its wall. It stands through the swing, falls away from the wall as the blade meets it – throwing off anyone climbing it – and lies where it lands, about 4.5 seconds later.
Parameters
Section titled “Parameters”player?
Section titled “player?”number | Player | null
Who pushes it: they play the game’s own halberd push, and are credited with it in siegeLadderFall.
Returns
Section titled “Returns”What happened, and the phrase to explain it with when nothing did.
raise()
Section titled “raise()”raise(
player?):SiegeResult
Defined in: server/api.d.ts:6085
Lays a fallen ladder back against its wall, over the lift’s 5.7 seconds.
Parameters
Section titled “Parameters”player?
Section titled “player?”number | Player | null
Who raises it: they play the game’s own ladder lift.
Returns
Section titled “Returns”What happened, and the phrase to explain it with when nothing did.
repair()
Section titled “repair()”repair():
void
Defined in: server/api.d.ts:6095
Puts a fallen or broken ladder back against its wall at once.
Returns
Section titled “Returns”void
setVirtualWorld()
Section titled “setVirtualWorld()”setVirtualWorld(
world):void
Defined in: server/api.d.ts:8797
Moves this entity into another virtual world.
Parameters
Section titled “Parameters”number
Virtual-world identifier used to partition replication and visibility.
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”setVisibleTo()
Section titled “setVisibleTo()”setVisibleTo(
player):void
Defined in: server/api.d.ts:8803
Restricts replication of this entity to one owning connection while preserving normal range and visibility checks.
Parameters
Section titled “Parameters”player
Section titled “player”Entity | null
Player-owned entity whose connection should exclusively receive this entity, or null to clear the restriction.
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”toString()
Section titled “toString()”toString():
string
Defined in: server/api.d.ts:6071
Formats this ladder handle for logging and debugging.
Returns
Section titled “Returns”string
The ladder ID, its kind and its pose.
Inherited from
Section titled “Inherited from”
staticall(virtualWorld?):SiegeLadder[]
Defined in: server/api.d.ts:6124
Lists the siege ladders the server has.
Parameters
Section titled “Parameters”virtualWorld?
Section titled “virtualWorld?”number
Optional virtual world to list; omitted lists every one.
Returns
Section titled “Returns”SiegeLadder[]
One handle per ladder, in no particular order.
describe()
Section titled “describe()”
staticdescribe(kind):SiegeLadderKind|null
Defined in: server/api.d.ts:6117
What one kind of ladder is: its mesh, its climb and its lean – what a placement preview needs to show it as it will stand.
Parameters
Section titled “Parameters”string
siege, tall, short or low.
Returns
Section titled “Returns”SiegeLadderKind | null
The kind, or null for a name that is not one.
destroyAll()
Section titled “destroyAll()”
staticdestroyAll(virtualWorld?):number
Defined in: server/api.d.ts:6138
Removes siege ladders, emitting siegeLadderDestroy for each one.
Parameters
Section titled “Parameters”virtualWorld?
Section titled “virtualWorld?”number
Optional virtual world to clear; omitted clears every one.
Returns
Section titled “Returns”number
How many were removed.
getById()
Section titled “getById()”
staticgetById(id):SiegeLadder|null
Defined in: server/api.d.ts:6131
Looks a ladder up by its network entity ID.
Parameters
Section titled “Parameters”number
Network entity identifier.
Returns
Section titled “Returns”SiegeLadder | null
The ladder’s handle, or null when no live ladder has that ID.
spawn()
Section titled “spawn()”
staticspawn(kind,position,rotation?,virtualWorld?):SiegeLadder
Defined in: server/api.d.ts:6110
Places one of the game’s own ladders leaning on a wall, the way the Suchdol and Nebakov sieges stand theirs: the game’s climb, and the game’s step off over the palisade at its top, which wants the top a little over the walk.
Parameters
Section titled “Parameters”string
siege, tall, short or low.
position
Section titled “position”Where its foot stands, on the ground below the wall.
rotation?
Section titled “rotation?”Its facing: forward is the way to the wall it leans on. A Quaternion, or a Vector3 of Euler angles in degrees.
virtualWorld?
Section titled “virtualWorld?”number
Optional virtual world the ladder belongs to; omitted puts it in the global one.
Returns
Section titled “Returns”SiegeLadder
The new ladder’s handle.
Properties
Section titled “Properties”climbable
Section titled “climbable”
readonlyclimbable:boolean
Defined in: server/api.d.ts:6055
Whether the game’s own climb is offered on it: while it stands and nobody has started to push it.
height
Section titled “height”
readonlyheight:number
Defined in: server/api.d.ts:6050
How far up its rungs go, in metres: its top rests this high above its foot on the wall’s top. Pick the kind whose height meets the walk.
readonlyid:number
Defined in: server/api.d.ts:8765
Immutable network entity identifier.
Inherited from
Section titled “Inherited from”
readonlykind:string
Defined in: server/api.d.ts:6040
Which of the game’s ladders it is: siege (the Suchdol siege ladder, 9.75 m), tall (5.5 m), short (3.25 m) or low (2 m).
readonlypose:string
Defined in: server/api.d.ts:6045
standing against its wall, pushed (a defender’s swing, then its fall), down, raising or broken. Named pose because every entity already has a state, which is its state bag.
position
Section titled “position”position:
Vector3
Defined in: server/api.d.ts:8775
Authoritative world-space position; assignment forces replicated state.
Inherited from
Section titled “Inherited from”pusher
Section titled “pusher”
readonlypusher:Player|null
Defined in: server/api.d.ts:6065
Who last pushed it, or null.
rotation
Section titled “rotation”rotation:
Vector3|Quaternion
Defined in: server/api.d.ts:8780
Authoritative rotation; reads return a quaternion and assignments accept a quaternion or Euler angles in degrees.
Inherited from
Section titled “Inherited from”
readonlystate:StateBag
Defined in: server/api.d.ts:8785
Arbitrary key/value state carried by this entity. The server writes it and every client that can see the entity receives it; see StateBag.
Inherited from
Section titled “Inherited from”usable
Section titled “usable”usable:
boolean
Defined in: server/api.d.ts:6060
Whether players are offered the push at its top and the raise at the foot of a fallen one, each raising siegeLadderUse first. On by default. The climb is the game’s and is offered whenever the ladder stands.
virtualWorld
Section titled “virtualWorld”
readonlyvirtualWorld:number
Defined in: server/api.d.ts:8770
Current virtual-world identifier.