HudOptions

Signature

export interface HudOptions {
  /** String table; defaults to `resolveStrings(ctx)`. */
  strings?: Strings | Record<string, string>
  /** Goals to track; defaults to every `goal` component in the scene. */
  goals?: GoalSpec[]
  /** Event that marks a goal reached. */
  goalEvent?: string
  /** Custom HUD field for "2/5"; null to not publish progress. */
  progressField?: string | null
  /** Objective key shown once every goal is reached; null clears the objective instead. */
  completeKey?: string | null
  /** Emitted once when a countdown started with `startTimer` reaches zero. */
  timerEvent?: string
}

Import: import type { HudOptions } from "@argus/gameplay"

Members