bs_ui

HUD, notifications and shared NUI shell.

Generated from the Lua sources in resources/[beyond]/bs_ui/. 53 entries. The description column is the comment above the line in the code, so if it’s empty nobody wrote one yet.

Exports

Call with exports.bs_ui:Name(...) from the same side.

Name	Side	Where	Description
ApplyFilter	client	client/cl_filter.lua:175
ApplyHudSettings	client	client/cl_hud.lua:114
Close	client	client/cl_nui.lua:101
CloseFieldMap	client	client/cl_fieldmap.lua:303
FilterPresets	client	client/cl_filter.lua:167	The list the pickers are built from - Settings, and the cinematic camera.
GetHudSettings	client	client/cl_hud.lua:115
GetPartyHudPref	client	client/cl_partyhud.lua:61
GetUiScale	client	client/cl_uiscale.lua:36
IsFieldMapOpen	client	client/cl_fieldmap.lua:304
IsFocused	client	client/cl_nui.lua:103
IsSoundLive	client	client/cl_sound.lua:478	Is anything still playing under this id?
LevelUpSequence	client	client/cl_levelup.lua:79
MoveSoundAt	client	client/cl_sound.lua:467	It walked. Cheap, and a no-op for anything not currently playing.
Notify	client	client/cl_notify.lua:31
Open	client	client/cl_nui.lua:100
OpenFieldMap	client	client/cl_fieldmap.lua:302
PlaySound2D	client	client/cl_sound.lua:485	Non-positional: menus, notifications, hitmarkers, the level-up sting.
PlaySoundAt	client	client/cl_sound.lua:462
ResetMinimapRect	client	client/cl_hud.lua:323
RestoreFilter	client	client/cl_filter.lua:180	Restore the saved gameplay look after a menu camera releases its own grade.
Send	client	client/cl_nui.lua:102
SetBigmap	client	client/cl_hud.lua:221
SetMinimap	client	client/cl_hud.lua:324
SetMinimapRect	client	client/cl_hud.lua:322
SetPartyHudPref	client	client/cl_partyhud.lua:62
SetUiScale	client	client/cl_uiscale.lua:37
SkillLevelSequence	client	client/cl_levelup.lua:80
StopSoundTag	client	client/cl_sound.lua:474	Stop, with a ramp. fadeMs is optional; nil is the short default.
SuspendFilter	client	client/cl_filter.lua:211	SUSPEND, FOR ANYTHING THAT OWNS THE SCREEN FOR A MOMENT.
Notify	server	server/sv_main.lua:17
NotifyAll	server	server/sv_main.lua:18

Callbacks

Server callbacks are called from a client with BSB.Await(name, timeoutMs, ...). Client callbacks are called from the server with BSB.AwaitClient(src, name, timeoutMs, ...).

None.

Events

“net” means the handler is registered with RegisterNetEvent, so the other side can trigger it. “local” is AddEventHandler only (same side, or game events).

Name	Side	Type	Where	Description
bs:factions:sync	client	net	client/cl_partyhud.lua:76
bs:hook:player:levelUp	client	local	client/cl_hud.lua:606
bs:hook:player:loaded	client	local	client/cl_hud.lua:557
bs:hook:player:money	client	local	client/cl_notify.lua:42
bs:hook:player:spawned	client	local	client/cl_notify.lua:65
bs:hook:player:unloaded	client	local	client/cl_fieldmap.lua:285
bs:hook:player:xp	client	local	client/cl_hud.lua:572	The XP popup: this is the moment the player sees the reward land.
bs:squad:sync	client	net	client/cl_partyhud.lua:75
bs:ui:closed	client	local	client/cl_hud.lua:363	BUG THAT WAS HERE - “THE FIELD MAP STILL IS NOT WORKING”, FOR MONTHS.
bs:ui:levelCard	client	local	client/cl_hud.lua:580	The card is drawn here, but the SEQUENCE (card + boom + music) is owned by cl_levelup.lua, which fires this through bs:ui:levelCard.
bs:ui:opened	client	local	client/cl_fieldmap.lua:281	Panels
bs:ui:panic	client	local	client/cl_hud.lua:436
bs:ui:settingsChanged	client	local	client/cl_sound.lua:109	Player preferences arrive after the HUD state is restored.
onClientResourceStop	client	local	client/cl_blurguard.lua:108	AND THE ONE CASE THE WATCHDOG ABOVE CANNOT CATCH: a resource that faded the blur in and then STOPPED.
onResourceStop	client	local	client/cl_fieldmap.lua:287	A restart with a grade applied leaves the grade applied: the timecycle is engine state, not resource state, and nothing clears it when the script that set it goes away.

Commands

Command	Side	Where	Description
/hud	client	client/cl_hud.lua:625
/leveltest	client	client/cl_levelup.lua:85	A test that does not require earning anything.
/refreshui	client	client/cl_nui.lua:89	/refreshui - THE PANIC BUTTON, FOR EVERY PLAYER.
/soundstat	client	client/cl_sound.lua:549	/soundstat - what the mixer thinks is happening right now.
/soundtest	client	client/cl_sound.lua:508	/soundtest <file> [distance] - proves a file is present and audible without needing anything else in the project to be working first.
/uiscale	client	client/cl_uiscale.lua:39
/unblur	client	client/cl_blurguard.lua:135	/unblur - the manual escape hatch.