Points Bar App

HUD progress bar for displaying point-based scoring with configurable thresholds.

Overview

ui_apps_pointsBar provides a simple API for gameplay systems to display a points progress bar with multiple star/medal thresholds. Data is streamed to the UI via guihooks.queueStream('pointsBar').

Extension path: lua/ge/extensions/ui/apps/pointsBar.lua
Unload mode: Manual

Exports (M)

Internals

Data Flow

When setPoints() or setThresholds() is called, a guiData table is computed and streamed:

guiData = {
  fillPercent = points / maxValue,           -- 0-1 bar fill
  pointsLabel = "250",                       -- Display text
  thresholdsReached = {true, true, false},   -- Which thresholds are met
  thresholdPercentages = {30.3, 60.6, 90.9}, -- Threshold positions as % of bar
  thresholdCount = 3                         -- Number of thresholds
}
guihooks.queueStream('pointsBar', guiData)

The max value is lastThreshold * 1.1 (10% buffer beyond the highest threshold).

Default State

pointsData = {
  currentPoints = 0,
  pointsLabel = "0",
  thresholds = {100, 200, 300}
}

Debug Mode

When debug = true, an ImGui window shows current points and thresholds with a clear button.

How It Works

1. Gameplay system calls setThresholds({100, 200, 300}) to configure medal levels
2. During gameplay, calls setPoints(currentScore) each update
3. Module computes fill percent, threshold positions, and which thresholds are reached
4. Data is streamed to UI which renders a progress bar with threshold markers
5. clearData() resets everything when the activity ends

Additional Exports

The following exports are available but not yet documented in detail:

• M.clearData
• M.onInit
• M.onUpdate
• M.requestAllData
• M.setPoints
• M.setThresholds

See Also

• Generic Mission Data App - Related reference
• UI System Guide - Guide