uesp-eso-build-wrapper v0.7.0

---

uesp-eso-build-wrapper / SetToggle

Interface: SetToggle

A set toggle that applies to the calculated build.

Set bonuses whose condition the engine cannot infer on its own (e.g. "after interrupting an enemy", "out of combat") are exposed by the UESP Build Editor as manual checkboxes. calculateBuild reports which of them apply to the current build via setToggles; enabling one is a separate step, done by passing its SetToggle.id in BuildInput.toggledSetBonuses.

Note: setToggles is the list of applicable toggles, not the enabled ones. A toggle only takes effect when it is both applicable and enabled.

Properties

Property	Type	Description
count	number	Stack count used in this calculation (from BuildInput.toggledSetBonusCounts). Always 0 for toggles without maxTimes; for stacking toggles it is 0 when no count is provided, which makes the toggle contribute nothing.
description	string	Set bonus text the toggle belongs to: the slice of the bonus line the rule's regex matches (falls back to the full line when the rule has no regex or it doesn't match). Empty when the equipped items carry no set bonus descriptions.
id	string	Rule nameId — the key accepted in BuildInput.toggledSetBonuses.
label	string	Human-readable label for UI (displayName when present, else id).
maxTimes	number | null	Maximum stacks the toggle can reach; null for toggles without a count.
minTimes	number	Minimum stacks for a stacking toggle (0 when the rule has no minTimes).
setId	string	Set the toggle belongs to. Variant rules (e.g. "Ansuul's Torment (Bonus Damage)") resolve to their base set via the rule's setId (the engine maps the rule's source originalId field to setId at load time).