Brodgar client

Data Types: The Character Sheet

The snapshot shapes off one character’s sheet: attributes, food, learning, movement speed, quests, wounds and buffs. Each is what :info() copies out of a live object. What optional means is on the catalogue.

local food = hafen.session():current():char():food()
local snapshot = food and food:info()
if snapshot and snapshot.fep then hafen.log():write(("fep %d/%d"):format(snapshot.fep.total, snapshot.fep.cap)) end

Attr

From attr:info(): { base = number, comp = number }, the raw base value against the computed, buffed value. session:char():attr() hands live Attr objects, not this table. nil while the server has published nothing for that attribute. An attribute of exactly zero on both halves reads as the same nil. The client keeps no published flag, and builds a zero record for any name asked. A living character carries no attribute of zero.

Food

From food:info(). session:char():food() and FepChanged hand a live Food object, not this table. Either half is absent until its meter arrives.

local shape = {
  fep = {
    cap   = 0,                 -- FEP bar capacity
    total = 0,                 -- sum of the entry amounts
    entries = {                -- one per food-event group
      { res = "", name = "", amount = 0 },    -- res and name optional
    },
  },
  hunger = { level = 0, label = "", efficacy = 0 },   -- label optional
}

Skill, Credo, Experience

From :info() on each. session:char hands the live objects.

Shape	Fields
`Skill`	`{ name = string, res = string?, cost = number, known = bool }`. `known` distinguishes a learnt skill from one buyable. `name` is always a string, the server’s token for the skill while its resource loads, settling to the display name once the resource does.
`Credo`	`{ name = string, res = string?, acquired = bool, pursuing = bool }`, plus `{ level, levelTotal, quest, questTotal, questId }` on the pursued credo only. `level` is the live `credo:rank()`, `quest` the live `credo:questsDone()`.
`Experience`	`{ name = string?, res = string, score = number, mtime = number }`. `mtime` is the server’s change stamp, `experience:modified()`.

StudySlot and StudySummary

From slot:info(). session:study():curiosity() and StudyChanged hand live StudySlot objects, not this table.

Field	Type	Notes
`res`	`string`	The curiosity item’s resource, its identity. Optional while loading.
`name`	`string`	Display name. Optional.
`lp`	`number`	Learning points. Optional.
`attention`	`number`	Mental weight. Optional.
`cost`	`number`	Experience cost. Optional.
`time`	`number`	Total study time in seconds, no per-item countdown. Optional.
`progress`	`number`	`0..1` study progress. Best-effort, optional.

StudySummary is { lp, attention, cost }, the totals across the window, from summary:info(). session:study():summary() hands the live object.

Speed

From speed:info(). session:speed() hands live Speed objects, not this table. { index = number, wire = number, name = string, available = bool, current = bool }. index is the 1-based position 1..4, wire the raw number 0..3. available is whether it can be picked now. current is whether your character is on it (live: session:speed():current() == speed).

Quest and Condition

From quest:info() and condition:info() on session:quest’s objects.

Shape	Fields
`Quest`	`{ id, title?, res?, status?, mtime }`. `status` is `"pending"`, `"done"`, `"failed"` or `"disabled"`, absent for a status this client has no word for. `mtime` is the server’s change stamp, `quest:modified()`.
`Condition`	`{ desc = string?, status = "pending"\\|"done"\\|"failed", text = string? }`. `desc` is `condition:description()`, `text` the tooltip line.

Wound

From wound:info() on session:wound’s objects. Wounds form a tree. parentid is the id wound:parent() resolves to the wound.

Field	Type	Notes
`id`	`number`	Wound id.
`name`, `res`	`string`	Wound type. Optional.
`severity`	`number`	The magnitude (`wound:severity()`), not seconds. Absent where the client spells it as a word, which `wound:label()` answers.
`parentid`	`number`	Parent wound id, or `-1` for a root.
`level`	`number`	Tree depth (indent).

Buff

From buff:info(). session:buff():list() and the buff events hand live Buff objects, not this table.

Field	Type	Notes
`res`, `name`	`string`	Resource plus display name. Optional.
`amount`	`number`	`0..1` fraction. Content-defined, often absent.
`duration`	`number`	`0..1` fraction of the run left, the live `buff:remaining()`. Content-defined, often absent, not seconds.
`number`	`number`	Integer overlay. Content-defined, often absent.