BuffState

Defined in: client/api.d.ts:508

One status effect currently on a body: everything BuffInfo says about it, plus how long it has been there and who put it there.

Properties

aiTag

aiTag: string | null

Defined in: client/api.d.ts:522

The family player.clearBuffs would take it off with, or null for the majority that belong to none.

---

class

class: string

Defined in: client/api.d.ts:517

The kind of effect it is – poison, alcohol, injury, potion. Buffs.classes lists the ones a server can take over.

---

duration

duration: number

Defined in: client/api.d.ts:527

How long the effect runs from start to finish, in real seconds, and negative for one with no end.

---

name

name: string

Defined in: client/api.d.ts:512

The name the game’s own buff tables give the effect, and the spelling every buff verb takes.

---

since

since: number

Defined in: client/api.d.ts:532

How long it has been on the body, in real seconds. duration - since is roughly what is left, and roughly is the best anyone can do: the game advances buff time from each client’s own frame delta. 0 for an effect that was already there when the player connected.

---

source

source: "server" | "native"

Defined in: client/api.d.ts:537

Whether this server put it there, or the game did – a potion they drank, an injury they took.