five-on-it / packages/sim/src/dogs / leadWire

Function: leadWire()

leadWire(sim, eid): object

Defined in: packages/sim/src/dogs.ts:975

What a snapshot says of a character's lead (its ownerKind and ownerId, which a character has no other use for): a dog's mode in the low bits, whether it is on its lead and whether it has a walker, with the walker's entity; a dog walker's dog's entity while it has one, and whether that is on the lead; nothing for anybody else.

Parameters

sim

SimWorld

eid

number

Returns

object

ownerId

ownerId: number

ownerKind

ownerKind: number