JM-SimpleHUD exposes two client commands and a small export API for integration with other resources.
Commands#
| Command | Description |
|---|---|
/simplehud | Toggles the HUD on or off for the local player. |
/changeHUD <mode> | Changes the HUD display mode. Valid values are default, minimal, and hidden. |
/simplehud/changeHUD minimal/changeHUD default/changeHUD hiddenBoth commands are available to all players — there are no permission requirements.
Exports#
Other client-side scripts can push content into the HUD using the following exports. All exports are client-side only.
Area of Patrol#
Sets or clears the Area of Patrol line that appears at the bottom of the HUD.
-- Set the AOP lineexports['JM-SimpleHUD']:SetAOP("Sandy Shores")-- Remove the AOP lineexports['JM-SimpleHUD']:ClearAOP()Passing nil or calling ClearAOP hides the line entirely.
Extra Lines#
Any number of additional lines can be injected below the main HUD content. Each line is identified by a unique string key so different resources can manage their own lines independently.
-- Add or update a lineexports['JM-SimpleHUD']:SetExtraLine("myResource", "On Duty: Fire Department")-- Remove a specific lineexports['JM-SimpleHUD']:ClearExtraLine("myResource")Use a key that is unique to your resource (e.g. the resource name) to avoid conflicts with other scripts that also inject extra lines.