@rpgm-tools/neo-angband-core 0.10.0

package/dist/game/display.d.ts

@@ -0,0 +1,196 @@
+/**
+ * The DATA half of the sidebar and status line, ported from the display
+ * functions of reference/src/ui-display.c (Angband 4.2.6).
+ *
+ * Upstream each prt_* handler both COMPUTES a coloured string and DRAWS it
+ * with Term_* at a fixed row/column. This module ports only the computation:
+ * for every sidebar field and status-line indicator it returns the ordered
+ * list of coloured text runs. The terminal draw half - row/column positioning,
+ * the "%-11s" / "%-13s" field padding of prt_speed / prt_depth, and the
+ * screen-size priority culling of update_sidebar (L844) - stays with each
+ * front-end shell.
+ *
+ * The status-line handlers return a width (col += return in
+ * update_statusline_aux) that already includes exactly ONE trailing gap column
+ * after each active segment; an idle prt_state still reserves one column. Each
+ * status builder below bakes that single trailing gap into its runs text, so a
+ * shell renders the segments back-to-back with NO external gap and reproduces
+ * the reference layout exactly.
+ *
+ * sidebarModel returns the 18 real fields of side_handlers[] (L810, the four
+ * NULL spacer rows are not fields), in table order. statusLineModel returns
+ * the 11 entries of status_handlers[] (L1296) in table order. A field or
+ * indicator that upstream would draw as blank / return 0 for is represented by
+ * an EMPTY runs array rather than being dropped, so the returned order always
+ * matches the handler tables and a shell simply skips the empty ones.
+ *
+ * Seams for the struct player / world members the port does not carry on
+ * GameState arrive through DisplayDeps; each has a sensible default and is
+ * listed in parity/ledger/ui-display.yaml.
+ */
+import type { TimedEffect } from "../player/types.js";
+import type { Player } from "../player/player.js";
+import type { Monster } from "../mon/monster.js";
+import type { GameObject } from "../obj/object.js";
+import type { GameState } from "./context.js";
+/** One coloured run of text; color is a COLOUR_* value (see color.ts). */
+export interface DisplayRun {
+    text: string;
+    color: number;
+}
+/** One computed sidebar field: its handler key and its ordered runs. */
+export interface SidebarField {
+    /** The side_handlers[] prt_* name minus the "prt_" prefix. */
+    key: string;
+    runs: DisplayRun[];
+}
+/** One computed status-line indicator: its handler key and its runs. */
+export interface StatusIndicator {
+    /** The status_handlers[] prt_* name minus the "prt_" prefix. */
+    key: string;
+    runs: DisplayRun[];
+}
+/**
+ * The struct player / world / option members the display reads that the port
+ * does not carry on GameState, Player or Chunk. Every field is optional and
+ * defaults (below, in resolveDeps) to the value that reproduces a freshly born,
+ * headless character; see parity/ledger/ui-display.yaml.
+ */
+export interface DisplayDeps {
+    /**
+     * op_ptr->hitpoint_warn (0..9), read by player_hp_attr / player_sp_attr.
+     * Default 3 (options.c DEFAULT_HITPOINT_WARN / game DEFAULT_HITPOINT_WARN).
+     */
+    hitpointWarn?: number;
+    /** OPT(player, effective_speed): show speed as a multiplier. Default false. */
+    effectiveSpeed?: boolean;
+    /** OPT(player, birth_feelings): show level feelings. Default true. */
+    birthFeelings?: boolean;
+    /** z_info->feeling_need (constants.txt world:feeling-need). Default 10. */
+    feelingNeed?: number;
+    /**
+     * timed_effects[] indexed by TMD_* (player/bind.ts). Each entry's grades
+     * array is walked by prt_tmd. Default [] (no timed effect is ever named).
+     */
+    timedEffects?: readonly TimedEffect[];
+    /**
+     * player->state.stat_use[STAT_MAX]: the current modified stats prt_stat
+     * shows. Default derived from Player.statCur with the race + class modifiers
+     * only (equipment / timed contributions are DEFERRED - no stored
+     * player_state on GameState).
+     */
+    statUse?: readonly number[];
+    /**
+     * player->state.num_moves (calc_bonuses), read by prt_moves. Default 0
+     * (one move, no display) - PlayerCombatState omits num_moves.
+     */
+    numMoves?: number;
+    /**
+     * player->upkeep->health_who: the tracked monster, or null. Default
+     * state.healthWho.
+     */
+    healthWho?: Monster | null;
+    /**
+     * player->unignoring (prt_unignore, L1282). Default false - struct player's
+     * unignoring flag is not carried on the port's Player / upkeep.
+     */
+    unignoring?: boolean;
+    /**
+     * player_is_resting(player) (player-util.c L1397). Defaults from
+     * state.resting, so prt_state's "Rest" field appears without every shell
+     * having to remember to pass it - which is how it came to appear nowhere.
+     */
+    isResting?: boolean;
+    /** player_resting_count(player) = upkeep->resting (L1406). Default state.resting.count. */
+    restingCount?: number;
+    /** cmd_get_nrepeats() (cmd-core.c). Default 0. */
+    nRepeats?: number;
+    /**
+     * player->wizard: the wizard-mode flag (fmt_title, L178). Default false -
+     * struct player's wizard/noscore members are UI/debug-only, not on Player.
+     */
+    wizard?: boolean;
+    /** player->total_winner (fmt_title, L180). Default false. */
+    totalWinner?: boolean;
+    /**
+     * player_book_has_unlearned_spells(player) (prt_study, L1235). Default true;
+     * the spell-book carry check needs the pack, which is not on GameState.
+     */
+    bookHasUnlearnedSpells?: boolean;
+    /**
+     * object_attr(obj): the display colour of a worn item (prt_equippy, L286).
+     * Default colorCharToAttr(obj.kind.dAttr) - the flavour-aware / pref x_attr
+     * override is a presentation concern each shell supplies.
+     */
+    objectAttr?: (obj: GameObject) => number;
+    /** object_char(obj): the display glyph of a worn item. Default obj.kind.dChar. */
+    objectChar?: (obj: GameObject) => string;
+}
+/** DisplayDeps with every default filled in. */
+interface ResolvedDeps {
+    hitpointWarn: number;
+    effectiveSpeed: boolean;
+    birthFeelings: boolean;
+    feelingNeed: number;
+    timedEffects: readonly TimedEffect[];
+    statUse: readonly number[];
+    numMoves: number;
+    healthWho: Monster | null;
+    unignoring: boolean;
+    isResting: boolean;
+    restingCount: number;
+    nRepeats: number;
+    wizard: boolean;
+    totalWinner: boolean;
+    bookHasUnlearnedSpells: boolean;
+    objectAttr: (obj: GameObject) => number;
+    objectChar: (obj: GameObject) => string;
+}
+/**
+ * cnv_stat (ui-display.c L115): a modified stat value as a six-char, right-
+ * justified string. Values over 18 use the "18/NN" encoding.
+ */
+export declare function cnvStat(val: number): string;
+/**
+ * fmt_title (ui-display.c L173), short_mode == false: the character title -
+ * wizard, winner, shape name, or the class level title. Returns "" only if a
+ * shape has an empty name (never in stock data).
+ */
+export declare function fmtTitle(player: Player, deps: ResolvedDeps): string;
+/**
+ * fmt_depth (ui-display.c L519): "Town" at depth 0, else "<feet>' (L<depth>)".
+ * The port's current depth is the live chunk depth (upstream player->depth ==
+ * cave->depth).
+ */
+export declare function fmtDepth(depth: number): string;
+/**
+ * prt_speed_aux (ui-display.c L475): the speed label ("Fast" / "Slow") and its
+ * colour, or an empty string at normal speed (110). With effectiveSpeed the
+ * "(%d.%dx)" multiplier form is used, otherwise the "(%+d)" delta form.
+ */
+export declare function prtSpeedAux(speed: number, effectiveSpeed: boolean): {
+    text: string;
+    color: number;
+};
+/**
+ * monster_health_attr (ui-display.c L365): the colour of a tracked monster's
+ * health bar. `image` is whether the player is hallucinating (TMD_IMAGE).
+ */
+export declare function monsterHealthAttr(mon: Monster | null, image: boolean): number;
+/**
+ * sidebarModel: the 18 real side_handlers[] fields in table order (the four
+ * NULL spacer rows are not represented). update_sidebar's priority culling is
+ * a draw-half concern each shell applies.
+ */
+export declare function sidebarModel(state: GameState, deps?: DisplayDeps): SidebarField[];
+/**
+ * statusLineModel: the 11 status_handlers[] indicators in table order. An
+ * indicator upstream returns 0 for is represented by an empty runs array
+ * (shells skip it). Each active segment bakes its single trailing gap column
+ * into its runs (matching the reference return width), so shells render the
+ * segments back-to-back with no external gap; idle prt_state reserves one blank
+ * column.
+ */
+export declare function statusLineModel(state: GameState, deps?: DisplayDeps): StatusIndicator[];
+export {};
+//# sourceMappingURL=display.d.ts.map

