@jgengine/shell 0.9.0 → 0.11.0

package/skills/jgengine-ui/capabilities.md

@@ -0,0 +1,142 @@
+<!-- GENERATED by scripts/gen-capability-index.ts — do not edit. Regenerate: bun run gen:capabilities -->
+
+# jgengine-ui — capability index
+
+Reach for these before hand-rolling. Each row is *the thing you need* → *the primitive that already does it*.
+
+## action-bar — drop-in cooldown/cost/hotkey action bar over the headless action model
+
+- `ActionBar` (function) · `import { ActionBar } from "@jgengine/react"`
+
+## action-bar-chrome — accessible grid/list toolbar renderer over an action-bar model with swappable item chrome
+
+- `ActionBarChrome` (function) · `import { ActionBarChrome } from "@jgengine/react"`
+
+## action-bar-model — headless action-collection model with focus, hover, keyboard, and hotkey routing
+
+- `useActionBar` (function) · `import { useActionBar } from "@jgengine/react"`
+
+## action-button — cooldown/cost/hotkey action button with complete interaction states
+
+- `ActionButton` (function) · `import { ActionButton } from "@jgengine/react"`
+
+## action-from-ability-slot — adapt a combat ability-kit snapshot into an action-bar action def
+
+- `actionFromAbilitySlot` (function) · `import { actionFromAbilitySlot } from "@jgengine/react"`
+
+## action-tooltip — structured action tooltip body (title, cost, cooldown, blocking notes)
+
+- `ActionTooltip` (function) · `import { ActionTooltip } from "@jgengine/react"`
+
+## clock-format — format a signed time gap like a race split (+/- m:ss.ff)
+
+- `formatDelta` (function) · `import { formatDelta } from "@jgengine/core/ui"`
+- `formatDuration` (function) · `import { formatDuration } from "@jgengine/core/ui"`
+
+## controls-list — keybind-derived control legend that hides on touch
+
+- `ControlsList` (function) · `import { ControlsList } from "@jgengine/react"`
+
+## default-look — one field that lights a scene like a shipped game (opt out with "flat")
+
+- `LookPreset` (type) · `import { LookPreset } from "@jgengine/core/ui"`
+
+## distance-format — render meters as m or km for HUD stats, telemetry, and range readouts
+
+- `formatDistance` (function) · `import { formatDistance } from "@jgengine/core/ui"`
+
+## entity-portrait — selectable entity portrait tile with vitals and selected/focus states
+
+- `EntityPortrait` (function) · `import { EntityPortrait } from "@jgengine/react"`
+
+## entity-render-cues — live velocity/bob/fire/reload/hit/death cues for a custom renderEntity or viewmodel component
+
+- `useEntityRenderCues` (function) · `import { useEntityRenderCues } from "@jgengine/shell/render/useEntityRenderCues"`
+
+## entity-summary — primary selected-entity detail panel (name, tags, vitals)
+
+- `EntitySummary` (function) · `import { EntitySummary } from "@jgengine/react"`
+
+## event-meter-hud — render a core event/heat meter's live value, fraction, tier, and ready state in a HUD gauge
+
+- `useEventMeter` (function) · `import { useEventMeter } from "@jgengine/react"`
+
+## key-hint — keyboard/mouse control hint that hides itself on touch
+
+- `KeyHint` (function) · `import { KeyHint } from "@jgengine/react"`
+
+## keycap — styled keyboard/mouse key cap for control hints
+
+- `Keycap` (function) · `import { Keycap } from "@jgengine/react"`
+
+## minimap — framed circular minimap with terrain bake, fog, markers, and facing arrow
+
+- `Minimap` (function) · `import { Minimap } from "@jgengine/react"`
+
+## minimap-chrome — ring frame plus edge-clamped, heading-aware marker dots to nest inside a game's own `<svg>`
+
+- `MinimapChrome` (function) · `import { MinimapChrome } from "@jgengine/react"`
+
+## minimap-panel — circular minimap with zone label, clock, and compass composed together
+
+- `MinimapPanel` (function) · `import { MinimapPanel } from "@jgengine/react"`
+
+## nameplates — billboarded name + HP bar over nearby entities
+
+- `WorldNameplates` (function) · `import { WorldNameplates } from "@jgengine/shell/world/WorldHud"`
+
+## ordinal-format — format a placement number as 1st/2nd/3rd for HUD ranks
+
+- `formatOrdinal` (function) · `import { formatOrdinal } from "@jgengine/core/ui"`
+
+## placement-ghost — render valid/invalid placement preview mesh
+
+- `PlacementGhost` (function) · `import { PlacementGhost } from "@jgengine/shell/structures"`
+
+## popover — viewport-flipping, viewport-clamped anchored popover/tooltip shell
+
+- `Popover` (function) · `import { Popover } from "@jgengine/react"`
+
+## resolve-game-look — expand a look preset into concrete lighting/backdrop/post knobs
+
+- `resolveGameLook` (function) · `import { resolveGameLook } from "@jgengine/core/ui"`
+
+## selection-collection — accessible portrait-strip / group-chip renderer over a selection model
+
+- `SelectionCollectionChrome` (function) · `import { SelectionCollectionChrome } from "@jgengine/react"`
+
+## selection-group-chip — same-kind selection chip (icon + count) for a grouped selection
+
+- `SelectionGroupChip` (function) · `import { SelectionGroupChip } from "@jgengine/react"`
+
+## selection-model — headless multi-entity selection model with primary focus, grouping, and virtualization
+
+- `useSelectionView` (function) · `import { useSelectionView } from "@jgengine/react"`
+
+## selection-panel — drop-in selection panel: primary summary beside a portrait strip / group chips
+
+- `SelectionPanel` (function) · `import { SelectionPanel } from "@jgengine/react"`
+
+## speed-format — render a m/s speed as km/h, mph, knots, or m/s for speedometers and telemetry HUDs
+
+- `formatSpeed` (function) · `import { formatSpeed } from "@jgengine/core/ui"`
+
+## start-screen — headless title/attract overlay the game fills and skins
+
+- `StartScreen` (function) · `import { StartScreen } from "@jgengine/react"`
+
+## studio-stage — cinematic lighting rig + backdrop + turntable for parametric studios
+
+- `StudioStage` (function) · `import { StudioStage } from "@jgengine/shell/scene/StudioStage"`
+
+## transform-gizmo — in-game select/move/rotate/scale gizmo
+
+- `TransformGizmo` (const) · `import { TransformGizmo } from "@jgengine/shell/structures"`
+
+## vital-bar — compact current/max vital meter for an entity summary
+
+- `VitalBar` (function) · `import { VitalBar } from "@jgengine/react"`
+
+## world-object-highlights — ground-ring highlight over every selected placed object
+
+- `WorldObjectHighlights` (function) · `import { WorldObjectHighlights } from "@jgengine/shell/world/WorldHud"`