HudProps

Since 0.6

Signature

export interface HudProps {
  /** Track these goals instead of discovering the scene's `goal` components. */
  goals?: GoalSpec[]
  /** Event that marks a goal reached. Default `goal-reached`. */
  goalEvent?: string
  /** Custom field for "2/5"; null to publish no progress. */
  progressField?: string | null
  /** Objective shown once every goal is reached. */
  completeKey?: string | null
  /** A string table, when the host does not provide one. */
  strings?: Record<string, string>
  /** Start a countdown of this many seconds at init. */
  timer?: number
  /** Initial score. */
  score?: number
}

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

Members

Member	Signature	Description
`goals`	`goals?: GoalSpec[]`	Track these goals instead of discovering the scene's `goal` components.
`goalEvent`	`goalEvent?: string`	Event that marks a goal reached. Default `goal-reached`.
`progressField`	`progressField?: string \| null`	Custom field for "2/5"; null to publish no progress.
`completeKey`	`completeKey?: string \| null`	Objective shown once every goal is reached.
`strings`	`strings?: Record<string, string>`	A string table, when the host does not provide one.
`timer`	`timer?: number`	Start a countdown of this many seconds at init.
`score`	`score?: number`	Initial score.