package/dist/game/display.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"display.d.ts","sourceRoot":"","sources":["../../src/game/display.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AA2BH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAGtD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAClD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AACnD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAG9C,0EAA0E;AAC1E,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;CACf;AAED,wEAAwE;AACxE,MAAM,WAAW,YAAY;IAC3B,8DAA8D;IAC9D,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,UAAU,EAAE,CAAC;CACpB;AAED,wEAAwE;AACxE,MAAM,WAAW,eAAe;IAC9B,gEAAgE;IAChE,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,UAAU,EAAE,CAAC;CACpB;AAED;;;;;GAKG;AACH,MAAM,WAAW,WAAW;IAC1B;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,+EAA+E;IAC/E,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,sEAAsE;IACtE,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,2EAA2E;IAC3E,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;OAGG;IACH,YAAY,CAAC,EAAE,SAAS,WAAW,EAAE,CAAC;IACtC;;;;;OAKG;IACH,OAAO,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IAC5B;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAC3B;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;;;OAIG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,2FAA2F;IAC3F,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,kDAAkD;IAClD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;OAGG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,6DAA6D;IAC7D,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;OAGG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC;;;;OAIG;IACH,UAAU,CAAC,EAAE,CAAC,GAAG,EAAE,UAAU,KAAK,MAAM,CAAC;IACzC,kFAAkF;IAClF,UAAU,CAAC,EAAE,CAAC,GAAG,EAAE,UAAU,KAAK,MAAM,CAAC;CAC1C;AAED,gDAAgD;AAChD,UAAU,YAAY;IACpB,YAAY,EAAE,MAAM,CAAC;IACrB,cAAc,EAAE,OAAO,CAAC;IACxB,aAAa,EAAE,OAAO,CAAC;IACvB,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,SAAS,WAAW,EAAE,CAAC;IACrC,OAAO,EAAE,SAAS,MAAM,EAAE,CAAC;IAC3B,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,OAAO,GAAG,IAAI,CAAC;IAC1B,UAAU,EAAE,OAAO,CAAC;IACpB,SAAS,EAAE,OAAO,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,OAAO,CAAC;IAChB,WAAW,EAAE,OAAO,CAAC;IACrB,sBAAsB,EAAE,OAAO,CAAC;IAChC,UAAU,EAAE,CAAC,GAAG,EAAE,UAAU,KAAK,MAAM,CAAC;IACxC,UAAU,EAAE,CAAC,GAAG,EAAE,UAAU,KAAK,MAAM,CAAC;CACzC;AAyDD;;;GAGG;AACH,wBAAgB,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAQ3C;AAED;;;;GAIG;AACH,wBAAgB,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,YAAY,GAAG,MAAM,CAMnE;AAeD;;;;GAIG;AACH,wBAAgB,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAG9C;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CACzB,KAAK,EAAE,MAAM,EACb,cAAc,EAAE,OAAO,GACtB;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,CAqBjC;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,GAAG,EAAE,OAAO,GAAG,IAAI,EAAE,KAAK,EAAE,OAAO,GAAG,MAAM,CAkB7E;AAiKD;;;;GAIG;AACH,wBAAgB,YAAY,CAC1B,KAAK,EAAE,SAAS,EAChB,IAAI,GAAE,WAAgB,GACrB,YAAY,EAAE,CAwBhB;AAoRD;;;;;;;GAOG;AACH,wBAAgB,eAAe,CAC7B,KAAK,EAAE,SAAS,EAChB,IAAI,GAAE,WAAgB,GACrB,eAAe,EAAE,CAgBnB"}