Script page Buy (opens Tebex in a new tab)

HUD & Prompt

On this page9

The HUD appears only when someone is in front of you, while a scan runs, and while a live result is up. The rest of the time it is not on screen at all.

Every player can move it, resize it and pick the icon shape from /recognition:hud. That choice is saved on their PC, not on your server.

Position and size

Key	Default	Allowed	What it does
`Config.Hud.Position`	`{ x = 0.985, y = 0.02 }`	`0.0`–`1.0` each	Default position of the anchor corner, as a fraction of the screen.
`Anchor`	`'top-right'`	`'top-right'` · `'top-left'` · `'bottom-right'` · `'bottom-left'`	Which corner the position refers to.
`Scale`	`1.0`	`ScaleMin`–`ScaleMax`	Default size.
`ScaleMin`	`0.75`	number	Lower end of the size slider.
`ScaleMax`	`1.50`	number	Upper end of the size slider.

Look

Key	Default	Allowed	What it does
`Shape`	`'circle'`	`'circle'` · `'rounded-square'`	Default icon shape.
`Background`	`'panel'`	`'panel'` · `'text'` · `'none'`	What sits behind the HUD. `panel` = a dark see-through box; `text` = a strip behind the text only.
`ShowLabel`	`true`	`true` / `false`	Show the line a person is remembered by on results (for example "Met him on Grove Street in the evening").
`ShowClaimedName`	`true`	`true` / `false`	Show the name someone introduced themselves with.
`StateMarks`	`true`	`true` / `false`	Default of the player setting "show check / cross marks" — colour-blind help.
`ShowHints`	`true`	`true` / `false`	Show a small line like Slower: dark during a scan.
`Overhead`	`true`	`true` / `false`	Show a small ring with the % (and a short word like Paused 25 s) above the head of every person you scan. Hidden off-screen and behind walls.
`ResultSeconds`	`6`	seconds	How long a scan result stays before the HUD returns to live / idle.

Player options

Key	Default	Allowed	What it does
`AllowQuietMode`	`false`	`true` / `false`	Let players hide the grey "someone is in front of you" view.
`HideInPauseMenu`	`true`	`true` / `false`	Hide our HUD while the pause menu is open.

Living next to another HUD

Key	Default	Allowed	What it does
`HideThirdPartyOnFullscreen`	`false`	`true` / `false`	Hide the other HUD while our full-screen windows are open.
`Offsets`	`{ ['jg-hud'] = { x = 0.0, y = 0.08 } }`	screen fractions per resource	Move our default position when another HUD uses the same corner.

lua

Offsets = {
    ['jg-hud'] = { x = 0.0, y = 0.08 },   -- below JG's top-right block
},

The offset only applies while the player has no saved HUD position of their own. Once they move it, their choice wins.

Per-HUD behaviour, including what we do and do not do with JG HUD: HUDs (JG HUD & others).

Sounds

lua

Sounds = {
    Enabled = true,
    ScanStart = { name = 'NAV_UP_DOWN', set = 'HUD_FRONTEND_DEFAULT_SOUNDSET' },
    Result    = { name = 'SELECT',      set = 'HUD_FRONTEND_DEFAULT_SOUNDSET' },
}

Key	Default	Allowed	What it does
`Sounds.Enabled`	`true`	`true` / `false`	Play frontend sounds.
`Sounds.ScanStart`	`NAV_UP_DOWN`	any GTA frontend sound	When a scan starts.
`Sounds.Result`	`SELECT`	any GTA frontend sound	When a result arrives.

Heard only by the scanner.

The prompt over the head

Key	Default	Allowed	What it does
`Config.Prompt.Arrow`	`'sprite'`	`'sprite'` · `'marker'` · `'none'`	What is drawn over the selected person's head. `sprite` = the arrow icon; `marker` = a GTA cone.
`Config.Prompt.HelpSlot`	`0`	`0` · `1`	Floating help slot. Use `1` if another script already uses slot 0.
`Config.Prompt.HeadOffset`	`0.45`	`0.2`–`1.0`	Metres above the head.
`Config.Prompt.SelectedColor`	`{ 230, 126, 59, 230 }`	RGBA 0–255	Colour of the selected person's arrow.
`Config.Prompt.OtherColor`	`{ 134, 141, 151, 150 }`	RGBA 0–255	Colour of the other candidates' arrows.
`Config.Prompt.ShowOthers`	`true`	`true` / `false`	Draw smaller grey arrows over the other people you could pick.
`Config.Prompt.PickedColor`	`{ 63, 169, 104, 235 }`	RGBA 0–255	Colour of the arrows of the people picked with SPACE in the F3 menu.

In menu mode (the default, Config.StartMode) the arrows only show while the F3 menu is open, and there is no prompt text. The prompt text below (Recognize [E]) only exists in prompt mode.

The arrow is always ours. Only the prompt text goes through Config.TextUISystem, which defaults to 'native' — GTA's own floating help, which looks identical for every player.

Keys

Key	Default	Allowed	What it does
`Config.Keys.Menu`	`'F3'`	any FiveM key name	Open the scan menu (`menu` mode): Scan person to memory, Recognize, Camera recordings, Stop looking. UP / DOWN + Enter only; the number keys do nothing.
`Config.Keys.Scan`	`'E'`	any FiveM key name	Stop the scan of the person you look at. In `prompt` mode it also starts one.
`Config.Keys.Next`	`'RIGHT'`	any FiveM key name	Next candidate.
`Config.Keys.Prev`	`'LEFT'`	any FiveM key name	Previous candidate.
`Config.Keys.Hud`	`''`	any FiveM key name, or `''`	Open the HUD settings. `''` = unbound; players bind it themselves.
`Config.Keys.Mirror`	`''`	any FiveM key name, or `''`	Open the mirror check. `''` = unbound.

Players rebind all of them in GTA Settings → Key Bindings → FiveM.

Player commands

Command	What it does
`/recognition:hud`	Move and resize the HUD, pick circle or rounded-square icons, toggle the marks.
`/recognition:mirror`	How recognisable am I right now?
`/recognition:cancel`	Drop your newest running scan. Nothing is saved.

To end every scan and quiet look at once and keep what was learned, players use F3 → Stop looking.

What the HUD shows

State	What you see
Idle	Grey icons — someone is in front of you and could be scanned.
Scanning	Four cue bars filling, the reliability ring, and Slower: dark / rain / fog / too far / turned away / no clear view / not on the same level when something is holding you back. With several scans running, the panel shows the newest.
Paused	`Paused · N s` — the target went further than 7 m (30 s to come back), or cannot be scanned at all, e.g. sits in a car or is down (15 s). Turning away never pauses a scan.
Result	Recognized, Noted, Not sure or Too little seen, with the label and any introduced name. You don't know him after the menu's Recognize on somebody you do not remember.
Above the head	A small ring with the % over every person you scan (`Overhead`).
Live	The person's card, updating while they are nearby, for up to 10 minutes.
REC 25%	Your own hidden camera is recording. The number is what the camera saw of the current look; it turns green at `Config.Scan.MinSavePct` (50 %), when the recording can be printed from F3 → Camera recordings. See Devices & Reports.

Nothing in any of those states tells you whether the scan is remembering or recognising. That is the point.

#Position and size

#Look

#Player options

#Living next to another HUD

#Sounds

#The prompt over the head

#Keys

#Player commands

#What the HUD shows