@maka/maka-cli 5.122.0 → 5.123.0

package/bundle/typescript/src/commands/game/sideQuest/qualities.d.ts

@@ -13,6 +13,18 @@
  * real hook and says so in its comment. Karma values are RAW (p.73-74
  * summary tables) throughout.
  */
+import type { ICatalogEffect, ICatalogChoice } from './utilities/effects.js';
+/**
+ * A pick a quality requires -- THE SHARED ONE, re-exported under the name
+ * this file and the web already use.
+ *
+ * It moved to utilities/effects.ts on 2026-09-04: a choice is not a
+ * quality's idea. A Hardwire is an AUGMENTATION that gives +2 to a
+ * chosen skill and asks exactly the same question, and a declaration
+ * that lives on IQuality means the picker gets rebuilt for chrome, then
+ * again for spells. See ICatalogChoice for the full note.
+ */
+export type IQualityChoice = ICatalogChoice;
 export interface IQuality {
     key: string;
     name: string;
@@ -61,6 +73,87 @@ export interface IQuality {
      * the pick the same way.
      */
     requiresQuality?: string;
+    /**
+     * WHAT THE ENGINE WOULD NEED before this quality does anything
+     * (user, 2026-09-04: "tag the ones that have no game engine
+     * mechanic, so we can focus on what would work today").
+     *
+     * ABSENT MEANS IT WORKS TODAY -- either it declares `effects` that a
+     * pool reads, or it has bespoke code of its own. Present means the
+     * quality is currently sold for karma and delivers nothing, and the
+     * string names the missing seat rather than just flagging it, so the
+     * list doubles as the backlog. Distinct from `retired`, which is
+     * about a quality nobody may BUY any more; an inert quality is on
+     * sale and honest about being unfinished.
+     *
+     * NOT PLAYER-FACING. THE PRESENCE OF THIS FIELD IS; THE STRING IS NOT.
+     * It is written for whoever will build the missing seat -- "no craving
+     * clock and no withdrawal state", "specializations are not modelled" --
+     * and a player reading that learns nothing they can act on. A surface
+     * warning a player off an inert quality should say so in its own
+     * words and use `name` and `effect`, which ARE written for them.
+     *
+     * Flagged because it nearly went the other way: the web was about to
+     * render this string verbatim under each quality in the picker
+     * (2026-09-04). Two audiences, one field, and the engineering half is
+     * the one that would have shipped.
+     */
+    inert?: string;
+    /**
+     * WHICH KIND OF MECHANIC THIS IS (user, 2026-09-04: "do a pass on
+     * all qualities, and put them into like-categories").
+     *
+     * Required, so a quality cannot be added without someone deciding
+     * what shape its rule has. The families are about the MECHANIC, not
+     * about whether this engine runs it yet -- which is the point: a
+     * `pool` quality carrying no `effects` is a visible gap, where the
+     * same quality filed as "narrative" would be a gap nobody could see.
+     *
+     *   'pool'         flat dice on something the engine already rolls
+     *   'attribute'    moves a stored attribute, once, at install
+     *   'ceiling'      moves a maximum -- what you MAY buy, not what you have
+     *   'limit'        moves an Inherent limit (Physical/Mental/Social)
+     *   'substitution' a different attribute or skill stands in on a named test
+     *   'threshold'    changes a threshold, or what counts as a hit or a glitch
+     *   'engine-rule'  has its own bespoke implementation, not expressible as dice
+     *   'condition'    needs a persistent state this engine does not keep
+     *   'narrative'    canon gives it no dice at all -- fiction and GM adjudication
+     */
+    family: 'pool' | 'attribute' | 'ceiling' | 'limit' | 'substitution' | 'threshold' | 'engine-rule' | 'condition' | 'narrative';
+    /**
+     * The pick this quality cannot work without (see IQualityChoice).
+     * A quality carrying this one is not finished at purchase: chargen
+     * must ask, and the answer must be stored, or it does nothing.
+     */
+    choice?: IQualityChoice;
+    /**
+     * A quality that cannot be held alongside this one. Canon states the
+     * Lucky / Exceptional Attribute pair outright (p.65-66: "either ...
+     * not both"), because both spend the same idea on the same sheet.
+     */
+    excludesQuality?: string;
+    /**
+     * WHAT IT DOES, as data (2026-09-04, "put real stats into them").
+     *
+     * The same vocabulary gear and chrome already speak, so a quality
+     * that adds +2 to a pool declares it exactly the way a smartlink
+     * does, and the catalog can print a quality's mechanics instead of
+     * only its prose. Player.qualityBonus reads these, and a rated
+     * quality multiplies by the rating held when the effect says
+     * `scaleBy: 'rating'`.
+     *
+     * ABSENT IS A REAL ANSWER, and the common one. Most of SR5's
+     * qualities do not resolve to a flat pool modifier -- Home Ground
+     * picks a domain, Indomitable picks a limit, Guts resists fear,
+     * Sensitive System doubles Essence loss -- and several are already
+     * implemented as their own rule rather than as dice (First
+     * Impression is consumed once per job, the SINner tax cuts a payout,
+     * Gremlins changes what counts as a glitch). Those carry NO entry on
+     * purpose: an effect nothing reads is a stat block that lies, and an
+     * effect duplicating a rule implemented elsewhere would double it.
+     * `effect` above stays the human sentence in every case.
+     */
+    effects?: ICatalogEffect[];
 }
 /** Everyone starts character creation with 25 karma (SR5e p.71). */
 export declare const CREATION_KARMA = 25;
@@ -71,14 +164,13 @@ export declare const QUALITIES: IQuality[];
  * here for the day its seat exists.
  */
 export declare const RETIRED_QUALITIES: IQuality[];
-/**
- * A saved or offered key, resolved: the old fixed "<key>-1" entries
- * (every rated quality shipped as Rating 1 only) read as key + rating 1.
- */
 export declare function resolveQualityKey(key: string): {
     key: string;
     rating: number;
+    pick?: string;
 };
+/** Every legacy slug that resolves to a key plus a pick, for tests and tooling. */
+export declare const LEGACY_CHOICE_SLUGS: string[];
 export declare function getQuality(key?: string): IQuality | undefined;
 /** What a quality costs (or refunds) at the rating given: per-rating for rated entries. */
 export declare function qualityKarma(q: IQuality, rating?: number): number;