five-on-it / packages/sim/src/captives / setCaptive

Function: setCaptive()

setCaptive(sim, eid, state, by?): void

Defined in: packages/sim/src/captives.ts:59

Sets a character's captive state, by the player by (a client id; 0 nobody): a change raises a captive event; free, it has no captor.

Parameters

sim

SimWorld

eid

number

state

"free" | "handsUp" | "restrained" | "surrendered"

by?

number = 0

Returns

void